Add createInlineComment to API & platform

danger · Feb 25, 2018 · 38ba779 · 38ba779
1 parent 127fa2d
commit 38ba779
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 0 deletions.
diff --git a/source/platforms/FakePlatform.ts b/source/platforms/FakePlatform.ts
@@ -39,6 +39,10 @@ export class FakePlatform implements Platform {
     return true
   }
 
+  async createInlineComment(_comment: string, _commitId: string, _path: string, _position: number): Promise<any> {
+    return true
+  }
+
   async deleteMainComment(): Promise<boolean> {
     return true
   }

diff --git a/source/platforms/GitHub.ts b/source/platforms/GitHub.ts
@@ -108,6 +108,18 @@ export class GitHub {
    */
   createComment = (comment: string) => this.api.postPRComment(comment)
 
+  /**
+   * Returns the response for the new inline comment
+   *
+   * @param {string} comment you want to post
+   * @param {string} commitId to make a comment in
+   * @param {string} path to the file
+   * @param {number} position in the file
+   * @returns {Promise<any>} JSON response of new comment
+   */
+  createInlineComment = (comment: string, commitId: string, path: string, position: number) =>
+    this.api.postInlinePRComment(comment, commitId, path, position)
+
   // In Danger RB we support a danger_id property,
   // this should be handled at some point
 

diff --git a/source/platforms/LocalGit.ts b/source/platforms/LocalGit.ts
@@ -71,6 +71,10 @@ export class LocalGit implements Platform {
     return true
   }
 
+  async createInlineComment(_comment: string, _commitId: string, _path: string, _position: number): Promise<any> {
+    return true
+  }
+
   async deleteMainComment(): Promise<boolean> {
     return true
   }

diff --git a/source/platforms/github/GitHubAPI.ts b/source/platforms/github/GitHubAPI.ts
@@ -131,6 +131,23 @@ export class GitHubAPI {
     return res.json()
   }
 
+  postInlinePRComment = async (comment: string, commitId: string, path: string, position: number) => {
+    const repo = this.repoMetadata.repoSlug
+    const prID = this.repoMetadata.pullRequestID
+    const res = await this.post(
+      `repos/${repo}/issues/${prID}/comments`,
+      {},
+      {
+        body: comment,
+        commit_id: commitId,
+        path: path,
+        position: position,
+      }
+    )
+
+    return res.json()
+  }
+
   getPullRequestInfo = async (): Promise<GitHubPRDSL> => {
     if (this.pr) {
       return this.pr

diff --git a/source/platforms/platform.ts b/source/platforms/platform.ts
@@ -39,6 +39,8 @@ export interface Platform {
   supportsCommenting: () => boolean
   /** Creates a comment on the PR */
   createComment: (dangerID: string, body: string) => Promise<any>
+  /** Creates an inline comment on the PR */
+  createInlineComment: (comment: string, commitId: string, path: string, position: number) => Promise<any>
   /** Delete the main Danger comment */
   deleteMainComment: (dangerID: string) => Promise<boolean>
   /** Replace the main Danger comment */