feature: run hot spots analysis

Author: anton-107

README.md

@@ -4,6 +4,40 @@ CLI wrapper around https://github.com/anton-107/codebase-stats-collector
 
 ## Usage
 
+### hot-spots
+
+Identifies high-churn areas in your codebase by analyzing file modification patterns.
+This command helps teams discover files that require frequent changes, potentially indicating design issues,
+technical debt, or areas needing refactoring.
+It analyzes your repository's history to highlight files with the highest number of changes.
+These frequently modified files often represent:
+
+- Areas of code that may be unstable or poorly designed
+- Features that experience constant requirement changes
+- Components that might benefit from refactoring
+- Potential technical debt that needs attention
+
+To run:
+
+```
+npm run cli -- hot-spots <PATH TO LOCAL GIT REPO>
+```
+
+### knowledge-gaps
+
+Identifies potential knowledge gaps in your codebase by analyzing file-level contribution patterns.
+This command helps teams identify files that may represent single points of failure due to limited contributor coverage.
+It scans your repository and generates a report of files sorted by their last modification date,
+highlighting those with the fewest unique contributors.
+
+This helps identify:
+
+- Files that may become maintenance bottlenecks
+- Code that could benefit from knowledge sharing
+- Areas where code reviews and pair programming should be prioritized
+
+To run:
+
 ```
 npm run cli -- knowledge-gaps <PATH TO LOCAL GIT REPO> --ignoreFiles /path/to/ignored/folder
 ```

src/cli.ts

@@ -1,5 +1,6 @@
 import { cli, command } from "cleye";
 
+import { collectHotSpots } from "./commands/hot-spots.js";
 import { collectKnowledgeGaps } from "./commands/knowledge-gaps.js";
 import { log } from "./console.js";
 
@@ -8,6 +9,17 @@ export class CommandLineInterface {
   public run() {
     cli({
       commands: [
+        command(
+          {
+            name: "hot-spots",
+            parameters: ["<path to repository>"],
+          },
+          async (argv) => {
+            const dir = argv._.pathToRepository;
+            log("Collecting files with most changes", dir);
+            await collectHotSpots(dir);
+          },
+        ),
         command(
           {
             name: "knowledge-gaps",
@@ -21,7 +33,7 @@ export class CommandLineInterface {
           },
           async (argv) => {
             const dir = argv._.pathToRepository;
-            log("Calculating files with least number of contributors", dir);
+            log("Collecting files with least number of contributors", dir);
             let ignoreFilesPattern: string | null = null;
             if (argv.flags.ignoreFiles) {
               // eslint-disable-next-line no-console

src/commands/hot-spots.ts

@@ -0,0 +1,33 @@
+import { SummaryDashboard } from "codebase-stats-collector/dist/dashboard/summary-dashboard.js";
+import { GitRepository } from "codebase-stats-collector/dist/git-reader/git-repository.js";
+import { getNumberOfChangesPerFile } from "codebase-stats-collector/dist/stats/number-of-changes-per-file.js";
+
+import { log } from "../console.js";
+import { setupProgressStream } from "../dashboard/progress.js";
+
+export async function collectHotSpots(dir: string): 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 commitsPerFile = getNumberOfChangesPerFile(commitsWithChangedFiles);
+  const data = Object.keys(commitsPerFile).map((x) => {
+    return [x, commitsPerFile[x]];
+  });
+  data.sort((a, b) => Number(b[1]) - Number(a[1]));
+  const hotFiles = data.slice(0, 50);
+  log("hot files (files with most changes)", hotFiles);
+}

src/commands/knowledge-gaps.ts

@@ -1,38 +1,9 @@
-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;
-}
+import { setupProgressStream } from "../dashboard/progress.js";
 
 export async function collectKnowledgeGaps(
   dir: string,

src/dashboard/progress.ts

@@ -0,0 +1,33 @@
+import { debug } from "codebase-stats-collector/dist/console/console.js";
+import { SummaryDashboard } from "codebase-stats-collector/dist/dashboard/summary-dashboard.js";
+import { ExpandedCommit } from "codebase-stats-collector/dist/interfaces.js";
+import { Readable } from "stream";
+
+export 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;
+}