Add logging

cspell.json

@@ -1,5 +1,12 @@
 {
   "version": "0.2",
-  "words": ["ahmadnassri", "codecov", "Eriksson", "paleite"],
-  "ignoreWords": ["pinst", "Wercker"]
+  "words": ["Unstaged"],
+  "ignoreWords": [
+    "ahmadnassri",
+    "codecov",
+    "Eriksson",
+    "paleite",
+    "pinst",
+    "Wercker"
+  ]
 }

package.json

@@ -39,18 +39,23 @@
     "test": "jest --coverage",
     "typecheck": "tsc --project tsconfig.json --noEmit"
   },
+  "resolutions": {
+    "cosmiconfig": "^8.1.3"
+  },
   "devDependencies": {
     "@paleite/eslint-config": "^1.0.9",
     "@paleite/eslint-config-base": "^1.0.9",
     "@paleite/eslint-config-typescript": "^1.0.9",
     "@paleite/jest-config": "^1.0.9",
     "@paleite/prettier-config": "^1.0.9",
     "@paleite/tsconfig-node16": "^1.0.9",
+    "@types/debug": "^4.1.7",
     "@types/eslint": "^8.4.10",
     "@types/jest": "^29.2.6",
     "@types/node": "^18.11.18",
     "@typescript-eslint/eslint-plugin": "^5.48.2",
     "@typescript-eslint/parser": "^5.48.2",
+    "debug": "^4.3.2",
     "eslint": "^8.32.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-import-resolver-typescript": "^3.5.3",
@@ -73,8 +78,5 @@
   },
   "engines": {
     "node": ">=14.0.0"
-  },
-  "resolutions": {
-    "cosmiconfig": "^8.1.3"
   }
 }

src/Range.ts

@@ -1,3 +1,5 @@
+import { log } from "./logging";
+
 class Range {
   private readonly inclusiveLowerBound: Readonly<number>;
   private readonly exclusiveUpperBound: Readonly<number>;
@@ -17,7 +19,13 @@ class Range {
   }
 
   isWithinRange(n: Readonly<number>): boolean {
-    return this.inclusiveLowerBound <= n && n < this.exclusiveUpperBound;
+    log(
+      `Checking if ${n} is within range ${this.inclusiveLowerBound} - ${this.exclusiveUpperBound}`
+    );
+    const result =
+      this.inclusiveLowerBound <= n && n < this.exclusiveUpperBound;
+
+    return result;
   }
 }
 

src/ci.ts

@@ -1,3 +1,5 @@
+import { log } from "./logging";
+
 type CiProviderCommon<T extends CiProviderName> = { name: T };
 
 type CiProvider<T extends CiProviderName = CiProviderName> =
@@ -74,24 +76,28 @@ const PROVIDERS = {
 
 type CiProviderName = keyof typeof PROVIDERS;
 
-const guessProviders = () =>
-  Object.values(PROVIDERS).reduce<{ name: CiProviderName; branch: string }[]>(
-    (acc, { name, ...cur }) => {
-      if (!cur.isSupported || cur.diffBranch === undefined) {
-        return acc;
-      }
+const guessProviders = () => {
+  log("Guessing CI providers");
+
+  return Object.values(PROVIDERS).reduce<
+    { name: CiProviderName; branch: string }[]
+  >((acc, { name, ...cur }) => {
+    if (!cur.isSupported || cur.diffBranch === undefined) {
+      return acc;
+    }
 
-      const branch = process.env[cur.diffBranch] ?? "";
-      if (branch === "") {
-        return acc;
-      }
+    const branch = process.env[cur.diffBranch] ?? "";
+    if (branch === "") {
+      return acc;
+    }
 
-      return [...acc, { name, branch }];
-    },
-    []
-  );
+    return [...acc, { name, branch }];
+  }, []);
+};
 
 const guessBranch = (): string | undefined => {
+  log("Guessing branch");
+
   if ((process.env.ESLINT_PLUGIN_COMMIT ?? "").length > 0) {
     throw Error("ESLINT_PLUGIN_COMMIT already set");
   }

src/git.test.ts

@@ -51,7 +51,11 @@ describe("getDiffForFile", () => {
     mockedChildProcess.execFileSync.mockReturnValueOnce(Buffer.from(hunks));
     process.env.ESLINT_PLUGIN_DIFF_COMMIT = "1234567";
 
-    const diffFromFile = getDiffForFile("./mockfile.js", true);
+    const diffFromFile = getDiffForFile(
+      process.env.ESLINT_PLUGIN_DIFF_COMMIT,
+      "./mockfile.js",
+      true
+    );
 
     const expectedCommand = "git";
     const expectedArgs =
@@ -93,7 +97,7 @@ describe("getDiffFileList", () => {
       Buffer.from(diffFileList)
     );
     expect(mockedChildProcess.execFileSync).toHaveBeenCalledTimes(0);
-    const fileListA = getDiffFileList();
+    const fileListA = getDiffFileList("HEAD");
 
     expect(mockedChildProcess.execFileSync).toHaveBeenCalledTimes(1);
     expect(fileListA).toEqual(

src/git.ts

@@ -1,11 +1,17 @@
 import * as child_process from "child_process";
 import { resolve } from "path";
+import { log } from "./logging";
 import { Range } from "./Range";
 
 const COMMAND = "git";
 const OPTIONS = { maxBuffer: 1024 * 1024 * 100 };
 
-const getDiffForFile = (filePath: string, staged = false): string => {
+const getDiffForFile = (
+  commit: string,
+  filePath: string,
+  staged = false
+): string => {
+  log("Getting diff for file", filePath);
   const args = [
     "diff",
     "--diff-algorithm=histogram",
@@ -15,7 +21,7 @@ const getDiffForFile = (filePath: string, staged = false): string => {
     "--relative",
     staged && "--staged",
     "--unified=0",
-    process.env.ESLINT_PLUGIN_DIFF_COMMIT ?? "HEAD",
+    commit,
     "--",
     resolve(filePath),
   ].reduce<string[]>(
@@ -26,7 +32,9 @@ const getDiffForFile = (filePath: string, staged = false): string => {
   return child_process.execFileSync(COMMAND, args, OPTIONS).toString();
 };
 
-const getDiffFileList = (staged = false): string[] => {
+const getDiffFileList = (commit: string, staged = false): string[] => {
+  log(`Getting list of files for ${staged ? "staged files" : "changed files"}`);
+
   const args = [
     "diff",
     "--diff-algorithm=histogram",
@@ -36,22 +44,28 @@ const getDiffFileList = (staged = false): string[] => {
     "--no-ext-diff",
     "--relative",
     staged && "--staged",
-    process.env.ESLINT_PLUGIN_DIFF_COMMIT ?? "HEAD",
+    commit,
     "--",
   ].reduce<string[]>(
     (acc, cur) => (typeof cur === "string" ? [...acc, cur] : acc),
     []
   );
 
-  return child_process
+  const diffFileList = child_process
     .execFileSync(COMMAND, args, OPTIONS)
     .toString()
     .trim()
     .split("\n")
     .map((filePath) => resolve(filePath));
+
+  log(diffFileList);
+
+  return diffFileList;
 };
 
 const hasCleanIndex = (filePath: string): boolean => {
+  log("Checking if file has clean index");
+
   const args = [
     "diff",
     "--no-ext-diff",
@@ -72,6 +86,7 @@ const hasCleanIndex = (filePath: string): boolean => {
 };
 
 const fetchFromOrigin = (branch: string) => {
+  log("Fetching from origin", branch);
   const args = ["fetch", "--quiet", "origin", branch];
 
   child_process.execFileSync(COMMAND, args, OPTIONS);
@@ -87,6 +102,7 @@ const getUntrackedFileList = (
   }
 
   if (untrackedFileListCache === undefined || shouldRefresh) {
+    log("Getting list of files for untracked files");
     const args = ["ls-files", "--exclude-standard", "--others"];
 
     untrackedFileListCache = child_process
@@ -95,6 +111,8 @@ const getUntrackedFileList = (
       .trim()
       .split("\n")
       .map((filePath) => resolve(filePath));
+
+    log("Untracked files", untrackedFileListCache);
   }
 
   return untrackedFileListCache;
@@ -141,8 +159,10 @@ const getRangeForChangedLines = (line: string) => {
   return hasAddedLines ? new Range(start, end) : null;
 };
 
-const getRangesForDiff = (diff: string): Range[] =>
-  diff.split("\n").reduce<Range[]>((ranges, line) => {
+const getRangesForDiff = (diff: string): Range[] => {
+  log("Getting ranges for diff");
+
+  return diff.split("\n").reduce<Range[]>((ranges, line) => {
     if (!isHunkHeader(line)) {
       return ranges;
     }
@@ -154,6 +174,7 @@ const getRangesForDiff = (diff: string): Range[] =>
 
     return [...ranges, range];
   }, []);
+};
 
 export {
   fetchFromOrigin,

src/logging.ts

@@ -0,0 +1,5 @@
+import debug from "debug";
+
+const log = debug("eslint-plugin-diff");
+
+export { log };