codebase-onboarder 0.6.0 → 0.7.0

package/cli/explorer/report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../../src/cli/explorer/report.ts"],"names":[],"mappings":"AA2CA,MAAM,UAAU,YAAY,CAAC,IAAqB;IAChD,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;IAC9B,OAAO;QACL,aAAa,EAAE,CAAC;QAChB,UAAU,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE;QAChD,IAAI,EAAE;YACJ,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC;YACjC,OAAO,EAAE;gBACP,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK;gBAC1B,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ;gBAChC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ;gBAChC,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU;gBACpC,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU;aACrC;SACF;QACD,YAAY,EAAE;YACZ,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO;YAC/B,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM;YAChC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;SAC/F;QACD,MAAM,EAAE;YACN,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;YACxB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;YACxB,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;SACzF;QACD,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE;QACvE,gBAAgB,EAAE;YAChB,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,WAAW;YAC9C,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY;YACjD,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK;SACvC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAwB;IACnD,MAAM,KAAK,GAAG;QACZ,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,oBAAoB;QAC7C,MAAM,CAAC,UAAU,CAAC,IAAI;QACtB,EAAE;QACF,qBAAqB,MAAM,CAAC,IAAI,CAAC,WAAW,UAAU,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU;QACpI,qBAAqB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,cAAc,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,cAAc,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,gBAAgB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,WAAW;QAChM,qBAAqB,MAAM,CAAC,YAAY,CAAC,WAAW,CAAC,MAAM,kBAAkB,MAAM,CAAC,YAAY,CAAC,MAAM,SAAS;QAChH,qBAAqB,MAAM,CAAC,MAAM,CAAC,KAAK,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,OAAO;QACvE,qBAAqB,MAAM,CAAC,QAAQ,CAAC,KAAK,KAAK,MAAM,CAAC,QAAQ,CAAC,QAAQ,sBAAsB;QAC7F,qBAAqB,MAAM,CAAC,gBAAgB,CAAC,SAAS,IAAI,MAAM,CAAC,gBAAgB,CAAC,WAAW,kBAAkB,MAAM,CAAC,gBAAgB,CAAC,OAAO,IAAI;KACnJ,CAAC;IACF,IAAI,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACvC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,qBAAqB,CAAC,CAAC;QACtC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,YAAY,CAAC,OAAO;YAAE,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,MAAM,GAAG,CAAC,UAAU,aAAa,CAAC,CAAC;IAC5G,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;QACvC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,oBAAoB,CAAC,CAAC;QACrC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa;YAAE,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,WAAW,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;IACpG,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC","sourcesContent":["/** A stable, small snapshot for scripts and CI. It contains no source text. */\nexport interface RepositoryReport {\n  schemaVersion: 1;\n  repository: { name: string; root: string };\n  scan: {\n    parsedFiles: number;\n    skipped: number;\n    partial: boolean;\n    imports: { total: number; internal: number; external: number; unresolved: number; confidence: number };\n  };\n  architecture: {\n    entryPoints: string[];\n    cycles: number;\n    topHubs: Array<{ path: string; importedBy: number }>;\n  };\n  health: {\n    grade: string;\n    score: number;\n    riskiestFiles: Array<{ path: string; risk: number }>;\n  };\n  security: { grade: string; findings: number };\n  testReachability: { reachable: number; sourceFiles: number; percent: number };\n}\n\ninterface RepositoryInput {\n  name: string;\n  root: string;\n  scan: { stats: {\n    filesParsed: number;\n    skipped: number;\n    truncated: unknown;\n    imports: RepositoryReport['scan']['imports'];\n  } };\n  facts: {\n    entries: string[];\n    cycles: unknown[];\n    hubs: Array<{ path: string; fanIn: number }>;\n    testCoverage: { testedCount: number; totalNonTest: number; ratio: number };\n  };\n  health: { grade: string; score: number; perFile: Array<{ path: string; risk: number }> };\n  security: { grade: string; total: number };\n}\n\nexport function createReport(repo: RepositoryInput): RepositoryReport {\n  const stats = repo.scan.stats;\n  return {\n    schemaVersion: 1,\n    repository: { name: repo.name, root: repo.root },\n    scan: {\n      parsedFiles: stats.filesParsed,\n      skipped: stats.skipped,\n      partial: Boolean(stats.truncated),\n      imports: {\n        total: stats.imports.total,\n        internal: stats.imports.internal,\n        external: stats.imports.external,\n        unresolved: stats.imports.unresolved,\n        confidence: stats.imports.confidence,\n      },\n    },\n    architecture: {\n      entryPoints: repo.facts.entries,\n      cycles: repo.facts.cycles.length,\n      topHubs: repo.facts.hubs.slice(0, 5).map((hub) => ({ path: hub.path, importedBy: hub.fanIn })),\n    },\n    health: {\n      grade: repo.health.grade,\n      score: repo.health.score,\n      riskiestFiles: repo.health.perFile.slice(0, 5).map(({ path, risk }) => ({ path, risk })),\n    },\n    security: { grade: repo.security.grade, findings: repo.security.total },\n    testReachability: {\n      reachable: repo.facts.testCoverage.testedCount,\n      sourceFiles: repo.facts.testCoverage.totalNonTest,\n      percent: repo.facts.testCoverage.ratio,\n    },\n  };\n}\n\nexport function formatReport(report: RepositoryReport): string {\n  const lines = [\n    `${report.repository.name} — codebase report`,\n    report.repository.root,\n    '',\n    `Files             ${report.scan.parsedFiles} parsed${report.scan.partial ? ' (partial scan)' : ''}, ${report.scan.skipped} skipped`,\n    `Imports           ${report.scan.imports.internal} internal, ${report.scan.imports.external} external, ${report.scan.imports.unresolved} unresolved (${report.scan.imports.confidence}% placed)`,\n    `Architecture      ${report.architecture.entryPoints.length} entry points, ${report.architecture.cycles} cycles`,\n    `Health            ${report.health.grade} (${report.health.score}/100)`,\n    `Security          ${report.security.grade} (${report.security.findings} heuristic findings)`,\n    `Test reachability ${report.testReachability.reachable}/${report.testReachability.sourceFiles} source files (${report.testReachability.percent}%)`,\n  ];\n  if (report.architecture.topHubs.length) {\n    lines.push('', 'Most imported files');\n    for (const hub of report.architecture.topHubs) lines.push(`  ${hub.path}  (${hub.importedBy} importers)`);\n  }\n  if (report.health.riskiestFiles.length) {\n    lines.push('', 'Highest risk files');\n    for (const file of report.health.riskiestFiles) lines.push(`  ${file.path}  (risk ${file.risk})`);\n  }\n  return lines.join('\\n');\n}\n"]}

package/cli/explorer/session.d.ts

@@ -0,0 +1,449 @@
+import type { ScanOptions } from '../../shared/contracts.js';
+export declare function isGitUrl(target: any): boolean;
+export declare function openRepoOrClone(target: string, options?: ScanOptions): Promise<{
+    root: string;
+    name: any;
+    scan: {
+        root: string;
+        name: any;
+        scannedAt: string;
+        stats: {
+            filesTotal: number;
+            filesParsed: number;
+            skipped: number;
+            skips: {
+                ignored: number;
+                vendorDir: number;
+                notSource: number;
+                listFailed: number;
+                notCode: number;
+                readFailed: number;
+                tooLarge: number;
+                analyzeFailed: number;
+            };
+            truncated: any;
+            edgeCount: number;
+            imports: {
+                total: number;
+                internal: number;
+                external: number;
+                unresolved: number;
+                confidence: number;
+                worst: any[];
+            };
+            tookMs: number;
+            languages: Record<string, number>;
+            languageLoc: Record<string, number>;
+        };
+        allFiles: string[];
+        files: import("../../shared/contracts.js").ScannedFile[];
+        edges: import("../../shared/contracts.js").ImportEdge[];
+        externals: {
+            name: any;
+            usedBy: any[];
+        }[];
+        folders: {
+            path: string;
+            name: string;
+            depth: number;
+            fileCount: number;
+            loc: number;
+            comment: number;
+            blank: number;
+            size: number;
+            langs: Record<string, number>;
+            hasReadme: boolean;
+            docRatio: number;
+        }[];
+        workflows: any[];
+        sbom: any;
+        license: any;
+        licenseReport: any;
+    } & {
+        tempId?: string;
+        gitUrl?: string;
+    };
+    facts: {
+        communities: {
+            id: any;
+            members: any;
+            size: any;
+        }[];
+        betweenness: {
+            [k: string]: number;
+        };
+        betweennessExact: boolean;
+        fanIn: any;
+        fanOut: any;
+        importers: any;
+        importsOf: any;
+        entries: any;
+        hubs: any;
+        orphans: any;
+        cycles: any[];
+        inCycle: unknown[];
+        deadExports: any[];
+        testCoverage: {
+            testedCount: number;
+            totalNonTest: any;
+            ratio: number;
+        };
+        untestedHubs: any;
+        depsDrift: {
+            unusedDeclared: string[];
+            undeclaredImported: string[];
+        };
+        folderEdges: {
+            from: any;
+            to: any;
+            count: any;
+        }[];
+        entrySet: any;
+    };
+    manifest: import("../../shared/contracts.js").Manifest;
+    searchIndex: {
+        index: Map<any, any>;
+        docCounts: Map<any, any>;
+        totalDocs: number;
+        totalBytes: number;
+        skipped: {
+            tooLarge: number;
+            overCap: number;
+            readFailed: number;
+            binary: number;
+            noTokens: number;
+        };
+        cap: {
+            maxFileBytes: number;
+            maxTotalBytes: number;
+        };
+    };
+    layers: {
+        layers: any[];
+        unreachable: any;
+        seeds: any;
+    };
+    coupling: {
+        folders: any[];
+        counts: Map<any, any>;
+        max: number;
+    };
+    health: {
+        score: number;
+        grade: string;
+        perFile: any[];
+        breakdown: any[];
+        blastExact: boolean;
+        totals: {
+            crit: number;
+            high: number;
+            avgCx: number;
+            orphanRatio: number;
+            cycles: number;
+        };
+        techDebtRatio?: undefined;
+        effortHours?: undefined;
+        debtCategory?: undefined;
+    } | {
+        score: number;
+        grade: string;
+        perFile: any;
+        breakdown: any[];
+        blastExact: boolean;
+        totals: {
+            crit: any;
+            high: any;
+            avgCx: number;
+            orphanRatio: number;
+            cycles: any;
+        };
+        techDebtRatio: number;
+        effortHours: number;
+        debtCategory: string;
+    };
+    patterns: any[];
+    security: {
+        counts: {
+            critical: number;
+            high: number;
+            medium: number;
+            low: number;
+            info: number;
+        };
+        byCat: Record<string, any>;
+        files: any[];
+        score: number;
+        grade: string;
+        total: any;
+    };
+    stack: {
+        languages: Record<string, any>;
+        pm: any[];
+        items: any[];
+    };
+    tour: any[];
+    languages: {
+        id: string;
+        loc: unknown;
+        label: string;
+    }[];
+} & {
+    gitUrl?: string;
+    cloneDir?: string;
+    tempId?: string;
+}>;
+export declare function remoteUrlFor(repo: any): Promise<any>;
+export declare function closeRemote(repo: any): Promise<void>;
+export declare function openRepo(target?: string, options?: ScanOptions): Promise<{
+    root: string;
+    name: any;
+    scan: {
+        root: string;
+        name: any;
+        scannedAt: string;
+        stats: {
+            filesTotal: number;
+            filesParsed: number;
+            skipped: number;
+            skips: {
+                ignored: number;
+                vendorDir: number;
+                notSource: number;
+                listFailed: number;
+                notCode: number;
+                readFailed: number;
+                tooLarge: number;
+                analyzeFailed: number;
+            };
+            truncated: any;
+            edgeCount: number;
+            imports: {
+                total: number;
+                internal: number;
+                external: number;
+                unresolved: number;
+                confidence: number;
+                worst: any[];
+            };
+            tookMs: number;
+            languages: Record<string, number>;
+            languageLoc: Record<string, number>;
+        };
+        allFiles: string[];
+        files: import("../../shared/contracts.js").ScannedFile[];
+        edges: import("../../shared/contracts.js").ImportEdge[];
+        externals: {
+            name: any;
+            usedBy: any[];
+        }[];
+        folders: {
+            path: string;
+            name: string;
+            depth: number;
+            fileCount: number;
+            loc: number;
+            comment: number;
+            blank: number;
+            size: number;
+            langs: Record<string, number>;
+            hasReadme: boolean;
+            docRatio: number;
+        }[];
+        workflows: any[];
+        sbom: any;
+        license: any;
+        licenseReport: any;
+    } & {
+        tempId?: string;
+        gitUrl?: string;
+    };
+    facts: {
+        communities: {
+            id: any;
+            members: any;
+            size: any;
+        }[];
+        betweenness: {
+            [k: string]: number;
+        };
+        betweennessExact: boolean;
+        fanIn: any;
+        fanOut: any;
+        importers: any;
+        importsOf: any;
+        entries: any;
+        hubs: any;
+        orphans: any;
+        cycles: any[];
+        inCycle: unknown[];
+        deadExports: any[];
+        testCoverage: {
+            testedCount: number;
+            totalNonTest: any;
+            ratio: number;
+        };
+        untestedHubs: any;
+        depsDrift: {
+            unusedDeclared: string[];
+            undeclaredImported: string[];
+        };
+        folderEdges: {
+            from: any;
+            to: any;
+            count: any;
+        }[];
+        entrySet: any;
+    };
+    manifest: import("../../shared/contracts.js").Manifest;
+    searchIndex: {
+        index: Map<any, any>;
+        docCounts: Map<any, any>;
+        totalDocs: number;
+        totalBytes: number;
+        skipped: {
+            tooLarge: number;
+            overCap: number;
+            readFailed: number;
+            binary: number;
+            noTokens: number;
+        };
+        cap: {
+            maxFileBytes: number;
+            maxTotalBytes: number;
+        };
+    };
+    layers: {
+        layers: any[];
+        unreachable: any;
+        seeds: any;
+    };
+    coupling: {
+        folders: any[];
+        counts: Map<any, any>;
+        max: number;
+    };
+    health: {
+        score: number;
+        grade: string;
+        perFile: any[];
+        breakdown: any[];
+        blastExact: boolean;
+        totals: {
+            crit: number;
+            high: number;
+            avgCx: number;
+            orphanRatio: number;
+            cycles: number;
+        };
+        techDebtRatio?: undefined;
+        effortHours?: undefined;
+        debtCategory?: undefined;
+    } | {
+        score: number;
+        grade: string;
+        perFile: any;
+        breakdown: any[];
+        blastExact: boolean;
+        totals: {
+            crit: any;
+            high: any;
+            avgCx: number;
+            orphanRatio: number;
+            cycles: any;
+        };
+        techDebtRatio: number;
+        effortHours: number;
+        debtCategory: string;
+    };
+    patterns: any[];
+    security: {
+        counts: {
+            critical: number;
+            high: number;
+            medium: number;
+            low: number;
+            info: number;
+        };
+        byCat: Record<string, any>;
+        files: any[];
+        score: number;
+        grade: string;
+        total: any;
+    };
+    stack: {
+        languages: Record<string, any>;
+        pm: any[];
+        items: any[];
+    };
+    tour: any[];
+    languages: {
+        id: string;
+        loc: unknown;
+        label: string;
+    }[];
+} & {
+    gitUrl?: string;
+    cloneDir?: string;
+    tempId?: string;
+}>;
+export declare function resolveTarget(repo: any, typed: any): {
+    file?: undefined;
+    folder?: undefined;
+    error: string;
+    candidates?: undefined;
+} | {
+    folder?: undefined;
+    file: any;
+    error?: undefined;
+    candidates?: undefined;
+} | {
+    file?: undefined;
+    folder: any;
+    error?: undefined;
+    candidates?: undefined;
+} | {
+    file?: undefined;
+    folder?: undefined;
+    error: string;
+    candidates: any;
+};
+export declare function readRepoFile(repo: any, repoPath: any): Promise<string>;
+export declare function searchRepo(repo: any, query: any, { limit }?: Record<string, any>): {
+    results: any[];
+    total: number;
+    indexed: any;
+    capped: boolean;
+    advanced: any;
+    query: {
+        terms: any;
+        phrases: any;
+        negatives: any;
+        exts: any;
+        paths: any;
+        kinds: any;
+        isTest: any;
+        isSource: any;
+        regex: string;
+        caseSensitive: any;
+        advanced: any;
+    };
+    error: any;
+    stats: {
+        bytes: any;
+        skipped: any;
+        cap: any;
+    };
+};
+export declare function lineNumber(value: any, fallback: any): any;
+export declare function explainRepoFile(repo: any, file: any): string;
+export declare function explainRepoFolder(repo: any, folder: any): string;
+export declare function explainRepoOverview(repo: any): string;
+export declare function fileFacts(repo: any, file: any): {
+    role: string;
+    loc: any;
+    complexity: any;
+    fanIn: any;
+    fanOut: any;
+    inCycle: any;
+    findings: any;
+};