Refactor chunks into StructuredDiff

source/danger.d.ts

@@ -700,10 +700,6 @@ declare module "danger" {
   }
   /** All Text diff values will be this shape */
   interface TextDiff {
-    /** Git diff chunks */
-    // Not sure if this is the right place for this one, but few methods needs both chunks & text diffs and I didn't want to parse two times the same file
-    // We could rename the interface, but couldn't find a good one
-    chunks: any[]
     /** The value before the PR's applied changes */
     before: string
     /** The value after the PR's applied changes */
@@ -716,6 +712,12 @@ declare module "danger" {
     removed: string
   }
 
+  /** Git diff sliced into chunks */
+  interface StructuredDiff {
+    /** Git diff chunks */
+    chunks: any[]
+  }
+
   /** The results of running a JSON patch */
   interface JSONPatch {
     /** The JSON in a file at the PR merge base */
@@ -791,6 +793,13 @@ declare module "danger" {
      */
     diffForFile(filename: string): Promise<TextDiff | null>
 
+    /**
+     * Offers the structured diff for a specific file
+     *
+     * @param {string} filename the path to the json file
+     */
+    structuredDiffForFile(filename: string): Promise<StructuredDiff | null>
+
     /**
      * Provides a JSON patch (rfc6902) between the two versions of a JSON file,
      * returns null if you don't have any changes for the file in the diff.

source/dsl/GitDSL.ts

@@ -2,10 +2,6 @@ import { GitCommit } from "./Commit"
 
 /** All Text diff values will be this shape */
 export interface TextDiff {
-  /** Git diff chunks */
-  // Not sure if this is the right place for this one, but few methods needs both chunks & text diffs and I didn't want to parse two times the same file
-  // We could rename the interface, but couldn't find a good one
-  chunks: any[]
   /** The value before the PR's applied changes */
   before: string
   /** The value after the PR's applied changes */
@@ -18,6 +14,12 @@ export interface TextDiff {
   removed: string
 }
 
+/** Git diff sliced into chunks */
+export interface StructuredDiff {
+  /** Git diff chunks */
+  chunks: any[]
+}
+
 /** The results of running a JSON patch */
 export interface JSONPatch {
   /** The JSON in a file at the PR merge base */
@@ -96,6 +98,13 @@ export interface GitDSL extends GitJSONDSL {
    */
   diffForFile(filename: string): Promise<TextDiff | null>
 
+  /**
+   * Offers the structured diff for a specific file
+   *
+   * @param {string} filename the path to the json file
+   */
+  structuredDiffForFile(filename: string): Promise<StructuredDiff | null>
+
   /**
    * Provides a JSON patch (rfc6902) between the two versions of a JSON file,
    * returns null if you don't have any changes for the file in the diff.

source/platforms/FakePlatform.ts

@@ -20,7 +20,8 @@ export class FakePlatform implements Platform {
       modified_files: [],
       created_files: [],
       deleted_files: [],
-      diffForFile: async () => ({ chunks: [], before: "", after: "", diff: "", added: "", removed: "" }),
+      diffForFile: async () => ({ before: "", after: "", diff: "", added: "", removed: "" }),
+      structuredDiffForFile: async () => ({ chunks: [] }),
       JSONDiffForFile: async () => ({} as any),
       JSONPatchForFile: async () => ({} as any),
       commits: [

source/platforms/GitHub.ts

@@ -159,7 +159,7 @@ export class GitHub implements Platform {
    * @returns {Promise<number>} A number with given position
    */
   findPositionForInlineComment = (git: GitDSL, line: number, path: string): Promise<number> => {
-    return git.diffForFile(path).then(diff => {
+    return git.structuredDiffForFile(path).then(diff => {
       return new Promise<number>((resolve, reject) => {
         if (diff === undefined) {
           reject()

source/platforms/git/gitJSONToGitDSL.ts

@@ -8,7 +8,7 @@ import * as keys from "lodash.keys"
 import * as jsonDiff from "rfc6902"
 import * as jsonpointer from "jsonpointer"
 
-import { GitDSL, JSONPatchOperation, GitJSONDSL } from "../../dsl/GitDSL"
+import { GitDSL, JSONPatchOperation, GitJSONDSL, StructuredDiff } from "../../dsl/GitDSL"
 
 /*
  * As Danger JS bootstraps from JSON like all `danger process` commands
@@ -151,7 +151,7 @@ export const gitJSONToGitDSL = (gitJSONRep: GitJSONDSL, config: GitJSONToGitDSLC
    *
    * @param filename File path for the diff
    */
-  const diffForFile = async (filename: string) => {
+  const structuredDiffForFile = async (filename: string): Promise<StructuredDiff | null> => {
     let fileDiffs: GitStructuredDiff
 
     if (config.getFullStructuredDiff) {
@@ -161,6 +161,20 @@ export const gitJSONToGitDSL = (gitJSONRep: GitJSONDSL, config: GitJSONToGitDSLC
       fileDiffs = parseDiff(diff)
     }
     const structuredDiff = fileDiffs.find(diff => diff.from === filename || diff.to === filename)
+    if (structuredDiff !== undefined) {
+      return { chunks: structuredDiff.chunks }
+    } else {
+      return null
+    }
+  }
+
+  /**
+   * Gets the git-style diff for a single file.
+   *
+   * @param filename File path for the diff
+   */
+  const diffForFile = async (filename: string) => {
+    const structuredDiff = await structuredDiffForFile(filename)
 
     if (!structuredDiff) {
       return null
@@ -171,7 +185,6 @@ export const gitJSONToGitDSL = (gitJSONRep: GitJSONDSL, config: GitJSONToGitDSLC
       .reduce((a: Changes, b: Changes) => a.concat(b), [])
 
     return {
-      chunks: structuredDiff.chunks,
       before: await config.getFileContents(filename, config.repo, config.baseSHA),
       after: await config.getFileContents(filename, config.repo, config.headSHA),
 
@@ -195,6 +208,7 @@ export const gitJSONToGitDSL = (gitJSONRep: GitJSONDSL, config: GitJSONToGitDSLC
     deleted_files: gitJSONRep.deleted_files,
     commits: gitJSONRep.commits,
     diffForFile,
+    structuredDiffForFile,
     JSONPatchForFile,
     JSONDiffForFile,
   }

source/platforms/github/_tests/_github_git.test.ts

@@ -104,7 +104,7 @@ describe("the dangerfile gitDSL", async () => {
   })
 
   it("show diff chunks for a specific file", async () => {
-    const { chunks } = await gitDSL.diffForFile("tsconfig.json")
+    const { chunks } = await gitDSL.structuredDiffForFile("tsconfig.json")
 
     expect(chunks).toMatchSnapshot()
   })