run knowledge gap analysis applying the filtering for ignored files

Author: anton-107

.gitignore

@@ -1,3 +1,4 @@
 .env
 node_modules
-.idea
+.idea
+.cache

README.md

@@ -5,5 +5,5 @@ CLI wrapper around https://github.com/anton-107/codebase-stats-collector
 ## Usage
 
 ```
-npm run cli -- knowledge-gaps <PATH TO GIT REPO> --ignoreFiles /path/to/ignored/folder
+npm run cli -- knowledge-gaps <PATH TO LOCAL GIT REPO> --ignoreFiles /path/to/ignored/folder
 ```

eslint.config.mjs

@@ -4,19 +4,18 @@ import simpleImportSort from "eslint-plugin-simple-import-sort";
 import globals from "globals";
 import tseslint from "typescript-eslint";
 
-
 /** @type {import('eslint').Linter.Config[]} */
 export default [
-  {files: ["**/*.{ts,tsx}"]},
-  {files: ["**/*.ts"], languageOptions: {sourceType: "script"}},
-  {languageOptions: { globals: globals.node }},
+  { files: ["**/*.{ts,tsx}"] },
+  { files: ["**/*.ts"], languageOptions: { sourceType: "script" } },
+  { languageOptions: { globals: globals.node } },
   pluginJs.configs.recommended,
   ...tseslint.configs.recommended,
   comments.recommended,
   {
     rules: {
-      "@eslint-community/eslint-comments/no-unused-disable": "error"
-    }
+      "@eslint-community/eslint-comments/no-unused-disable": "error",
+    },
   },
   {
     plugins: {
@@ -36,6 +35,6 @@ export default [
       "max-lines-per-function": ["error", 56],
       "max-statements": ["error", 22],
       "max-params": ["error", 3],
-    }
-  }
-];
+    },
+  },
+];

src/cli.ts

@@ -1,19 +1,9 @@
 import { cli, command } from "cleye";
-import {GitRepository} from "codebase-stats-collector/dist/git-reader/git-repository.js";
-import {getNumberOfContributorsPerFile} from "codebase-stats-collector/dist/stats/number-of-contributors-per-file.js";
-import { Readable } from "stream";
 
-export function log(arg1: string, arg2: object | string | null) {
-  if (arg2 === null) {
-    // eslint-disable-next-line no-console
-    console.log(arg1);
-    return;
-  }
-  // eslint-disable-next-line no-console
-  console.log(arg1, arg2);
-}
+import { collectKnowledgeGaps } from "./commands/knowledge-gaps.js";
+import { log } from "./console.js";
 
-export class CommandLineInterface {  
+export class CommandLineInterface {
   constructor() {}
   public run() {
     cli({
@@ -31,45 +21,17 @@ export class CommandLineInterface {
           },
           async (argv) => {
             const dir = argv._.pathToRepository;
-            log(
-              "Calculating files with least number of contributors",
-                dir,
-            );
+            log("Calculating files with least number of contributors", dir);
+            let ignoreFilesPattern: string | null = null;
             if (argv.flags.ignoreFiles) {
               // eslint-disable-next-line no-console
               console.log(
                 "will ignore the following files in the output: ",
                 argv.flags.ignoreFiles,
               );
+              ignoreFilesPattern = argv.flags.ignoreFiles;
             }
-
-            // initialize repo
-            const repo = new GitRepository(dir);
-            const commitsStream = new Readable({
-              objectMode: true,
-              read() {
-                // do nothing.
-              },
-            });
-            const commitsWithChangedFiles = await repo.getListOfCommitsWithChangedFiles({
-              stream: commitsStream,
-            });
-            const contributorsPerFile = getNumberOfContributorsPerFile(
-                commitsWithChangedFiles
-            ).filter((x) => x.isExistingFile);
-            const topKnowledgeGaps = contributorsPerFile
-                .sort((a, b) => {
-                  if (a.contributorsNames.length === b.contributorsNames.length) {
-                    return a.lastChange.getTime() - b.lastChange.getTime();
-                  }
-                  return a.contributorsNames.length - b.contributorsNames.length;
-                })
-                .slice(0, 50);
-
-            log(
-                "knowledge gaps (files with least number of contributors)",
-                topKnowledgeGaps
-            );
+            await collectKnowledgeGaps(dir, ignoreFilesPattern);
           },
         ),
       ],

src/commands/knowledge-gaps.ts

@@ -0,0 +1,77 @@
+import { debug } from "codebase-stats-collector/dist/console/console.js";
+import { SummaryDashboard } from "codebase-stats-collector/dist/dashboard/summary-dashboard.js";
+import { GitRepository } from "codebase-stats-collector/dist/git-reader/git-repository.js";
+import { ExpandedCommit } from "codebase-stats-collector/dist/interfaces.js";
+import { getNumberOfContributorsPerFile } from "codebase-stats-collector/dist/stats/number-of-contributors-per-file.js";
+import { Readable } from "stream";
+
+import { log } from "../console.js";
+
+function setupProgressStream(summaryDashboard: SummaryDashboard): Readable {
+  let commitsCounter = 0;
+
+  const commitsStream = new Readable({
+    objectMode: true,
+    read() {
+      // do nothing.
+    },
+  });
+  commitsStream.on("data", (commit: ExpandedCommit) => {
+    debug("Commit", commit);
+
+    commitsCounter += 1;
+    summaryDashboard.setCurrentProgress(commitsCounter, commit);
+  });
+  commitsStream.on("error", (err) => {
+    debug("error reading commits", { err });
+  });
+  commitsStream.on("end", () => {
+    debug("done reading commits", {});
+  });
+  commitsStream.on("close", () => {
+    debug("stream closed", {});
+  });
+  return commitsStream;
+}
+
+export async function collectKnowledgeGaps(
+  dir: string,
+  ignoreFiles: string | null,
+): Promise<void> {
+  // initialize repo
+  const repo = new GitRepository(dir);
+
+  // initialize summary dashboard:
+  const summaryDashboard = new SummaryDashboard([]);
+  summaryDashboard.startProgress();
+
+  const commitsStream = setupProgressStream(summaryDashboard);
+
+  // number of total commits:
+  const commits = await repo.getListOfCommits();
+  summaryDashboard.setCommits(commits);
+
+  const commitsWithChangedFiles = await repo.getListOfCommitsWithChangedFiles({
+    stream: commitsStream,
+  });
+  const contributorsPerFile = getNumberOfContributorsPerFile(
+    commitsWithChangedFiles,
+  ).filter((x) => x.isExistingFile);
+  let knowledgeGaps = contributorsPerFile.sort((a, b) => {
+    if (a.contributorsNames.length === b.contributorsNames.length) {
+      return a.lastChange.getTime() - b.lastChange.getTime();
+    }
+    return a.contributorsNames.length - b.contributorsNames.length;
+  });
+
+  if (ignoreFiles) {
+    knowledgeGaps = knowledgeGaps.filter((x) => !x.filePath.match(ignoreFiles));
+  }
+
+  const topKnowledgeGaps = knowledgeGaps.slice(0, 50);
+
+  log(
+    "knowledge gaps (files with least number of contributors)",
+    topKnowledgeGaps,
+  );
+}

src/console.ts

@@ -0,0 +1,9 @@
+export function log(arg1: string, arg2: object | string | null) {
+  if (arg2 === null) {
+    // eslint-disable-next-line no-console
+    console.log(arg1);
+    return;
+  }
+  // eslint-disable-next-line no-console
+  console.log(arg1, arg2);
+}

src/main.ts

@@ -1,7 +1,6 @@
 import { CommandLineInterface } from "./cli.js";
 
-
 export function main() {
-    new CommandLineInterface().run();
+  new CommandLineInterface().run();
 }
-main();
+main();

tsconfig.json

@@ -107,5 +107,10 @@
     /* Completeness */
     // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
     "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  },
+  "ts-node": {
+    "experimentalSpecifierResolution": "node",
+    "transpileOnly": true,
+    "esm": true
   }
 }