now structuredDiffForFile is well-typed

danger · Jan 25, 2022 · dc54972 · dc54972
1 parent 0b5865f
commit dc54972
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 13 deletions.
diff --git a/scripts/danger-dts.ts b/scripts/danger-dts.ts
@@ -14,6 +14,7 @@ const createDTS = () => {
 
 import { Octokit as GitHub } from "@octokit/rest"
 import { Gitlab } from "gitlab"
+import { File } from "parse-diff"
 
 `
   const footer = ``

diff --git a/source/ambient.d.ts b/source/ambient.d.ts
@@ -1,4 +1,3 @@
-declare module "parse-diff"
 declare module "lodash.includes"
 declare module "lodash.find"
 declare module "lodash.isobject"

diff --git a/source/danger.d.ts b/source/danger.d.ts
@@ -4,6 +4,7 @@
 
 import { Octokit as GitHub } from "@octokit/rest"
 import { Gitlab } from "gitlab"
+import { File } from "parse-diff"
 
 type MarkdownString = string
 // TODO: extract out from BitBucket specifically, or create our own type
@@ -809,7 +810,7 @@ interface TextDiff {
 /** Git diff sliced into chunks */
 interface StructuredDiff {
   /** Git diff chunks */
-  chunks: any[]
+  chunks: File["chunks"]
 }
 
 /** The results of running a JSON patch */

diff --git a/source/dsl/GitDSL.ts b/source/dsl/GitDSL.ts
@@ -2,6 +2,7 @@
 
 import { GitCommit } from "./Commit"
 import { Chainsmoker } from "../commands/utils/chainsmoker"
+import { File } from "parse-diff"
 
 /** All Text diff values will be this shape */
 export interface TextDiff {
@@ -20,7 +21,7 @@ export interface TextDiff {
 /** Git diff sliced into chunks */
 export interface StructuredDiff {
   /** Git diff chunks */
-  chunks: any[]
+  chunks: File["chunks"]
 }
 
 /** The results of running a JSON patch */

diff --git a/source/platforms/git/gitJSONToGitDSL.ts b/source/platforms/git/gitJSONToGitDSL.ts
@@ -39,17 +39,9 @@ export interface GitJSONToGitDSLConfig {
   getStructuredDiffForFile?: (base: string, head: string, filename: string) => Promise<GitStructuredDiff>
 }
 
-export type GitStructuredDiff = {
-  from?: string
-  to?: string
-  chunks: Chunk[]
-}[]
-
-export interface Chunk {
-  changes: Changes
-}
+export type GitStructuredDiff = Pick<parseDiff.File, "chunks" | "from" | "to">[]
 
-export type Changes = { type: "add" | "del" | "normal"; content: string }[]
+export type Changes = parseDiff.Change[]
 
 export const gitJSONToGitDSL = (gitJSONRep: GitJSONDSL, config: GitJSONToGitDSLConfig): GitDSL => {
   const getFullDiff: ((base: string, head: string) => Promise<string>) | null = config.getStructuredDiffForFile