tdepend 0.2.0 → 0.3.1

package/dist/index.js

@@ -1,41 +1,18 @@
 "use strict";
 /**
- * TDepend - TypeScript Dependency Analysis Library
+ * tdepend: executable architecture contracts for TypeScript.
  *
- * A JDepend-inspired dependency analysis tool for TypeScript projects.
- * Computes architectural metrics and detects dependency issues.
- *
- * @packageDocumentation
+ * The public surface is the four high-level functions below plus their types.
+ * Discovery, resolution and graph helpers stay internal.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultConfig = exports.formatJsonOutput = exports.generateReport = exports.loadConfig = exports.scanFiles = exports.parseFile = exports.parseProject = exports.computeAllMetrics = exports.detectCycles = exports.DependencyGraph = exports.toSerializable = exports.exportToJson = exports.exportToFile = exports.analyzeWithConfig = exports.analyze = void 0;
-// High-level API - Primary interface for library users
+exports.toSerializable = exports.exportToFile = exports.explainFile = exports.analyze = void 0;
 var analyze_1 = require("./api/analyze");
 Object.defineProperty(exports, "analyze", { enumerable: true, get: function () { return analyze_1.analyze; } });
-Object.defineProperty(exports, "analyzeWithConfig", { enumerable: true, get: function () { return analyze_1.analyzeWithConfig; } });
+var explain_1 = require("./api/explain");
+Object.defineProperty(exports, "explainFile", { enumerable: true, get: function () { return explain_1.explainFile; } });
 var export_1 = require("./api/export");
 Object.defineProperty(exports, "exportToFile", { enumerable: true, get: function () { return export_1.exportToFile; } });
-Object.defineProperty(exports, "exportToJson", { enumerable: true, get: function () { return export_1.exportToJson; } });
 var serialization_1 = require("./api/serialization");
 Object.defineProperty(exports, "toSerializable", { enumerable: true, get: function () { return serialization_1.toSerializable; } });
-// Core building blocks - For advanced users who want fine-grained control
-var dependencyGraph_1 = require("./graph/dependencyGraph");
-Object.defineProperty(exports, "DependencyGraph", { enumerable: true, get: function () { return dependencyGraph_1.DependencyGraph; } });
-var cycleDetector_1 = require("./graph/cycleDetector");
-Object.defineProperty(exports, "detectCycles", { enumerable: true, get: function () { return cycleDetector_1.detectCycles; } });
-var metrics_1 = require("./metrics");
-Object.defineProperty(exports, "computeAllMetrics", { enumerable: true, get: function () { return metrics_1.computeAllMetrics; } });
-var tsParser_1 = require("./parser/tsParser");
-Object.defineProperty(exports, "parseProject", { enumerable: true, get: function () { return tsParser_1.parseProject; } });
-Object.defineProperty(exports, "parseFile", { enumerable: true, get: function () { return tsParser_1.parseFile; } });
-var fileScanner_1 = require("./parser/fileScanner");
-Object.defineProperty(exports, "scanFiles", { enumerable: true, get: function () { return fileScanner_1.scanFiles; } });
-var loadConfig_1 = require("./config/loadConfig");
-Object.defineProperty(exports, "loadConfig", { enumerable: true, get: function () { return loadConfig_1.loadConfig; } });
-var reporter_1 = require("./analysis/reporter");
-Object.defineProperty(exports, "generateReport", { enumerable: true, get: function () { return reporter_1.generateReport; } });
-Object.defineProperty(exports, "formatJsonOutput", { enumerable: true, get: function () { return reporter_1.formatJsonOutput; } });
-// Configuration - Useful for customization
-var schema_1 = require("./config/schema");
-Object.defineProperty(exports, "defaultConfig", { enumerable: true, get: function () { return schema_1.defaultConfig; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAEH,uDAAuD;AACvD,yCAA2D;AAAlD,kGAAA,OAAO,OAAA;AAAE,4GAAA,iBAAiB,OAAA;AAGnC,uCAA0D;AAAjD,sGAAA,YAAY,OAAA;AAAE,sGAAA,YAAY,OAAA;AAGnC,qDAAqD;AAA5C,+GAAA,cAAc,OAAA;AAEvB,0EAA0E;AAC1E,2DAA0D;AAAjD,kHAAA,eAAe,OAAA;AACxB,uDAAqD;AAA5C,6GAAA,YAAY,OAAA;AACrB,qCAA8C;AAArC,4GAAA,iBAAiB,OAAA;AAC1B,8CAA4D;AAAnD,wGAAA,YAAY,OAAA;AAAE,qGAAA,SAAS,OAAA;AAChC,oDAAiD;AAAxC,wGAAA,SAAS,OAAA;AAClB,kDAAiD;AAAxC,wGAAA,UAAU,OAAA;AACnB,gDAAuE;AAA9D,0GAAA,cAAc,OAAA;AAAE,4GAAA,gBAAgB,OAAA;AAezC,2CAA2C;AAC3C,0CAAgD;AAAvC,uGAAA,aAAa,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,yCAAwC;AAA/B,kGAAA,OAAO,OAAA;AAGhB,yCAA4C;AAAnC,sGAAA,WAAW,OAAA;AAGpB,uCAA4C;AAAnC,sGAAA,YAAY,OAAA;AAErB,qDAAqD;AAA5C,+GAAA,cAAc,OAAA"}

package/dist/output/analyzeText.d.ts

@@ -0,0 +1,7 @@
+import type { AnalysisResult } from '../types/api';
+/**
+ * Renders the human-readable `analyze` report: a summary line set, the
+ * unresolved imports with `path:line`, the ignored (gitignored) target
+ * directories, and the unsupported, self-import and uncovered-file counts.
+ */
+export declare function formatAnalyzeText(result: AnalysisResult): string;

package/dist/output/analyzeText.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatAnalyzeText = formatAnalyzeText;
+const serialization_1 = require("../api/serialization");
+const MAX_UNRESOLVED = 20;
+const MAX_IGNORED_DIRS = 10;
+/**
+ * Renders the human-readable `analyze` report: a summary line set, the
+ * unresolved imports with `path:line`, the ignored (gitignored) target
+ * directories, and the unsupported, self-import and uncovered-file counts.
+ */
+function formatAnalyzeText(result) {
+    const sections = [
+        summaryLines(result),
+        classLines(result),
+        unresolvedLines(result),
+        ignoredLines(result),
+        unsupportedLines(result),
+        [
+            `Self-imports: ${result.report.selfImports.length}`,
+            `Files outside every tsconfig: ${result.files.uncovered.length}`,
+        ],
+        notInstalledLines(result),
+        warningLines(result),
+    ].filter((lines) => lines.length > 0);
+    return `${sections.map((lines) => lines.join('\n')).join('\n\n')}\n`;
+}
+function summaryLines(result) {
+    return [
+        `Files: ${result.files.files.length}`,
+        `Import sites: ${result.sites.length}`,
+        `Edges: ${result.graph.edges().length}`,
+    ];
+}
+function classLines(result) {
+    const lines = ['Sites by class:'];
+    for (const [name, count] of Object.entries(result.report.stats)) {
+        lines.push(`  ${name}: ${count}`);
+    }
+    return lines;
+}
+function unsupportedLines(result) {
+    const byReason = new Map();
+    for (const record of result.report.unsupported) {
+        const reason = record.resolution.reason ?? 'unknown';
+        byReason.set(reason, (byReason.get(reason) ?? 0) + 1);
+    }
+    const lines = [`Unsupported imports: ${result.report.unsupported.length}`];
+    for (const [reason, count] of [...byReason.entries()].sort()) {
+        lines.push(`  ${reason}: ${count}`);
+    }
+    return lines;
+}
+function notInstalledLines(result) {
+    const count = result.sites.filter((record) => record.resolution.class === 'external' && record.resolution.reason === 'not-installed').length;
+    if (count === 0)
+        return [];
+    return [`Declared packages not found: ${count} (is node_modules installed?)`];
+}
+function warningLines(result) {
+    const warnings = (0, serialization_1.discoveryWarnings)(result);
+    if (warnings.length === 0)
+        return [];
+    return ['Warnings:', ...warnings.map((warning) => `  ${warning}`)];
+}
+function unresolvedLines(result) {
+    const { unresolved } = result.report;
+    const lines = [`Unresolved imports (${unresolved.length}):`];
+    for (const record of unresolved.slice(0, MAX_UNRESOLVED)) {
+        lines.push(`  ${record.file}:${record.site.line}  ${record.site.specifier}`);
+    }
+    if (unresolved.length > MAX_UNRESOLVED) {
+        lines.push(`  ... and ${unresolved.length - MAX_UNRESOLVED} more`);
+    }
+    return lines;
+}
+function ignoredLines(result) {
+    const entries = Object.entries(result.report.ignoredByDir).sort(compareIgnored);
+    const total = entries.reduce((sum, [, count]) => sum + count, 0);
+    const lines = [`Ignored (gitignored targets): ${total}`];
+    for (const [dir, count] of entries.slice(0, MAX_IGNORED_DIRS)) {
+        lines.push(`  ${dir} (${count})`);
+    }
+    return lines;
+}
+function compareIgnored(a, b) {
+    if (a[1] !== b[1])
+        return b[1] - a[1];
+    return a[0] < b[0] ? -1 : a[0] > b[0] ? 1 : 0;
+}
+//# sourceMappingURL=analyzeText.js.map

package/dist/output/analyzeText.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyzeText.js","sourceRoot":"","sources":["../../src/output/analyzeText.ts"],"names":[],"mappings":";;AAWA,8CAgBC;AA3BD,wDAAyD;AAGzD,MAAM,cAAc,GAAG,EAAE,CAAC;AAC1B,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAE5B;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,MAAsB;IACtD,MAAM,QAAQ,GAAG;QACf,YAAY,CAAC,MAAM,CAAC;QACpB,UAAU,CAAC,MAAM,CAAC;QAClB,eAAe,CAAC,MAAM,CAAC;QACvB,YAAY,CAAC,MAAM,CAAC;QACpB,gBAAgB,CAAC,MAAM,CAAC;QACxB;YACE,iBAAiB,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE;YACnD,iCAAiC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE;SACjE;QACD,iBAAiB,CAAC,MAAM,CAAC;QACzB,YAAY,CAAC,MAAM,CAAC;KACrB,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAEtC,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;AACvE,CAAC;AAED,SAAS,YAAY,CAAC,MAAsB;IAC1C,OAAO;QACL,UAAU,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE;QACrC,iBAAiB,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE;QACtC,UAAU,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE;KACxC,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,MAAsB;IACxC,MAAM,KAAK,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAClC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QAChE,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAsB;IAC9C,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC3C,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAC/C,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,IAAI,SAAS,CAAC;QACrD,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACxD,CAAC;IACD,MAAM,KAAK,GAAG,CAAC,wBAAwB,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3E,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QAC7D,KAAK,CAAC,IAAI,CAAC,KAAK,MAAM,KAAK,KAAK,EAAE,CAAC,CAAC;IACtC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAsB;IAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAC/B,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,KAAK,UAAU,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,KAAK,eAAe,CACnG,CAAC,MAAM,CAAC;IACT,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAC3B,OAAO,CAAC,gCAAgC,KAAK,+BAA+B,CAAC,CAAC;AAChF,CAAC;AAED,SAAS,YAAY,CAAC,MAAsB;IAC1C,MAAM,QAAQ,GAAG,IAAA,iCAAiB,EAAC,MAAM,CAAC,CAAC;IAC3C,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACrC,OAAO,CAAC,WAAW,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC,CAAC;AACrE,CAAC;AAED,SAAS,eAAe,CAAC,MAAsB;IAC7C,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC;IACrC,MAAM,KAAK,GAAG,CAAC,uBAAuB,UAAU,CAAC,MAAM,IAAI,CAAC,CAAC;IAE7D,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,EAAE,CAAC;QACzD,KAAK,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IAC/E,CAAC;IACD,IAAI,UAAU,CAAC,MAAM,GAAG,cAAc,EAAE,CAAC;QACvC,KAAK,CAAC,IAAI,CAAC,aAAa,UAAU,CAAC,MAAM,GAAG,cAAc,OAAO,CAAC,CAAC;IACrE,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,YAAY,CAAC,MAAsB;IAC1C,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAChF,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC;IACjE,MAAM,KAAK,GAAG,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAC;IAEzD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,EAAE,CAAC;QAC9D,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,KAAK,GAAG,CAAC,CAAC;IACpC,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,cAAc,CAAC,CAAmB,EAAE,CAAmB;IAC9D,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAAE,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAChD,CAAC"}

package/dist/parser/extractSites.d.ts

@@ -0,0 +1,3 @@
+import * as ts from 'typescript';
+import type { ParsedFile } from './types';
+export declare function parseFile(file: string, text: string, options: ts.CompilerOptions, absolutePath?: string): ParsedFile;