Added debug logging option

Author: Sebastian Wendorf

typescript/src/core/extractor.ts

@@ -12,8 +12,8 @@ import { FileUtils } from "./utils/file.utils";
 import { POST_PROCESSORS } from "./features";
 import { ProjectUtils } from "./utils/project.utils";
 import { LCEProject, LCEProjectInfo } from "./project";
+import {debug, DEBUG_LOGGING} from "./utils/log.utils";
 
-// eslint-disable-next-line @typescript-eslint/ban-types
 export interface ExtractorOptions {
     prettyPrint?: boolean;
 }
@@ -36,8 +36,8 @@ export async function processProjectsAndOutputResult(scanRoot: string, options:
         options.prettyPrint ? 2 : undefined,
     );
 
-    let dirPath = path.join(scanRoot, ".reports", "jqa");
-    let filePath = path.join(dirPath, "ts-output.json");
+    const dirPath = path.join(scanRoot, ".reports", "jqa");
+    const filePath = path.join(dirPath, "ts-output.json");
     fs.mkdir(dirPath, { recursive: true }, (errDir) => {
         if (errDir) {
             console.log("Could not create directory: " + dirPath);
@@ -86,12 +86,14 @@ export async function processProject(project: LCEProjectInfo): Promise<LCEProjec
     const startTime = process.hrtime();
     let fileReadingTime = 0;
     const progressBar = new SingleBar({}, Presets.shades_classic);
-    progressBar.start(fileList.length, 0);
+    if(!DEBUG_LOGGING)
+        progressBar.start(fileList.length, 0);
 
     // Traverse and process all individual project files
     const traverser = new AstTraverser();
     for (let i = 0; i < fileList.length; i++) {
-        progressBar.update(i + 1);
+        if(!DEBUG_LOGGING)
+            progressBar.update(i + 1);
         const file = fileList[i];
 
         const frStartTime = process.hrtime();
@@ -100,6 +102,8 @@ export async function processProject(project: LCEProjectInfo): Promise<LCEProjec
         fileReadingTime += frEndTime[0] + frEndTime[1] / 10 ** 9 - (frStartTime[0] + frStartTime[1] / 10 ** 9);
 
         try {
+            debug(`Processing file [${i+1}/${fileList.length}]: ${FileUtils.normalizePath(ModulePathUtils.normalize(projectRoot, file))}`);
+
             const { ast, services } = parseAndGenerateServices(code, {
                 loc: true,
                 range: true,
@@ -127,7 +131,8 @@ export async function processProject(project: LCEProjectInfo): Promise<LCEProjec
             console.log(e);
         }
     }
-    progressBar.stop();
+    if(!DEBUG_LOGGING)
+        progressBar.stop();
     const normalizedConcepts: Map<string, LCEConcept[]> = unifyConceptMap(concepts, "").get("") ?? new Map();
 
     const endTime = process.hrtime();

typescript/src/core/traverser.ts

@@ -2,6 +2,7 @@ import { ConceptMap, mergeConceptMaps } from "./concept";
 import { ProcessingContext } from "./context";
 import { Processor, ProcessorMap } from "./processor";
 import { CoreContextKeys } from "./context.keys";
+import {debugTraversalStack} from "./utils/log.utils";
 
 export interface TraverserContext {
     parentPropName: string;
@@ -28,6 +29,8 @@ export abstract class Traverser {
             validProcessors = processorCandidates.filter((proc) => proc.executionCondition.check(processingContext));
         }
 
+        debugTraversalStack(processingContext.localContexts);
+
         // pre-processing
         if (validProcessors) {
             for (const proc of validProcessors) {

typescript/src/core/utils/log.utils.ts

@@ -0,0 +1,27 @@
+import {LocalContexts} from "../context";
+import {CoreContextKeys} from "../context.keys";
+import {TraverserContext} from "../traverser";
+
+export let DEBUG_LOGGING = false;
+
+export function setDebugLogging(enableDebugLogging: boolean): void {
+    DEBUG_LOGGING = enableDebugLogging;
+}
+
+export function debug(logMessage: string): void {
+    if(DEBUG_LOGGING) {
+        console.debug(logMessage);
+    }
+}
+
+export function debugTraversalStack(localContexts: LocalContexts): void {
+    if(DEBUG_LOGGING) {
+        let astPos  = "";
+        for(const lc of localContexts.contexts) {
+            const coordNum = (lc.get(CoreContextKeys.TRAVERSER_CONTEXT) as TraverserContext).parentPropIndex;
+            const coordName = (lc.get(CoreContextKeys.TRAVERSER_CONTEXT) as TraverserContext).parentPropName;
+            astPos = astPos + "/" + coordName + (coordNum !== undefined ? "[" + coordNum + "]" : "");
+        }
+        console.debug(astPos)
+    }
+}

typescript/src/main.ts

@@ -4,6 +4,7 @@ import { program } from "commander";
 import { processProjectsAndOutputResult } from "./core/extractor";
 import packageInfo from "../package.json";
 import { initializeReactExtractor } from "./react/react-extractor";
+import {setDebugLogging} from "./core/utils/log.utils";
 
 
 // Setup CLI
@@ -14,14 +15,16 @@ program
     .version(packageInfo.version)
     .argument("[path]", "path to the root of the TypeScript project to be scanned", ".")
     .option("-e, --extension [extensions...]", "space separated list of extensions to activate (currently available: react)")
-    .option("-p, --pretty", "pretty-print JSON result report");
+    .option("-p, --pretty", "pretty-print JSON result report")
+    .option("-d, --debug", "print debug information");
 program.parse();
 
 // retrieve CLI arguments and options
 const options = program.opts();
 
 const extensions: string[] = options.extension ?? [];
 const prettyPrint = !!options.pretty;
+setDebugLogging(!!options.debug);
 
 const projectRootPath: string = program.processedArgs[0];