add ability to skip debug-level logs

Author: anton-107

.gitignore

@@ -1,2 +1,3 @@
+.idea
 node_modules
 coverage

README.md

@@ -2,6 +2,18 @@
 
 Module to collect data from a git repository.
 
+## How to run:
+
+```
+SOURCE_DIR=<PATH TO LOCAL GIT REPO>  npm run run-dev
+```
+
+Set `NODE_ENV=production` if you want to skip debug-level logs:
+
+```
+SOURCE_DIR=<PATH TO LOCAL GIT REPO> NODE_ENV=production npm run run-dev
+```
+
 ## Collected data:
 
 ### The most changed files

src/git-reader/git-repository.ts

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

src/index.ts

@@ -12,13 +12,26 @@ export function log(arg1: string, arg2: object) {
   // eslint-disable-next-line no-console
   console.log(arg1, arg2);
 }
+export function debug(arg1: string, arg2: object) {
+  if (process.env.NODE_ENV !== "production") {
+    // eslint-disable-next-line no-console
+    console.debug(arg1, arg2);
+  }
+}
 export function time(timerName: string) {
   // eslint-disable-next-line no-console
   console.time(timerName);
 }
 export function timeLog(timerName: string) {
+  if (process.env.NODE_ENV !== "production") {
+    // eslint-disable-next-line no-console
+    console.timeLog(timerName);
+  }
+}
+function clearConsole() {
+  process.stdout.write("\u001b[3J\u001b[2J\u001b[1J");
   // eslint-disable-next-line no-console
-  console.timeLog(timerName);
+  console.clear();
 }
 
 async function collectCommitsByAuthor(repo: GitRepository) {
@@ -67,7 +80,7 @@ async function main() {
   }
 
   const repo = new GitRepository(dir);
-  log("Getting a list of changed files", { dir });
+  debug("Getting a list of changed files", { dir });
   const commitsStream = new Readable({
     objectMode: true,
     read() {
@@ -88,9 +101,11 @@ async function main() {
     intermediateAggregateMonthly.addCommit(commit);
     intermediateAggregateQuarterly.addCommit(commit);
 
-    log("monthly data: ", intermediateAggregateMonthly.getData());
+    clearConsole();
+
+    // log("monthly data: ", intermediateAggregateMonthly.getData());
     log("quarterly data: ", {
-      data: JSON.stringify(intermediateAggregateQuarterly.getData()),
+      data: JSON.stringify(intermediateAggregateQuarterly.displayReport()),
     });
   });
   commitsStream.on("end", () => {

src/stats/aggregate/aggregate.ts

@@ -81,4 +81,7 @@ export abstract class Aggregate<T> {
   public getValue(filePath: FilePath, aggregateKey: AggregateKey): T {
     return this.files[filePath][aggregateKey];
   }
+  public displayReport(): string {
+    return "TODO: report will be here";
+  }
 }