[WIP] Support inline comments

source/dsl/Aliases.ts

@@ -1 +1,3 @@
 export type MarkdownString = string
+export type Filename = string
+export type LineNumber = string

source/dsl/DangerResults.ts

@@ -1,5 +1,4 @@
 import { Violation } from "../platforms/messaging/violation"
-import { MarkdownString } from "../dsl/Aliases"
 
 /**
  * Representation of what running a Dangerfile generates.
@@ -27,7 +26,7 @@ export interface DangerResults {
 
   /**
    * Markdown messages at the bottom of the comment
-   * @type {MarkdownString[]}
+   * @type {Violation[]}
    */
-  markdowns: Array<MarkdownString>
+  markdowns: Array<Violation>
 }

source/platforms/messaging/violation.ts

@@ -1,3 +1,5 @@
+import { MessagingOptions } from "../../runner/Dangerfile"
+
 /**
  * The result of user doing warn, message or fail.
  */
@@ -8,4 +10,6 @@ export interface Violation {
    * @type {string}
    */
   message: string
+
+  options?: MessagingOptions
 }

source/runner/Dangerfile.ts

@@ -1,35 +1,35 @@
 import { DangerResults } from "../dsl/DangerResults"
 import { DangerDSLType } from "../dsl/DangerDSL"
-import { MarkdownString } from "../dsl/Aliases"
+import { MarkdownString, Filename, LineNumber } from "../dsl/Aliases"
 
 export interface DangerContext {
   /**
    * Fails a build, outputting a specific reason for failing
    *
    * @param {MarkdownString} message the String to output
    */
-  fail(message: MarkdownString): void
+  fail(message: MarkdownString, options?: MessagingOptions): void
 
   /**
    * Highlights low-priority issues, does not fail the build
    *
    * @param {MarkdownString} message the String to output
    */
-  warn(message: MarkdownString): void
+  warn(message: MarkdownString, options?: MessagingOptions): void
 
   /**
    * Puts a message inside the Danger table
    *
    * @param {MarkdownString} message the String to output
    */
-  message(message: MarkdownString): void
+  message(message: MarkdownString, options?: MessagingOptions): void
 
   /**
    * Puts a message inside the Danger table
    *
    * @param {MarkdownString} message the String to output
    */
-  markdown(message: MarkdownString): void
+  markdown(message: MarkdownString, options?: MessagingOptions): void
 
   /** Typical console */
   console: Console
@@ -48,6 +48,11 @@ export interface DangerContext {
   results: DangerResults
 }
 
+export interface MessagingOptions {
+  file?: Filename
+  line?: LineNumber
+}
+
 /** Creates a Danger context, this provides all of the global functions
  *  which are available to the Danger eval runtime.
  *
@@ -62,10 +67,10 @@ export function contextForDanger(dsl: DangerDSLType): DangerContext {
     markdowns: []
   }
 
-  const fail = (message: MarkdownString) =>  results.fails.push({ message })
-  const warn = (message: MarkdownString) => results.warnings.push({ message })
-  const message = (message: MarkdownString) => results.messages.push({ message })
-  const markdown = (message: MarkdownString) => results.markdowns.push(message)
+  const fail = (message: MarkdownString, options: MessagingOptions = {}) => results.fails.push({ message, options })
+  const warn = (message: MarkdownString, options: MessagingOptions = {}) => results.warnings.push({ message, options })
+  const message = (message: MarkdownString, options: MessagingOptions = {}) => results.messages.push({ message, options })
+  const markdown = (message: MarkdownString, options: MessagingOptions = {}) => results.markdowns.push({ message, options })
 
   return {
     fail,

source/runner/Executor.ts

@@ -66,7 +66,6 @@ export class Executor {
       process.exitCode = 1
     }
 
-    // Delete the message if there's nothing to say
     const {fails, warnings, messages, markdowns} = results
 
     const failureCount = [...fails, ...warnings].length
@@ -75,6 +74,7 @@ export class Executor {
     this.d(results)
 
     if (failureCount + messageCount === 0) {
+      // Delete the message if there's nothing to say
       console.log("No messages are collected.")
       await this.platform.deleteMainComment()
     } else {
@@ -84,6 +84,7 @@ export class Executor {
         console.log("Found some message, writing it down")
       }
       const comment = githubResultsTemplate(results)
+      // TODO filter out Danger items that contain file/line info
       await this.platform.updateOrCreateComment(comment)
     }
   }

source/runner/_tests/DangerRunner.test.ts

@@ -50,10 +50,10 @@ describe("with fixtures", () => {
     const results = await runDangerfileEnvironment(resolve(fixtures, "__DangerfileFullMessages.js"), runtime)
 
     expect(results).toEqual({
-      fails: [{"message": "this is a failure"}],
-      markdowns: ["this is a *markdown*"],
-      messages: [{"message": "this is a message"}],
-      warnings: [{"message": "this is a warning"}]
+      fails: [{"message": "this is a failure", "options": {}}],
+      markdowns: [{"message": "this is a *markdown*", "options": {}}],
+      messages: [{"message": "this is a message", "options": {}}],
+      warnings: [{"message": "this is a warning", "options": {}}]
     })
   })
 

source/runner/_tests/fixtures/ExampleDangerResults.ts

@@ -21,9 +21,16 @@ export const failsResults: DangerResults = {
   markdowns: []
 }
 
+export const markdownResults: DangerResults = {
+  fails: [],
+  warnings: [],
+  messages: [],
+  markdowns: [{ message: "Markdown message" }]
+}
+
 export const summaryResults: DangerResults = {
   fails: [{ message: "Failing message Failing message" }],
   warnings: [{ message: "Warning message Warning message" }],
   messages: [{ message: "message" }],
-  markdowns: ["markdown"],
-}
+  markdowns: [{ message: "markdown" }],
+}

source/runner/templates/_tests/github-issue-templates.test.ts

@@ -1,4 +1,4 @@
-import { emptyResults, warnResults, failsResults, summaryResults } from "../../_tests/fixtures/ExampleDangerResults"
+import { emptyResults, warnResults, failsResults, summaryResults, markdownResults } from "../../_tests/fixtures/ExampleDangerResults"
 import { template as githubResultsTemplate } from "../../templates/github-issue-template"
 
 describe("generating messages", () => {
@@ -21,6 +21,11 @@ describe("generating messages", () => {
     expect(issues).not.toContain("Fails")
   })
 
+  it("shows the markdown messages separately from results table", () => {
+    const issues = githubResultsTemplate(markdownResults)
+    expect(issues).toContain("Markdown message")
+  })
+
   it("does not break commonmark rules around line breaks", () => {
     const issues = githubResultsTemplate(warnResults)
     expect(issues).not.toMatch(/(\r?\n){2}[ \t]+</)

source/runner/templates/github-issue-template.ts

@@ -57,7 +57,7 @@ ${buildSummaryMessage(results)}
 ${table("Fails", "no_entry_sign", results.fails)}
 ${table("Warnings", "warning", results.warnings)}
 ${table("Messages", "book", results.messages)}
-${results.markdowns.join("\n\n")}
+${results.markdowns.map(markdown => markdown.message).join("\n\n")}
 <p align="right">
   Generated by :no_entry_sign: <a href="http://github.com/danger/danger-js/">dangerJS</a>
 </p>