@codependix/file-imports 0.0.0-stage → 0.0.4

package/dist/src/index.js

@@ -0,0 +1,461 @@
+import { Injectable as e, Module as t } from "@nestjs/common";
+import { existsSync as n, readFileSync as r, readdirSync as i } from "node:fs";
+import a from "node:path";
+import o from "typescript";
+//#region packages/ic-suite/codependix/codependix-file-imports/src/modules/file-imports-workspace-graph/file-imports-workspace-graph.constants.ts
+var s = "_This workspace has no internal file imports, in any project._", c = "graph LR";
+//#endregion
+//#region \0@oxc-project+runtime@0.151.0/helpers/esm/decorateMetadata.js
+function l(e, t) {
+	if (typeof Reflect == "object" && typeof Reflect.metadata == "function") return Reflect.metadata(e, t);
+}
+//#endregion
+//#region \0@oxc-project+runtime@0.151.0/helpers/esm/decorate.js
+function u(e, t, n, r) {
+	var i = arguments.length, a = i < 3 ? t : r === null ? r = Object.getOwnPropertyDescriptor(t, n) : r, o;
+	if (typeof Reflect == "object" && typeof Reflect.decorate == "function") a = Reflect.decorate(e, t, n, r);
+	else for (var s = e.length - 1; s >= 0; s--) (o = e[s]) && (a = (i < 3 ? o(a) : i > 3 ? o(t, n, a) : o(t, n)) || a);
+	return i > 3 && a && Object.defineProperty(t, n, a), a;
+}
+//#endregion
+//#region packages/ic-suite/codependix/codependix-file-imports/src/modules/file-imports-workspace-graph/file-imports-workspace-graph.service.ts
+var d = class {
+	constructor() {}
+	compareEdges(e, t) {
+		return e.source.localeCompare(t.source) || e.target.localeCompare(t.target);
+	}
+	qualifyFileName(e, t) {
+		return `${e}/${t}`;
+	}
+	renderNode(e) {
+		return `  ${this.toNodeIdentifier(e)}["${e}"]`;
+	}
+	sortNames(e) {
+		return [...e].toSorted((e, t) => e.localeCompare(t));
+	}
+	toNodeIdentifier(e) {
+		return `file_${e.replaceAll(/[^\dA-Za-z]/gu, "_")}`;
+	}
+	buildWorkspaceGraph(e) {
+		let t = [...e.typescriptGraphs, ...e.pythonGraphs], n = this.sortNames(t.flatMap((e) => e.fileNames.map((t) => this.qualifyFileName(e.projectName, t))));
+		return {
+			edges: t.flatMap((e) => e.edges.map((t) => ({
+				source: this.qualifyFileName(e.projectName, t.source),
+				target: this.qualifyFileName(e.projectName, t.target)
+			}))).toSorted((e, t) => this.compareEdges(e, t)),
+			fileNames: n
+		};
+	}
+	renderMermaid(e) {
+		return e.edges.length === 0 ? s : [
+			"```mermaid",
+			c,
+			...e.fileNames.map((e) => this.renderNode(e)),
+			...e.edges.map((e) => `  ${this.toNodeIdentifier(e.source)} --> ${this.toNodeIdentifier(e.target)}`),
+			"```"
+		].join("\n");
+	}
+};
+d = u([e(), l("design:paramtypes", [])], d);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-file-imports/src/modules/file-imports-workspace-graph/file-imports-workspace-graph.module.ts
+var f = class {};
+f = u([t({
+	controllers: [],
+	exports: [d],
+	imports: [],
+	providers: [d]
+})], f);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-file-imports/src/modules/python/python-import-parser.constants.ts
+var p = /^from\s+(?<dots>\.*)(?<modulePath>[\w.]*)\s+import\s+.+$/u, m = /^import\s+(?<specifiers>.+)$/u, h = /^(?<modulePath>[\w.]+)/u, g = /^(?:from|import)\b/u, _ = class {
+	constructor() {}
+	collectStatement(e, t) {
+		let n = 0, r = [], i = t;
+		for (;;) {
+			/* v8 ignore next -- index only ever advances past the last checked
+			bound right before the loop breaks, so it is always in range here */
+			let t = this.stripComment(e[i] ?? "");
+			n += this.countCharacter(t, "(") - this.countCharacter(t, ")");
+			let a = t.trimEnd().endsWith("\\"), o = a ? t.trimEnd().slice(0, -1) : t;
+			if (r.push(o.trim()), i += 1, n <= 0 && !a || i >= e.length) break;
+		}
+		return {
+			nextIndex: i,
+			statement: r.join(" ")
+		};
+	}
+	countCharacter(e, t) {
+		return e.split(t).length - 1;
+	}
+	isTopLevelImportStart(e) {
+		return this.measureIndent(e) === 0 && g.test(this.stripComment(e).trim());
+	}
+	measureIndent(e) {
+		return e.length - e.trimStart().length;
+	}
+	parseFromStatement(e) {
+		let t = p.exec(e);
+		if (t?.groups === void 0) return [];
+		/* v8 ignore next 2 -- both named groups always participate in a
+		successful match, even as an empty string, so they are never undefined */
+		let n = t.groups.dots ?? "", r = t.groups.modulePath ?? "";
+		return [{
+			level: n.length,
+			modulePath: r
+		}];
+	}
+	parseImportStatement(e) {
+		let t = m.exec(e);
+		return t?.groups === void 0 ? [] : (t.groups.specifiers ?? "").split(",").map((e) => h.exec(e.trim())?.groups?.modulePath).filter((e) => e !== void 0).map((e) => ({
+			level: 0,
+			modulePath: e
+		}));
+	}
+	parseStatement(e) {
+		return e.startsWith("from") ? this.parseFromStatement(e) : this.parseImportStatement(e);
+	}
+	stripComment(e) {
+		let t;
+		for (let n = 0; n < e.length; n += 1) {
+			let r = e[n];
+			if (t !== void 0) {
+				r === t && e[n - 1] !== "\\" && (t = void 0);
+				continue;
+			}
+			if (r === "'" || r === "\"") {
+				t = r;
+				continue;
+			}
+			if (r === "#") return e.slice(0, n);
+		}
+		return e;
+	}
+	parseImportSpecifiers(e) {
+		let t = e.split("\n"), n = [], r = 0;
+		for (; r < t.length;) {
+			/* v8 ignore next -- the loop condition already guards index in range */
+			let e = t[r] ?? "";
+			if (!this.isTopLevelImportStart(e)) {
+				r += 1;
+				continue;
+			}
+			let { nextIndex: i, statement: a } = this.collectStatement(t, r);
+			n.push(...this.parseStatement(a)), r = i;
+		}
+		return n;
+	}
+};
+_ = u([e(), l("design:paramtypes", [])], _);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-file-imports/src/modules/python/python.constants.ts
+var v = "__init__.py", y = "graph LR", b = "_This project has no internal file imports._", x = /* @__PURE__ */ new Set([
+	".git",
+	".mypy_cache",
+	".pytest_cache",
+	".ruff_cache",
+	".venv",
+	"__pycache__",
+	"node_modules"
+]), S = "language:python", C = class {
+	constructor() {}
+	listSourceFilesInDirectory(e) {
+		let t = [];
+		for (let n of i(e, { withFileTypes: !0 })) {
+			let r = a.join(e, n.name);
+			if (n.isDirectory()) {
+				if (x.has(n.name)) continue;
+				t.push(...this.listSourceFilesInDirectory(r));
+			} else n.name.endsWith(".py") && t.push(r);
+		}
+		return t;
+	}
+	describeProject(e, t) {
+		return {
+			absoluteRoot: e,
+			name: t
+		};
+	}
+	discoverProjects(e) {
+		return e.filter((e) => this.isPythonProject(e)).map((e) => this.describeProject(e.absoluteRoot, e.name));
+	}
+	isPythonProject(e) {
+		return e.tags.includes(S);
+	}
+	listSourceFileNames(e) {
+		return this.listSourceFilesInDirectory(e.absoluteRoot).toSorted((e, t) => e.localeCompare(t));
+	}
+};
+C = u([e(), l("design:paramtypes", [])], C);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-file-imports/src/modules/python/python-import-graph.service.ts
+var w = class {
+	pythonImportParserService;
+	pythonProjectService;
+	constructor(e, t) {
+		this.pythonImportParserService = e, this.pythonProjectService = t;
+	}
+	ascendDirectories(e, t) {
+		let n = e;
+		for (let e = 0; e < t; e += 1) n = a.dirname(n);
+		return n;
+	}
+	collectEdgesForFile(e) {
+		let { ownedFileNames: t, project: n, sourceFileName: i } = e, a = this.pythonImportParserService.parseImportSpecifiers(r(i, "utf8")), o = [];
+		for (let e of a) {
+			let r = this.resolveSpecifierPath({
+				containingFileName: i,
+				project: n,
+				specifier: e
+			});
+			r !== void 0 && t.has(r) && r !== i && o.push({
+				source: this.toRelativePath(n, i),
+				target: this.toRelativePath(n, r)
+			});
+		}
+		return o;
+	}
+	compareEdges(e, t) {
+		return e.source.localeCompare(t.source) || e.target.localeCompare(t.target);
+	}
+	dedupeEdges(e) {
+		let t = /* @__PURE__ */ new Map();
+		for (let n of e) t.set(`${n.source}->${n.target}`, n);
+		return [...t.values()].toSorted((e, t) => this.compareEdges(e, t));
+	}
+	renderNode(e) {
+		return `  ${this.toNodeIdentifier(e)}["${e}"]`;
+	}
+	resolveSpecifierPath(e) {
+		let { containingFileName: t, project: r, specifier: i } = e, o = i.level === 0 ? r.absoluteRoot : this.ascendDirectories(a.dirname(t), i.level - 1), s = i.modulePath.length === 0 ? [] : i.modulePath.split("."), c = a.join(o, ...s);
+		if (s.length > 0) {
+			let e = `${c}.py`;
+			if (n(e)) return e;
+		}
+		let l = a.join(c, v);
+		return n(l) ? l : void 0;
+	}
+	toNodeIdentifier(e) {
+		return `file_${e.replaceAll(/[^\dA-Za-z]/gu, "_")}`;
+	}
+	toRelativePath(e, t) {
+		return a.relative(e.absoluteRoot, t).split(a.sep).join("/");
+	}
+	buildGraph(e) {
+		let t = this.pythonProjectService.listSourceFileNames(e), n = new Set(t), r = this.dedupeEdges(t.flatMap((t) => this.collectEdgesForFile({
+			ownedFileNames: n,
+			project: e,
+			sourceFileName: t
+		}))), i = new Set(r.flatMap((e) => [e.source, e.target])), a = t.map((t) => this.toRelativePath(e, t)).toSorted((e, t) => e.localeCompare(t));
+		return {
+			edges: r,
+			fileNames: a,
+			isolatedFileNames: a.filter((e) => !i.has(e)),
+			projectName: e.name
+		};
+	}
+	renderMermaid(e) {
+		return e.edges.length === 0 ? b : [
+			"```mermaid",
+			y,
+			...e.fileNames.map((e) => this.renderNode(e)),
+			...e.edges.map((e) => `  ${this.toNodeIdentifier(e.source)} --> ${this.toNodeIdentifier(e.target)}`),
+			"```"
+		].join("\n");
+	}
+};
+w = u([e(), l("design:paramtypes", [_ === void 0 ? Object : _, C === void 0 ? Object : C])], w);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-file-imports/src/modules/python/python.service.ts
+var T = class {
+	pythonImportGraphService;
+	pythonProjectService;
+	constructor(e, t) {
+		this.pythonImportGraphService = e, this.pythonProjectService = t;
+	}
+	buildGraph(e) {
+		return this.pythonImportGraphService.buildGraph(e);
+	}
+	discoverProjects(e) {
+		return this.pythonProjectService.discoverProjects(e);
+	}
+	renderMermaid(e) {
+		return this.pythonImportGraphService.renderMermaid(e);
+	}
+};
+T = u([e(), l("design:paramtypes", [w === void 0 ? Object : w, C === void 0 ? Object : C])], T);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-file-imports/src/modules/python/python.module.ts
+var E = class {};
+E = u([t({
+	controllers: [],
+	exports: [T],
+	imports: [],
+	providers: [
+		w,
+		_,
+		C,
+		T
+	]
+})], E);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-file-imports/src/modules/typescript/typescript.constants.ts
+var D = ".d.ts", O = "graph LR", k = "_This project has no internal file imports._", A = "tsconfig.json", j = class extends Error {
+	constructor(e) {
+		super(`Could not read ${e.configurationPath}: ${e.messages.join("; ")}`), this.name = "TypescriptProjectConfigurationError";
+	}
+}, M = class {
+	constructor() {}
+	parseConfiguration(e) {
+		let t = o.readJsonConfigFile(e.tsconfigPath, (e) => o.sys.readFile(e)), n = o.parseJsonSourceFileConfigFileContent(t, o.sys, a.dirname(e.tsconfigPath), void 0, e.tsconfigPath);
+		if (n.errors.length > 0) throw new j({
+			configurationPath: e.tsconfigPath,
+			messages: n.errors.map((e) => o.flattenDiagnosticMessageText(e.messageText, " "))
+		});
+		return n;
+	}
+	buildProgram(e) {
+		let t = this.parseConfiguration(e), n = o.createCompilerHost(t.options, !0), r = o.createProgram({
+			host: n,
+			options: t.options,
+			rootNames: t.fileNames
+		});
+		return {
+			host: n,
+			options: t.options,
+			program: r,
+			project: e
+		};
+	}
+	describeProject(e, t) {
+		return {
+			absoluteRoot: e,
+			name: t,
+			tsconfigPath: a.join(e, A)
+		};
+	}
+	discoverProjects(e) {
+		return e.filter((e) => n(a.join(e.absoluteRoot, A))).map((e) => this.describeProject(e.absoluteRoot, e.name));
+	}
+	toRealPath(e) {
+		return o.sys.realpath === void 0 ? e : o.sys.realpath(e);
+	}
+};
+M = u([e(), l("design:paramtypes", [])], M);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-file-imports/src/modules/typescript/typescript-import-graph.service.ts
+var N = class {
+	typescriptProjectService;
+	constructor(e) {
+		this.typescriptProjectService = e;
+	}
+	collectEdgesForFile(e) {
+		let { ownedFileNames: t, projectProgram: n, sourceFileName: r } = e, i = n.program.getSourceFile(r);
+		/* v8 ignore next -- sourceFileName always comes from this same program's
+		own root file names, so the program always has a source file for it */
+		if (i === void 0) return [];
+		let a = [];
+		for (let e of i.statements) {
+			/* v8 ignore next -- an ImportDeclaration's moduleSpecifier is always a
+			string literal by grammar; the guard only narrows the type */
+			if (!o.isImportDeclaration(e) || !o.isStringLiteral(e.moduleSpecifier)) continue;
+			let i = this.resolveImportTarget({
+				containingFileName: r,
+				projectProgram: n,
+				specifier: e.moduleSpecifier.text
+			});
+			i !== void 0 && t.has(i) && i !== r && a.push({
+				source: this.toRelativePath(n, r),
+				target: this.toRelativePath(n, i)
+			});
+		}
+		return a;
+	}
+	compareEdges(e, t) {
+		return e.source.localeCompare(t.source) || e.target.localeCompare(t.target);
+	}
+	dedupeEdges(e) {
+		let t = /* @__PURE__ */ new Map();
+		for (let n of e) t.set(`${n.source}->${n.target}`, n);
+		return [...t.values()].toSorted((e, t) => this.compareEdges(e, t));
+	}
+	listOwnedSourceFileNames(e) {
+		return [...this.resolveOwnedFileNames(e)].filter((e) => !e.endsWith(D)).toSorted((e, t) => e.localeCompare(t));
+	}
+	renderNode(e) {
+		return `  ${this.toNodeIdentifier(e)}["${e}"]`;
+	}
+	resolveImportTarget(e) {
+		let { containingFileName: t, projectProgram: n, specifier: r } = e, i = o.resolveModuleName(r, t, n.options, n.host).resolvedModule?.resolvedFileName;
+		return i === void 0 ? void 0 : this.typescriptProjectService.toRealPath(i);
+	}
+	resolveOwnedFileNames(e) {
+		return new Set(e.program.getRootFileNames().map((e) => this.typescriptProjectService.toRealPath(e)));
+	}
+	toNodeIdentifier(e) {
+		return `file_${e.replaceAll(/[^\dA-Za-z]/gu, "_")}`;
+	}
+	toRelativePath(e, t) {
+		return a.relative(e.project.absoluteRoot, t).split(a.sep).join("/");
+	}
+	buildGraph(e) {
+		let t = this.resolveOwnedFileNames(e), n = this.listOwnedSourceFileNames(e), r = this.dedupeEdges(n.flatMap((n) => this.collectEdgesForFile({
+			ownedFileNames: t,
+			projectProgram: e,
+			sourceFileName: n
+		}))), i = new Set(r.flatMap((e) => [e.source, e.target])), a = n.map((t) => this.toRelativePath(e, t)).toSorted((e, t) => e.localeCompare(t));
+		return {
+			edges: r,
+			fileNames: a,
+			isolatedFileNames: a.filter((e) => !i.has(e)),
+			projectName: e.project.name
+		};
+	}
+	renderMermaid(e) {
+		return e.edges.length === 0 ? k : [
+			"```mermaid",
+			O,
+			...e.fileNames.map((e) => this.renderNode(e)),
+			...e.edges.map((e) => `  ${this.toNodeIdentifier(e.source)} --> ${this.toNodeIdentifier(e.target)}`),
+			"```"
+		].join("\n");
+	}
+};
+N = u([e(), l("design:paramtypes", [M === void 0 ? Object : M])], N);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-file-imports/src/modules/typescript/typescript.service.ts
+var P = class {
+	typescriptImportGraphService;
+	typescriptProjectService;
+	constructor(e, t) {
+		this.typescriptImportGraphService = e, this.typescriptProjectService = t;
+	}
+	buildGraph(e) {
+		return this.typescriptImportGraphService.buildGraph(e);
+	}
+	buildProgram(e) {
+		return this.typescriptProjectService.buildProgram(e);
+	}
+	discoverProjects(e) {
+		return this.typescriptProjectService.discoverProjects(e);
+	}
+	renderMermaid(e) {
+		return this.typescriptImportGraphService.renderMermaid(e);
+	}
+};
+P = u([e(), l("design:paramtypes", [N === void 0 ? Object : N, M === void 0 ? Object : M])], P);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-file-imports/src/modules/typescript/typescript.module.ts
+var F = class {};
+F = u([t({
+	controllers: [],
+	exports: [P],
+	imports: [],
+	providers: [
+		N,
+		M,
+		P
+	]
+})], F);
+//#endregion
+export { c as FILE_IMPORTS_WORKSPACE_GRAPH_MERMAID_HEADER, s as FILE_IMPORTS_WORKSPACE_GRAPH_UNCONNECTED, f as FileImportsWorkspaceGraphModule, d as FileImportsWorkspaceGraphService, w as PythonImportGraphService, _ as PythonImportParserService, E as PythonModule, C as PythonProjectService, T as PythonService, N as TypescriptImportGraphService, F as TypescriptModule, M as TypescriptProjectService, P as TypescriptService };

package/package.json

@@ -1,6 +1,64 @@
 {
+  "author": "Jimmy Paolini",
+  "bugs": {
+    "url": "https://github.com/organizzolini/codebase/issues"
+  },
+  "dependencies": {
+    "@nestjs/common": "^11.1.21 || ^12.0.1",
+    "reflect-metadata": "^0.2.2"
+  },
+  "description": "TypeScript and JavaScript file-level import graph extraction and circularity detection for Codependix",
+  "devDependencies": {
+    "@golevelup/ts-vitest": "^4.0.0",
+    "@nestjs/testing": "^12.0.1",
+    "@nx/eslint-plugin": "^23.0.0",
+    "@swc/helpers": "^0.5.21",
+    "@types/node": "^26.5.1",
+    "@vitest/coverage-v8": "^5.0.0",
+    "typescript": "^6.0.3",
+    "vitest": "^5.0.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/src/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "CHANGELOG.md",
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "homepage": "https://github.com/organizzolini/codebase/tree/main/packages/ic-suite/codependix/codependix-file-imports#readme",
+  "keywords": [
+    "circular-dependency",
+    "codependix",
+    "file-dependencies",
+    "import-graph",
+    "typescript"
+  ],
+  "license": "MIT",
+  "main": "./dist/src/index.js",
   "name": "@codependix/file-imports",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "peerDependencies": {
+    "typescript": "^6.0.3"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "directory": "packages/ic-suite/codependix/codependix-file-imports",
+    "type": "git",
+    "url": "git+https://github.com/organizzolini/codebase.git"
+  },
+  "type": "module",
+  "typeCoverage": {
+    "atLeast": 100,
+    "strict": true
+  },
+  "types": "./dist/src/index.d.ts",
+  "version": "0.0.4"
 }