[Dev] Updates the flow definition, and adds it to CI

Author: orta

.flowconfig

@@ -1,13 +1,15 @@
 [ignore]
-distribution
-.*/_tests/.*
-.*dangerfile.js
-node_modules/jest*/**/**
+.*/source/.*
+.*/node_modules/.*
 
 [include]
+dangerfile.flow.js
 
 [libs]
-flow-typed/
+distribution/danger.js.flow
+
+[lints]
 
 [options]
-unsafe.enable_getters_and_setters=true
+
+[strict]

.gitignore

@@ -47,3 +47,7 @@ docs/js_ref_dsl_docs.json
 types/index.d.ts
 .jest/
 test-results.json
+
+# Flowgen stuff
+source/_danger.d.tse
+source/_danger.d.ts

.travis.yml

@@ -14,9 +14,13 @@ matrix:
     after_script:
     - rm -rf node_modules/@types/babel-*
     - rm -rf node_modules/@types/babylon
+    - echo "Testing that the Danger d.ts file lints"
     - yarn docs
     - yarn add [email protected]
     - yarn dts-lint
+    - echo "Testing Flow definition file"
+    - yarn build:flow-types
+    - yarn flow check
 
   # Checks every example dangerfile can run in `danger runner`.
   - node_js: '8.4'

CHANGELOG.md

@@ -13,6 +13,8 @@
 
 ## Master
 
+* Improvements to the Flow definition file. [@orta][]
+
 ## 3.1.7
 
 * Minor error reporting improvements. [@orta][]

dangerfile.flow.js

@@ -0,0 +1,8 @@
+// This file isn't used anywhere, but it is used as a part of `yarn flow check`
+// to validate that flow typings work correctly for JS Dangerfiles
+
+// @flow
+
+import { danger } from "danger"
+
+danger.github.pr

package.json

@@ -46,7 +46,7 @@
     "build": "shx rm -rf ./distribution && tsc -p tsconfig.production.json && madge ./distribution --circular",
     "build:fast": "tsc -p tsconfig.production.json",
     "build:flow-types":
-      "cp source/danger.d.ts source/_danger.d.ts; sed -ie 's/api: GitHub/api: any/g' source/_danger.d.ts; npx flowgen source/_danger.d.ts -o distribution/danger.js.flow; node scripts/update_flow_types.js",
+      "cp source/danger.d.ts source/_danger.d.ts && sed -ie 's/api: GitHub/api: any/g' source/_danger.d.ts && npx -p github:orta/flowgen#union_Strings flowgen source/_danger.d.ts -o distribution/danger.js.flow && node scripts/update_flow_types.js",
     "build:watch": "tsc -w",
     "link": "yarn run build && chmod +x distribution/commands/danger.js && npm link",
     "declarations": "ts-node ./scripts/create-danger-dts.ts",
@@ -89,6 +89,7 @@
     "danger-plugin-jest": "^1.0.1",
     "danger-plugin-yarn": "^1.2.1",
     "date-fns": "^1.29.0",
+    "flow-bin": "^0.66.0",
     "husky": "^0.14.0",
     "jest": "22.1.4",
     "jest-json-reporter": "^1.2.2",

scripts/update_flow_types.js

@@ -27,4 +27,11 @@ exportedLines.forEach(line => {
   const newLine = "declare export " + line
   flowDef = flowDef.replace(find, newLine)
 })
-fs.writeFileSync("distribution/danger.js.flow", flowDef)
+
+const prefix = `
+// This is generated in danger/danger-js/scripts/update_flow_types.js
+
+import type { GitHub } from "@octokit/rest"
+`
+
+fs.writeFileSync("distribution/danger.js.flow", prefix + flowDef)

source/danger.d.ts

@@ -34,6 +34,8 @@ declare module "danger" {
     /** ISO6801 date string */
     date: string
   }
+
+  // Please don't have includes in here that aren't inside the DSL folder, or the d.ts/flow defs break
   /**
    * The shape of the JSON passed between Danger and a subprocess. It's built
    * to be expanded in the future.
@@ -700,6 +702,19 @@ declare module "danger" {
      */
     message: string
   }
+
+  /**
+   * Describes the possible arguments that
+   * could be used when calling the CLI
+   */
+  interface CliArgs {
+    base: string
+    verbose: string
+    externalCiProvider: string
+    textOnly: string
+    dangerfile: string
+    id: string
+  }
   /** A function with a callback function, which Danger wraps in a Promise */
   type CallbackableFn = (callback: (done: any) => void) => void
 

source/dsl/DangerDSL.ts

@@ -1,7 +1,9 @@
+// Please don't have includes in here that aren't inside the DSL folder, or the d.ts/flow defs break
+
 import { GitDSL, GitJSONDSL } from "../dsl/GitDSL"
 import { GitHubDSL } from "../dsl/GitHubDSL"
 import { DangerUtilsDSL } from "./DangerUtilsDSL"
-import { CliArgs } from "../runner/cli-args"
+import { CliArgs } from "../dsl/cli-args"
 
 /**
  * The shape of the JSON passed between Danger and a subprocess. It's built