@codependix/nestjs-modules 0.0.3

package/dist/src/index.js

@@ -0,0 +1,438 @@
+import { ConsoleLogger as e, Global as t, Injectable as n, Module as r, Scope as i } from "@nestjs/common";
+import a from "node:path";
+import { existsSync as o, mkdirSync as s, readdirSync as c } from "node:fs";
+import l from "pino";
+import { pathToFileURL as u } from "node:url";
+import { ModulesContainer as d, NestFactory as f } from "@nestjs/core";
+import { ConfigModule as p } from "@nestjs/config";
+//#region packages/ic-suite/codependix/codependix-nestjs-modules/src/modules/module-graph/module-graph.constants.ts
+var m = "_This project defines no NestJS modules to graph._", h = "flowchart LR", g = "_Rounded modules are global: every module can inject them, so their edges are left out._", _ = 4;
+//#endregion
+//#region \0@oxc-project+runtime@0.151.0/helpers/esm/decorateMetadata.js
+function v(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 y(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-nestjs-modules/src/modules/module-graph/module-graph.service.ts
+var b = class {
+	constructor() {}
+	collectEdgesAndNodes(e, t) {
+		let n = [], r = /* @__PURE__ */ new Set(), i = [], a = (e, t) => {
+			n.some((n) => n.name === e && n.declaringFile === t) || n.push({
+				declaringFile: t,
+				name: e
+			});
+		};
+		for (let t of e) a(t.name, t.declaringFile ?? "");
+		for (let n of e) for (let o of n.imports) t.has(o) || (i.push({
+			source: n.name,
+			target: o
+		}), r.add(n.name), r.add(o), a(o, e.find((e) => e.name === o)?.declaringFile ?? ""));
+		return {
+			connectedModuleNames: r,
+			edges: i,
+			nodes: n
+		};
+	}
+	compareEdges(e, t) {
+		return e.source.localeCompare(t.source) || e.target.localeCompare(t.target);
+	}
+	compareNodes(e, t) {
+		return e.name.localeCompare(t.name) || e.declaringFile.localeCompare(t.declaringFile);
+	}
+	countInboundEdges(e) {
+		let t = /* @__PURE__ */ new Map();
+		for (let n of e) for (let e of n.imports) t.set(e, (t.get(e) ?? 0) + 1);
+		return t;
+	}
+	findAmbientModuleNames(e) {
+		let t = /* @__PURE__ */ new Set();
+		if (e.length < 4) return t;
+		for (let [n, r] of this.countInboundEdges(e)) r >= e.length - 1 && t.add(n);
+		return t;
+	}
+	renderNode(e, t) {
+		return t.ambientModuleNames.includes(e) ? `${e}([${e}])` : e;
+	}
+	sortNames(e) {
+		return [...e].toSorted((e, t) => e.localeCompare(t));
+	}
+	buildGraph(e, t) {
+		let n = this.findAmbientModuleNames(e), { connectedModuleNames: r, edges: i, nodes: a } = this.collectEdgesAndNodes(e, n), o = a.toSorted((e, t) => this.compareNodes(e, t)), s = this.sortNames(new Set(o.map((e) => e.name)));
+		return {
+			ambientModuleNames: this.sortNames(n),
+			edges: i.toSorted((e, t) => this.compareEdges(e, t)),
+			isolatedModuleNames: s.filter((e) => !r.has(e)),
+			nodes: o,
+			projectName: t
+		};
+	}
+	deriveModuleFolder(e) {
+		return a.posix.dirname(e.declaringFile.replaceAll("\\", "/"));
+	}
+	renderMermaid(e) {
+		if (e.nodes.length === 0) return m;
+		let t = [
+			"```mermaid",
+			h,
+			...e.nodes.map((t) => `  ${this.renderNode(t.name, e)}`),
+			...e.edges.map((e) => `  ${e.source} --> ${e.target}`),
+			"```"
+		];
+		return e.ambientModuleNames.length > 0 && t.push("", g), t.join("\n");
+	}
+};
+b = y([n(), v("design:paramtypes", [])], b);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-nestjs-modules/src/modules/module-graph/module-graph.module.ts
+var x = class {};
+x = y([r({
+	controllers: [],
+	exports: [b],
+	imports: [],
+	providers: [b]
+})], x);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-nestjs-modules/src/modules/nestjs-modules-workspace-graph/nestjs-modules-workspace-graph.constants.ts
+var S = "_This workspace has no NestJS modules, in any project._", C = "graph LR", w = class {
+	constructor() {}
+	compareEdges(e, t) {
+		return e.source.localeCompare(t.source) || e.target.localeCompare(t.target);
+	}
+	qualifyModuleName(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 `module_${e.replaceAll(/[^\dA-Za-z]/gu, "_")}`;
+	}
+	buildWorkspaceGraph(e) {
+		let t = this.sortNames(e.flatMap((e) => e.nodes.map((t) => this.qualifyModuleName(e.projectName, t.name))));
+		return {
+			edges: e.flatMap((e) => e.edges.map((t) => ({
+				source: this.qualifyModuleName(e.projectName, t.source),
+				target: this.qualifyModuleName(e.projectName, t.target)
+			}))).toSorted((e, t) => this.compareEdges(e, t)),
+			moduleNames: t
+		};
+	}
+	renderMermaid(e) {
+		return e.edges.length === 0 ? S : [
+			"```mermaid",
+			C,
+			...e.moduleNames.map((e) => this.renderNode(e)),
+			...e.edges.map((e) => `  ${this.toNodeIdentifier(e.source)} --> ${this.toNodeIdentifier(e.target)}`),
+			"```"
+		].join("\n");
+	}
+};
+w = y([n(), v("design:paramtypes", [])], w);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-nestjs-modules/src/modules/nestjs-modules-workspace-graph/nestjs-modules-workspace-graph.module.ts
+var T = class {};
+T = y([r({
+	controllers: [],
+	exports: [w],
+	imports: [],
+	providers: [w]
+})], T);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-nestjs-modules/src/modules/nestjs-project/nestjs-project.constants.ts
+var E = "framework:nestjs", D = ".module.ts", O = "src/main.module.ts", k = "MainModule", A = [
+	/^ConfigHostModule$/,
+	/^InternalCoreModule$/,
+	/^SyntheticRootModule$/,
+	/^TypeOrmCoreModule$/
+], j = [/^ConfigModule$/], M = /^(\p{Extended_Pictographic}️?(?:‍\p{Extended_Pictographic}️?)*)\s+/u, N = /^([A-Za-z]+)/, P = /* @__PURE__ */ new Set([
+	"built",
+	"cut",
+	"found",
+	"got",
+	"kept",
+	"left",
+	"lost",
+	"made",
+	"put",
+	"ran",
+	"read",
+	"rebuilt",
+	"sent",
+	"set",
+	"split",
+	"took",
+	"wrote"
+]), F = /* @__PURE__ */ new Set([
+	"CommandFactory",
+	"ExceptionHandler",
+	"GraphQLModule",
+	"InstanceLoader",
+	"NestApplication",
+	"NestFactory",
+	"RouterExplorer",
+	"RoutesResolver",
+	"TypeOrmModule"
+]), I, L = class extends e {
+	static {
+		I = this;
+	}
+	constructor() {
+		super();
+	}
+	static isProduction = process.env.NODE_ENV === "production";
+	static rootLogger;
+	static writesToStandardError = !1;
+	child = I.root;
+	static createRootLogger() {
+		let e = process.env.LOG_LEVEL ?? "info";
+		return I.isProduction ? I.writesToStandardError ? l({ level: e }, l.destination(2)) : l({ level: e }) : l({
+			level: e,
+			transport: {
+				options: {
+					colorize: !0,
+					destination: I.writesToStandardError ? 2 : 1,
+					ignore: "pid,hostname,emoji",
+					messageFormat: "{emoji} {msg}",
+					singleLine: !0
+				},
+				target: "pino-pretty"
+			}
+		});
+	}
+	static logToStandardError() {
+		if (I.rootLogger !== void 0) {
+			process.emitWarning("LoggerService.logToStandardError() was called after the first log line, so log lines still go to standard output and anything piping that stream will read them as data. Call it as the first statement of the application's bootstrap.");
+			return;
+		}
+		I.writesToStandardError = !0;
+	}
+	assertConventionalMessage(e) {
+		if (I.isProduction || this.shouldSkipConventionalMessageValidation(e.context)) return;
+		let t = this.getConventionalMessageViolation(e.parsed);
+		if (t !== void 0) throw Error(t);
+	}
+	buildBindings(e) {
+		return this.assertConventionalMessage({
+			context: e.context,
+			parsed: e.parsed
+		}), {
+			...e.data,
+			context: e.context,
+			...I.isProduction ? {} : { emoji: e.parsed.emoji }
+		};
+	}
+	getConventionalMessageViolation(e) {
+		let t = e.emoji, n = e.text;
+		if (t === void 0) return `Log message must start with an emoji naming its subject, then a verb: "${n}"`;
+		let r = N.exec(n)?.[1];
+		if (r === void 0 || !this.isConventionalVerb(r)) return `Log message must begin with a verb in present progressive or past tense, got "${r ?? ""}": "${t} ${n}"`;
+	}
+	isConventionalVerb(e) {
+		let t = e.toLowerCase();
+		return t.endsWith("ing") || t.endsWith("ed") || P.has(t);
+	}
+	parseMessage(e) {
+		let t = String(e), n = M.exec(t), r = n?.[1];
+		return r === void 0 ? {
+			emoji: void 0,
+			text: t
+		} : {
+			emoji: r,
+			text: t.slice(n?.[0].length)
+		};
+	}
+	shouldSkipConventionalMessageValidation(e) {
+		return e !== void 0 && F.has(e);
+	}
+	static get root() {
+		return I.rootLogger ??= I.createRootLogger(), I.rootLogger;
+	}
+	buildErrorLogEntry(e, t) {
+		let n = t instanceof Error ? t.stack || t.message : String(t);
+		return {
+			errorMessage: n,
+			logLine: `[${(/* @__PURE__ */ new Date()).toISOString()}] ${e}: ${n}\n`
+		};
+	}
+	createTimestampedOutputLogFilePath(e) {
+		let t = a.join(process.cwd(), "output");
+		return o(t) || s(t, { recursive: !0 }), a.join(t, `${e}-${(/* @__PURE__ */ new Date()).toISOString().replaceAll(/[:.]/g, "-")}.log`);
+	}
+	debug(e, t, n) {
+		let r = this.parseMessage(e);
+		this.child.debug(this.buildBindings({
+			context: t ?? this.context,
+			data: n,
+			parsed: r
+		}), r.text);
+	}
+	error(e, t, n) {
+		let r = this.parseMessage(e), i = typeof n == "object" ? n : void 0, a = typeof n == "string" ? n : this.context;
+		this.child.error({
+			...this.buildBindings({
+				context: a,
+				data: i,
+				parsed: r
+			}),
+			stack: t
+		}, r.text);
+	}
+	info(e, t, n) {
+		let r = this.parseMessage(e);
+		this.child.info(this.buildBindings({
+			context: t ?? this.context,
+			data: n,
+			parsed: r
+		}), r.text);
+	}
+	log(e, t, n) {
+		this.info(e, t, n);
+	}
+	setContext(e) {
+		super.setContext(e), this.child = I.root.child({ context: e });
+	}
+	verbose(e, t, n) {
+		let r = this.parseMessage(e);
+		this.child.trace(this.buildBindings({
+			context: t ?? this.context,
+			data: n,
+			parsed: r
+		}), r.text);
+	}
+	warn(e, t, n) {
+		let r = this.parseMessage(e);
+		this.child.warn(this.buildBindings({
+			context: t ?? this.context,
+			data: n,
+			parsed: r
+		}), r.text);
+	}
+};
+L = I = y([n({ scope: i.TRANSIENT }), v("design:paramtypes", [])], L);
+//#endregion
+//#region packages/logger/src/modules/logger/logger.module.ts
+var R = class {};
+R = y([t(), r({
+	controllers: [],
+	exports: [L],
+	imports: [],
+	providers: [L]
+})], R);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-nestjs-modules/src/modules/nestjs-project/nestjs-project-synthetic.module.ts
+var z, B = z = class {
+	static forModules(e) {
+		return {
+			imports: [p.forRoot({
+				ignoreEnvFile: !0,
+				isGlobal: !0
+			}), ...e],
+			module: z
+		};
+	}
+};
+B = z = y([r({})], B);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-nestjs-modules/src/modules/nestjs-project/nestjs-project.service.ts
+var V, H = V = class {
+	logger;
+	constructor(e) {
+		this.logger = e, this.logger.setContext(V.name);
+	}
+	async buildSyntheticRootModule(e) {
+		let t = this.findModuleFiles(a.join(e.absoluteRoot, "src")), n = await Promise.all(t.map(async (e) => this.loadModuleClasses(e)));
+		return B.forModules(n.flat());
+	}
+	async discoverModuleDeclaringFiles(e) {
+		let t = this.findModuleFiles(a.join(e.absoluteRoot, "src"));
+		e.rootModuleFile !== void 0 && !t.includes(e.rootModuleFile) && t.push(e.rootModuleFile);
+		let n = /* @__PURE__ */ new Map();
+		for (let r of t) {
+			let t = a.relative(e.absoluteRoot, r).replaceAll("\\", "/"), i = await this.loadModuleClasses(r);
+			for (let e of i) n.set(e.name, t);
+		}
+		return n;
+	}
+	exploreContainer(e, t) {
+		let n = [...e.get(d).values()], r = /* @__PURE__ */ new Set();
+		for (let { name: e } of n) t.some((t) => t.test(e)) || r.add(e);
+		let i = [];
+		for (let { imports: e, name: t } of n) r.has(t) && i.push({
+			imports: [...e].map((e) => e.name).filter((e) => r.has(e)),
+			name: t
+		});
+		return i;
+	}
+	findModuleFiles(e) {
+		if (!o(e)) return [];
+		let t = [];
+		for (let n of c(e, { withFileTypes: !0 })) {
+			let r = a.join(e, n.name);
+			n.isDirectory() ? t.push(...this.findModuleFiles(r)) : n.name.endsWith(".module.ts") && t.push(r);
+		}
+		return t.toSorted((e, t) => e.localeCompare(t));
+	}
+	async loadModuleClasses(e) {
+		let t = await import(u(e).href);
+		return Object.entries(t).filter((e) => e[0].endsWith("Module") && typeof e[1] == "function").map(([, e]) => e);
+	}
+	async loadRootModule(e) {
+		let t = (await import(u(e).href))[k];
+		if (typeof t != "function") throw TypeError(`Expected ${e} to export a ${k} class`);
+		return t;
+	}
+	describeProject(e, t) {
+		let n = a.join(e, O);
+		return {
+			absoluteRoot: e,
+			name: t,
+			rootModuleFile: o(n) ? n : void 0
+		};
+	}
+	discoverProjects(e) {
+		return e.filter((e) => this.isNestjsProject(e)).map((e) => this.describeProject(e.absoluteRoot, e.name));
+	}
+	async exploreProject(e) {
+		let { rootModuleFile: t } = e, n = t === void 0 ? await this.buildSyntheticRootModule(e) : await this.loadRootModule(t), r = await this.discoverModuleDeclaringFiles(e), i = await f.createApplicationContext(n, {
+			abortOnError: !1,
+			logger: !1,
+			preview: !0
+		}), a;
+		try {
+			a = this.exploreContainer(i, [...A, ...t === void 0 ? j : []]);
+		} finally {
+			this.logger.debug("🚀 Booted a project's container", void 0, { project: e.name }), await i.close();
+		}
+		return a.map((e) => ({
+			...e,
+			declaringFile: r.get(e.name)
+		}));
+	}
+	isNestjsProject(e) {
+		return e.tags.includes(E);
+	}
+};
+H = V = y([n(), v("design:paramtypes", [L === void 0 ? Object : L])], H);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-nestjs-modules/src/modules/nestjs-project/nestjs-project.module.ts
+var U = class {};
+U = y([r({
+	controllers: [],
+	exports: [H],
+	imports: [R],
+	providers: [H]
+})], U);
+//#endregion
+export { g as MODULE_GRAPH_AMBIENT_LEGEND, _ as MODULE_GRAPH_AMBIENT_MINIMUM_MODULES, h as MODULE_GRAPH_MERMAID_HEADER, m as MODULE_GRAPH_UNCONNECTED, x as ModuleGraphModule, b as ModuleGraphService, C as NESTJS_MODULES_WORKSPACE_GRAPH_MERMAID_HEADER, S as NESTJS_MODULES_WORKSPACE_GRAPH_UNCONNECTED, A as NESTJS_PROJECT_IGNORED_MODULES, D as NESTJS_PROJECT_MODULE_FILE_SUFFIX, k as NESTJS_PROJECT_ROOT_MODULE_EXPORT, O as NESTJS_PROJECT_ROOT_MODULE_FILE, j as NESTJS_PROJECT_SYNTHETIC_IGNORED_MODULES, E as NESTJS_PROJECT_TAG, T as NestjsModulesWorkspaceGraphModule, w as NestjsModulesWorkspaceGraphService, U as NestjsProjectModule, H as NestjsProjectService };

package/package.json

@@ -0,0 +1,64 @@
+{
+  "author": "Jimmy Paolini",
+  "bugs": {
+    "url": "https://github.com/organizzolini/codebase/issues"
+  },
+  "dependencies": {
+    "@nestjs/common": "^11.1.21 || ^12.0.1",
+    "@nestjs/config": "^12.0.0",
+    "@nestjs/core": "^11.1.21 || ^12.0.1",
+    "pino": "^10.3.1",
+    "pino-pretty": "^13.1.3",
+    "reflect-metadata": "^0.2.2"
+  },
+  "description": "NestJS module container inspection and module-level dependency graph extraction for Codependix",
+  "devDependencies": {
+    "@codebase/logger": "0.0.1",
+    "@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",
+    "vitest": "^5.0.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/src/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "homepage": "https://github.com/organizzolini/codebase/tree/main/packages/ic-suite/codependix/codependix-nestjs-modules#readme",
+  "keywords": [
+    "architecture",
+    "codependix",
+    "dependency-injection",
+    "module-graph",
+    "nestjs"
+  ],
+  "license": "MIT",
+  "main": "./dist/src/index.js",
+  "name": "@codependix/nestjs-modules",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "directory": "packages/ic-suite/codependix/codependix-nestjs-modules",
+    "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.3"
+}