Merge branch 'adam-moss-local-run' into platform_content

CHANGELOG.md

@@ -10,14 +10,33 @@
 
 ## Master
 
-* Adds a new command `danger local`
+* Adds a new command `danger local`.
 
   This command will look between the current branch and master
   and use that to evaluate a dangerfile. This is aimed specifically at
   tools like git commit hooks, and for people who don't do code review.
 
   `danger.github` will be falsy in this context, so you could share a dangerfile
-  between your CI + code Review. - [@orta][]
+  between `danger local` and `danger ci`.
+
+  When I thought about how to use it on Danger JS, I opted to make another Dangerfile and import it at the end of
+  the main Dangerfile. This new Dangerfile only contains rules which can run with just `danger.git`, e.g. CHANGELOG/README
+  checks. I called it `dangerfile.lite.ts`.
+
+  Our setup looks like:
+
+  ```json
+  "scripts": {
+    "prepush": "yarn build; yarn danger:prepush",
+    "danger:prepush": "yarn danger local --dangerfile dangerfile.lite.ts"
+    // [...]
+  ```
+
+You'll need to have [husky](https://www.npmjs.com/package/husky) installed for this to work. - [@orta][]
+
+* STDOUT formatting has been improved, which is the terminal only version of
+  Danger's typical GitHub comment style system. It's used in `danger pr`, `danger ci --stdout`
+  and `danger local`. - [@orta][]
 
 ### 3.0.5
 

dangerfile.lite.ts

@@ -5,8 +5,12 @@ declare var danger: DangerDSLType
 declare function warn(params: string): void
 
 const hasChangelog = danger.git.modified_files.includes("CHANGELOG.md")
-if (!hasChangelog) {
-  warn("Please add a changelog entry for your changes.")
+const isTrivial = danger.github && (danger.github.pr.body + danger.github.pr.title).includes("#trivial")
+
+if (!hasChangelog && !isTrivial) {
+  warn(
+    "Please add a changelog entry for your changes. You can find it in `CHANGELOG.md` \n\n Please add your change and name to the master section."
+  )
 }
 
 import dtsGenerator from "./scripts/danger-dts"

dangerfile.ts

@@ -13,18 +13,14 @@ declare function fail(params: string): void
 // declare function schedule(promise: () => Promise<any | void>): void
 // declare function schedule(callback: (resolve: any) => void): void
 
-import * as fs from "fs"
-
 const checkREADME = async () => {
   // Request a CHANGELOG entry if not declared #trivial
   const hasChangelog = danger.git.modified_files.includes("CHANGELOG.md")
   const isTrivial = (danger.github.pr.body + danger.github.pr.title).includes("#trivial")
   const isGreenkeeper = danger.github.pr.user.login === "greenkeeper"
 
+  // Politely ask for their name on the entry too
   if (!hasChangelog && !isTrivial && !isGreenkeeper) {
-    warn("Please add a changelog entry for your changes, by adding a note in the master section to `CHANGELOG.md`.")
-
-    // Politely ask for their name on the entry too
     const changelogDiff = await danger.git.diffForFile("CHANGELOG.md")
     const contributorName = danger.github.pr.user.login
     if (changelogDiff && changelogDiff.diff.includes(contributorName)) {
@@ -40,37 +36,5 @@ yarn()
 import jest from "danger-plugin-jest"
 jest()
 
-// Some good old-fashioned maintainance upkeep
-
-// Ensure the danger.d.ts is always up to date inside this repo.
-// This also serves as the "one true DSL" for a Danger run against a PR
-// which tools can then work against.
-
-// debugger
-
-import dtsGenerator from "./scripts/danger-dts"
-const currentDTS = dtsGenerator()
-const savedDTS = fs.readFileSync("source/danger.d.ts").toString()
-if (currentDTS !== savedDTS) {
-  const message = "There are changes to the Danger DSL which are not reflected in the current danger.d.ts."
-  const idea = "Please run <code>yarn declarations</code> and update this PR."
-  fail(`${message}<br/><i>${idea}</i>`)
-}
-
-// Always ensure we name all CI providers in the README. These
-// regularly get forgotten on a PR adding a new one.
-const sentence = danger.utils.sentence
-
-import { realProviders } from "./source/ci_source/providers"
-const readme = fs.readFileSync("README.md").toString()
-const names = realProviders.map(p => new p({}).name)
-const missing = names.filter(n => !readme.includes(n))
-if (missing.length) {
-  warn(`These providers are missing from the README: ${sentence(missing)}`)
-}
-
-danger.github.utils.fileContents("scripts/run-fixtures.js").then(fixtures => {
-  if (fixtures.includes("const writeResults = true")) {
-    fail("Fixtures test script is still in write mode, edit `scripts/run-fixtures.js`.")
-  }
-})
+// Re-run the git push hooks
+import "./dangerfile.lite"

package.json

@@ -54,7 +54,7 @@
     "docs":
       "yarn run docs:cp_defs; yarn typedoc --ignoreCompilerErrors --mode modules --json docs/js_ref_dsl_docs.json --includeDeclarations source",
     "dts-lint": "yarn run declarations && yarn dtslint types",
-    "danger:prepush": "node  distribution/commands/danger.js local --dangerfile dangerfile.lite.ts"
+    "danger:prepush": "node distribution/commands/danger.js local --dangerfile dangerfile.lite.ts"
   },
   "repository": {
     "type": "git",

source/runner/Executor.ts

@@ -125,11 +125,11 @@ export class Executor {
       // Human-readable format
 
       const table = [
-        { name: "Failures", messages: fails.map(f => f.message) },
-        { name: "Warnings", messages: warnings.map(w => w.message) },
-        { name: "Messages", messages: messages.map(m => m.message) },
-        { name: "Markdowns", messages: markdowns },
-      ]
+        fails.length && { name: "Failures", messages: fails.map(f => f.message) },
+        warnings.length && { name: "Warnings", messages: warnings.map(w => w.message) },
+        messages.length && { name: "Messages", messages: messages.map(m => m.message) },
+        markdowns.length && { name: "Markdowns", messages: markdowns },
+      ].filter(r => r !== 0) as { name: string; messages: string[] }[]
 
       // Consider looking at getting the terminal width, and making it 60%
       // if over a particular size
@@ -142,14 +142,16 @@ export class Executor {
       if (fails.length > 0) {
         const s = fails.length === 1 ? "" : "s"
         const are = fails.length === 1 ? "is" : "are"
-        const message = chalk.underline("Failing the build")
-        console.log(`${message}, there ${are} ${fails.length} fail${s}.`)
+        const message = chalk.underline.red("Failing the build")
+        console.log(`Danger: ${message}, there ${are} ${fails.length} fail${s}.`)
         process.exitCode = 1
       } else if (warnings.length > 0) {
         const message = chalk.underline("not failing the build")
-        console.log(`Found only warnings, ${message}`)
+        console.log(`Danger: Found only warnings, ${message}`)
       } else if (messages.length > 0) {
-        console.log("Found only messages, passing those to review.")
+        console.log("Danger: Passed, found only messages.")
+      } else if (!messages.length && !fails.length && !messages.length && !warnings.length) {
+        console.log("Danger: Passed review, received no feedback.")
       }
     }
   }