Merge pull request #356 from danger/schedule_types

Update the scheduled types

changelog.md

@@ -7,6 +7,7 @@
 ### 2.0.0-alpha.13
 
 - Move back to the original URLs for diffs, instead of relying on PR metadata - orta
+- Updates the types for `schedule` to be more accepting of what it actually takes - orta
 
 ### 2.0.0-alpha.12
 

scripts/create-danger-dts.ts

@@ -11,6 +11,6 @@ const output = dts()
 // This is so you can get it for this repo 👍
 fs.writeFileSync("source/danger.d.ts", output)
 fs.writeFileSync("distribution/danger.d.ts", output)
-fs.writeFileSync("types/index.d.ts", output)
+fs.writeFileSync("types/index.d.ts", "// TypeScript Version: 2.2\n" + output)
 
 console.log("Awesome - shipped to source/danger.d.ts, distribution/danger.d.ts and types/index.d.ts")

scripts/danger-dts.ts

@@ -48,6 +48,9 @@ declare module "danger" {
       }
       return newLine
     }
+    if (line.includes("export type")) {
+      return line
+    }
     if (line.includes("(")) {
       return "function " + line.trim()
     }

source/danger.d.ts

@@ -598,6 +598,15 @@ declare module "danger" {
      */
     message: string
   }
+  /** A function with a callback function, which Danger wraps in a Promise */
+  type CallbackableFn = (callback: (done: any) => void) => void
+
+  /**
+   * Types of things which Danger will schedule for you, it's recommended that you
+   * just throw in an `async () => { [...] }` function. Can also handle a function
+   * that has a single 'done' arg.
+   */
+  type Scheduleable = Promise<any> | Promise<void> | CallbackableFn
   /**
    * A Dangerfile is evaluated as a script, and so async code does not work
    * out of the box. By using the `schedule` function you can now register a
@@ -607,7 +616,7 @@ declare module "danger" {
    *
    * @param {Function} asyncFunction the function to run asynchronously
    */
-  function schedule(asyncFunction: (p: Promise<any>) => void): void
+  function schedule(asyncFunction: Scheduleable): void
 
   /**
    * Fails a build, outputting a specific reason for failing.

source/runner/Dangerfile.ts

@@ -4,6 +4,16 @@ import { MarkdownString } from "../dsl/Aliases"
 
 /// Start of Danger DSL definition
 
+/** A function with a callback function, which Danger wraps in a Promise */
+export type CallbackableFn = (callback: (done: any) => void) => void
+
+/**
+ * Types of things which Danger will schedule for you, it's recommended that you
+ * just throw in an `async () => { [...] }` function. Can also handle a function
+ * that has a single 'done' arg.
+ */
+export type Scheduleable = Promise<any> | Promise<void> | CallbackableFn
+
 export interface DangerContext {
   /**
    * A Dangerfile is evaluated as a script, and so async code does not work
@@ -14,7 +24,7 @@ export interface DangerContext {
    *
    * @param {Function} asyncFunction the function to run asynchronously
    */
-  schedule(asyncFunction: (p: Promise<any>) => void): void
+  schedule(asyncFunction: Scheduleable): void
 
   /**
    * Fails a build, outputting a specific reason for failing.
@@ -74,7 +84,7 @@ export function contextForDanger(dsl: DangerDSLType): DangerContext {
     scheduled: [],
   }
 
-  const schedule = (fn: Function) => results.scheduled.push(fn)
+  const schedule = (fn: any) => results.scheduled.push(fn)
   const fail = (message: MarkdownString) => results.fails.push({ message })
   const warn = (message: MarkdownString) => results.warnings.push({ message })
   const message = (message: MarkdownString) => results.messages.push({ message })