Convert our Dangerfile to be a TypeScript file

Author: orta

.travis.yml

@@ -3,19 +3,22 @@ cache:
   yarn: true
   directories:
   - node_modules
+
 matrix:
   include:
   - node_js: node
     before_script:
-    - npm run build
-    - npm run link
+    - yarn tsc
+    - ls
+    - chmod +x distribution/commands/danger.js
+    - npm link
     - danger
   - node_js: '6'
   - node_js: '7'
 
 script:
-- npm run lint
-- npm test -- --coverage --no-cache && rm ./coverage/coverage-final.json
+- yarn lint
+- yarn test -- --coverage --no-cache && rm ./coverage/coverage-final.json
 
 after_success:
 - bash <(curl -s https://codecov.io/bash)

dangerfile.circle.js

@@ -1 +1 @@
-message("this worked")
+// This is currently empty. Maybe it can do something in the future, but for now it's 👍 to be empty.

dangerfile.js renamed to dangerfile.ts

@@ -1,4 +1,9 @@
-import fs from "fs"
+import {DangerDSL} from "./source/dsl/DangerDSL"
+declare var danger: DangerDSL
+declare function warn(params: string): void
+declare function fail(params: string): void
+
+import * as fs from "fs"
 import includes from "lodash.includes"
 
 // Request a CHANGELOG entry if not declared #trivial
@@ -29,6 +34,6 @@ 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>node ./scripts/create-danger-dts.js</code> and update this PR."
+  const idea = "Please run <code>yarn declarations</code> and update this PR."
   fail(`${message} - <i>${idea}</i>`)
 }

package.json

@@ -52,10 +52,11 @@
     "test:watch": "jest --watch",
     "lint": "tslint \"source/**/*.ts\"",
     "lint:fix": "tslint \"source/**/*.ts\" --fix",
-    "prepublish": "in-publish && npm run build && node ./scripts/create-danger-dts.js || not-in-publish",
+    "prepublish": "in-publish && npm run build && yarn declarations || not-in-publish",
     "build": "shx rm -rf ./distribution && tsc && madge ./distribution --circular",
     "build:watch": "tsc -w",
-    "link": "npm run build ; chmod +x distribution/commands/danger.js ; npm link"
+    "link": "npm run build && chmod +x distribution/commands/danger.js && npm link",
+    "declarations": "ts-node ./scripts/create-danger-dts.ts"
   },
   "repository": {
     "type": "git",
@@ -89,7 +90,7 @@
     "madge": "^1.4.4",
     "shx": "^0.2.1",
     "ts-jest": "^19.0.0",
-    "ts-node": "^2.0.0",
+    "ts-node": "^2.1.0",
     "tslint": "^4.4.0",
     "typescript": "2.2.1"
   },
@@ -98,9 +99,9 @@
     "chalk": "^1.1.1",
     "commander": "^2.9.0",
     "debug": "^2.6.0",
+    "jest-config": "^18.0.0",
     "jest-environment-node": "^18.1.0",
     "jest-runtime": "^18.0.0",
-    "jest-config": "^18.0.0",
     "jsome": "^2.3.25",
     "lodash.find": "^4.6.0",
     "lodash.includes": "^4.3.0",

scripts/create-danger-dts.js renamed to scripts/create-danger-dts.ts

@@ -1,5 +1,10 @@
-const dts = require("./danger-dts")
-const fs = require("fs")
+import dts from "./danger-dts"
+import * as fs from "fs"
+
+// This could need to exist
+if (!fs.existsSync("distribution")) {
+  fs.mkdirSync("distribution")
+}
 
 const output = dts()
 

scripts/danger-dts.js renamed to scripts/danger-dts.ts

@@ -1,7 +1,7 @@
-var fs = require("fs")
+import * as fs from "fs"
 
 const createDTS = () => {
-  var fileOutput = ""
+  let fileOutput = ""
 
   const extras = ["source/platforms/messaging/violation.ts"]
   const dslFiles = fs.readdirSync("source/dsl").map(f => `source/dsl/${f}`)
@@ -24,10 +24,11 @@ const createDTS = () => {
   const moduleContext = allDangerfile.split("/// Start of Danger DSL definition")[1].split("/// End of Danger DSL definition")[0]
 
   // we need to add either `declare function` or `declare var` to the interface
-  const context = moduleContext.split("\n").map((line) => {
+  const context = moduleContext.split("\n").map((line: string) => {
     if ((line.length === 0) || (line.includes("*"))) { return line }
     if (line.includes("(")) { return "  function " + line.trim() }
     if (line.includes(":")) { return "  var " + line.trim() }
+    return ""
   }).join("\n")
 
   fileOutput += context
@@ -41,5 +42,5 @@ const createDTS = () => {
   // Remove any 2 line breaks
   return fileOutput.replace(/\n\s*\n/g, "\n")
 }
- 
-module.exports = createDTS
+
+export default createDTS

tsconfig.json

@@ -16,7 +16,7 @@
     "pretty": true,
     "target": "es5",
     "outDir": "distribution",
-    "lib": ["es5", "es2015.promise"]
+    "lib": ["es5", "es2015.promise", "es2016.array.include", "es2015.core"]
   },
   "formatCodeOptions": {
     "indentSize": 2,

yarn.lock

@@ -1105,14 +1105,14 @@ [email protected]:
   dependencies:
     boom "2.x.x"
 
-[email protected], "cssom@>= 0.3.2 < 0.4.0":
-  version "0.3.2"
-  resolved "https://registry.yarnpkg.com/cssom/-/cssom-0.3.2.tgz#b8036170c79f07a90ff2f16e22284027a243848b"
-
-"cssom@>= 0.3.0 < 0.4.0":
+[email protected], "cssom@>= 0.3.0 < 0.4.0":
   version "0.3.1"
   resolved "https://registry.yarnpkg.com/cssom/-/cssom-0.3.1.tgz#c9e37ef2490e64f6d1baa10fda852257082c25d3"
 
+"cssom@>= 0.3.2 < 0.4.0":
+  version "0.3.2"
+  resolved "https://registry.yarnpkg.com/cssom/-/cssom-0.3.2.tgz#b8036170c79f07a90ff2f16e22284027a243848b"
+
 "cssstyle@>= 0.2.36 < 0.3.0", "cssstyle@>= 0.2.37 < 0.3.0":
   version "0.2.37"
   resolved "https://registry.yarnpkg.com/cssstyle/-/cssstyle-0.2.37.tgz#541097234cb2513c83ceed3acddc27ff27987d54"
@@ -3968,9 +3968,9 @@ ts-jest@^19.0.0:
     source-map-support "^0.4.4"
     yargs "^6.1.1"
 
-ts-node@^2.0.0:
-  version "2.0.0"
-  resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-2.0.0.tgz#16e4fecc949088238b4cbf1c39c9582526b66f74"
+ts-node@^2.1.0:
+  version "2.1.0"
+  resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-2.1.0.tgz#aa2bf4b2e25c5fb6a7c54701edc3666d3a9db25d"
   dependencies:
     arrify "^1.0.0"
     chalk "^1.1.1"