introduce summary dashboard, show top 10 authors through the dashboard

Author: anton-107

src/dashboard/aggregate-file-contributors-dashboard.ts

@@ -0,0 +1,10 @@
+import { AggregateFileData } from "../stats/aggregate/aggregate.js";
+import { Contributor } from "../stats/list-of-contributors-per-file.js";
+
+export class AggregateFileContributorsDashboard {
+  constructor(private data: AggregateFileData<Contributor[]>) {}
+  public displayDashboard(): string {
+    const files = Object.keys(this.data);
+    return `Number of files changed: ${files.length}`;
+  }
+}

src/dashboard/summary-dashboard.ts

@@ -0,0 +1,42 @@
+import { log } from "../index.js";
+import { NumberOfCommitsByAuthor } from "../stats/number-of-commits-by-author.js";
+
+function clearScreen() {
+  process.stdout.write("\u001b[3J\u001b[2J\u001b[1J");
+  // eslint-disable-next-line no-console
+  console.clear();
+}
+
+type TopAuthorRecord = {
+  name: string;
+  numberOfUpdates: number;
+};
+
+export class SummaryDashboard {
+  private topAuthorsAllTime: TopAuthorRecord[] = [];
+
+  public setNumberOfCommitsPerAuthor(data: NumberOfCommitsByAuthor) {
+    const out: TopAuthorRecord[] = [];
+    const authors = Object.keys(data);
+    for (const author of authors) {
+      out.push({ name: author, numberOfUpdates: data[author] });
+    }
+
+    // Sort in descending order by numberOfUpdates
+    out.sort((a, b) => b.numberOfUpdates - a.numberOfUpdates);
+
+    this.topAuthorsAllTime = out;
+    this.render();
+  }
+
+  private render() {
+    clearScreen();
+    log("Top 10 authors:", {});
+    log("============", {});
+    for (let i = 0; i < 10; i++) {
+      log(this.topAuthorsAllTime[i].name, {
+        numberOfUpdates: this.topAuthorsAllTime[i].numberOfUpdates,
+      });
+    }
+  }
+}

src/git-reader/git-repository.ts

@@ -2,7 +2,7 @@ import fs from "fs";
 import git from "isomorphic-git";
 import { Readable } from "stream";
 
-import { debug, log, time, timeLog } from "../index.js";
+import { log, time, timeLog } from "../index.js";
 import { ChangedFile, Commit, ExpandedCommit } from "../interfaces.js";
 
 interface GitReadOptions {
@@ -39,7 +39,7 @@ export class GitRepository {
         continue;
       }
 
-      debug("Getting files diff between two commits", {
+      log("Getting files diff between two commits", {
         progress: `${i} of ${commits.length}`,
         commitDate: new Date(c.commit.author.timestamp * 1000).toISOString(),
       });

src/index.ts

@@ -1,5 +1,7 @@
 import { Readable } from "stream";
 
+import { AggregateFileContributorsDashboard } from "./dashboard/aggregate-file-contributors-dashboard.js";
+import { SummaryDashboard } from "./dashboard/summary-dashboard.js";
 import { GitRepository } from "./git-reader/git-repository.js";
 import { ExpandedCommit } from "./interfaces.js";
 import { ListOfContributorsPerFileAggregate } from "./stats/aggregate/list-of-contributors-per-file-aggregate.js";
@@ -28,17 +30,6 @@ export function timeLog(timerName: string) {
     console.timeLog(timerName);
   }
 }
-function clearConsole() {
-  process.stdout.write("\u001b[3J\u001b[2J\u001b[1J");
-  // eslint-disable-next-line no-console
-  console.clear();
-}
-
-async function collectCommitsByAuthor(repo: GitRepository) {
-  const commits = await repo.getListOfCommits();
-  const commitsByAuthor = getNumberOfCommitsByAuthor(commits);
-  log("commitsByAuthor", commitsByAuthor);
-}
 
 async function collectHotFiles(commitsWithChangedFiles: ExpandedCommit[]) {
   const commitsPerFile = getNumberOfChangesPerFile(commitsWithChangedFiles);
@@ -97,28 +88,34 @@ async function main() {
   );
 
   commitsStream.on("data", (commit) => {
-    log("Commit", commit);
+    debug("Commit", commit);
     intermediateAggregateMonthly.addCommit(commit);
     intermediateAggregateQuarterly.addCommit(commit);
 
-    clearConsole();
-
     // log("monthly data: ", intermediateAggregateMonthly.getData());
-    log("quarterly data: ", {
-      data: JSON.stringify(intermediateAggregateQuarterly.displayReport()),
-    });
+    const quarterlyDashboard = new AggregateFileContributorsDashboard(
+      intermediateAggregateQuarterly.getData()
+    );
+    log(quarterlyDashboard.displayDashboard(), {});
   });
   commitsStream.on("end", () => {
     log("done reading commits", {});
   });
 
+  // initialize dashboard
+  const summaryDashboard = new SummaryDashboard();
+
+  // number of commits by author:
+  const commits = await repo.getListOfCommits();
+  const commitsByAuthor = getNumberOfCommitsByAuthor(commits);
+  summaryDashboard.setNumberOfCommitsPerAuthor(commitsByAuthor);
+
   const commitsWithChangedFiles = await repo.getListOfCommitsWithChangedFiles({
     stream: commitsStream,
   });
   log("Finished fetching a list of changed files", {
     numberOfFiles: commitsWithChangedFiles.length,
   });
-  await collectCommitsByAuthor(repo);
   await collectHotFiles(commitsWithChangedFiles);
   await collectKnowledgeGaps(commitsWithChangedFiles);
   await collectDetailedContributorsPerFile(commitsWithChangedFiles);

src/stats/aggregate/aggregate.ts

@@ -6,6 +6,8 @@ type AggregateKey = string;
 
 type CommitToAggregateKey = (commit: Commit) => AggregateKey;
 
+export type AggregateFileData<T> = Record<FilePath, Record<AggregateKey, T>>;
+
 interface AggregateOptions {
   strategy: AggregateStrategy;
 }
@@ -69,7 +71,7 @@ export abstract class Aggregate<T> {
       );
     }
   }
-  public getData(): Record<FilePath, Record<AggregateKey, T>> {
+  public getData(): AggregateFileData<T> {
     return this.files;
   }
   public listFiles(): FilePath[] {

src/stats/number-of-commits-by-author.ts

@@ -1,6 +1,10 @@
 import { Commit } from "../interfaces.js";
 
-export function getNumberOfCommitsByAuthor(commits: Commit[]) {
+export type NumberOfCommitsByAuthor = Record<string, number>;
+
+export function getNumberOfCommitsByAuthor(
+  commits: Commit[]
+): NumberOfCommitsByAuthor {
   const authors: Record<string, number> = {};
   commits.forEach((commit) => {
     if (!authors[commit.commit.author.name]) {