@codependix/configuration 0.0.0-stage → 0.0.3

package/dist/src/index.js

@@ -0,0 +1,489 @@
+import { z as e } from "zod";
+import { Injectable as t, Module as n } from "@nestjs/common";
+import r from "prompts";
+import { existsSync as i } from "node:fs";
+import { readFile as a } from "node:fs/promises";
+import o from "node:path";
+import { fileURLToPath as s } from "node:url";
+import { createJiti as c } from "jiti";
+//#region packages/ic-suite/codependix/codependix-configuration/src/modules/configuration/configuration.constants.ts
+var l = class extends Error {
+	constructor(e) {
+		super(`Unsupported configuration file type: ${e}`), this.name = "UnknownConfigurationFileTypeError";
+	}
+}, u = [
+	"fileImports",
+	"nestjsModules",
+	"nxProjects"
+], d = [
+	"both",
+	"json",
+	"markdown",
+	"none"
+], f = /* @__PURE__ */ new Set([
+	".cjs",
+	".cts",
+	".js",
+	".json",
+	".mjs",
+	".mts",
+	".ts"
+]), p = [
+	"codependix.config.ts",
+	"codependix.config.mts",
+	"codependix.config.cts",
+	"codependix.config.js",
+	"codependix.config.mjs",
+	"codependix.config.cjs",
+	"codependix.config.json"
+], m = "none", h = "README.md", g = [], _ = [".git", "pnpm-workspace.yaml"], v = e.object({
+	id: e.array(e.string().min(1)).min(1).optional(),
+	path: e.array(e.string().min(1)).min(1).optional(),
+	project: e.array(e.string().min(1)).min(1).optional(),
+	tags: e.array(e.string().min(1)).min(1).optional()
+}).refine((e) => Object.values(e).some((e) => e !== void 0), { message: "A selector needs at least one of id, path, project, or tags — otherwise nothing says which nodes it means." }), y = e.object({ implicit: e.boolean().optional() }), b = e.union([e.object({
+	edges: y.optional(),
+	from: v,
+	kind: e.enum(["allow", "forbid"]),
+	message: e.string().min(1).optional(),
+	name: e.string().min(1),
+	to: v
+}), e.object({
+	kind: e.literal("acyclic"),
+	message: e.string().min(1).optional(),
+	name: e.string().min(1),
+	nodes: v.optional()
+})]), x = e.object({
+	python: e.array(b).optional(),
+	typescript: e.array(b).optional()
+}), S = e.object({
+	fileImports: x.optional(),
+	nestjsModules: e.array(b).optional(),
+	nxProjects: e.array(b).optional()
+}), C = e.object({
+	json: e.object({ path: e.string().min(1) }).optional(),
+	markdown: e.object({
+		anchor: e.string().min(1).optional(),
+		path: e.string().min(1).optional()
+	}).optional(),
+	target: e.enum(d).optional()
+}).superRefine((e, t) => {
+	let n = e.target ?? "none", r = n === "both" || n === "json", i = n === "both" || n === "markdown";
+	r && e.json === void 0 && t.addIssue({
+		code: "custom",
+		message: `A "${n}" export target needs a json destination.`
+	}), i && e.markdown === void 0 && t.addIssue({
+		code: "custom",
+		message: `A "${n}" export target needs a markdown destination.`
+	}), e.markdown !== void 0 && e.markdown.anchor === void 0 && e.markdown.path === void 0 && t.addIssue({
+		code: "custom",
+		message: "A markdown destination needs an anchor, a path, or both — otherwise nothing names where the export goes."
+	});
+}), w = e.object({
+	fileImports: C.optional(),
+	nestjsModules: C.optional(),
+	nxProjects: C.optional()
+}), T = e.object({
+	fileImports: C.optional(),
+	nestjsModules: C.optional(),
+	nxProjects: C.optional()
+}), E = e.object({
+	boundaries: S.optional(),
+	exclude: e.array(e.string()).optional(),
+	include: e.array(e.string()).optional(),
+	projectGraph: e.string().optional(),
+	workspace: T.optional()
+}), D = "boundaries", O = "reports", k = [D, O], A = ",", j = [
+	D,
+	O,
+	"write"
+], M = "A run mode (--check or --write)", N = class extends Error {
+	constructor(e) {
+		super(`Configuration file not found: ${e}`), this.name = "ConfigurationFileNotFoundError";
+	}
+}, P = class extends Error {
+	constructor(e) {
+		super(e), this.name = "InputError";
+	}
+}, F = (e) => new P(`${e} is required, and stdin is not a terminal so it cannot be asked for.`), I = (e) => new P(`${e} was not chosen.`);
+//#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 R(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-configuration/src/modules/input/input.service.ts
+var z = class {
+	constructor() {}
+	promptRunner = r;
+	assertCanPrompt(e) {
+		if (!process.stdin.isTTY) throw F(e);
+	}
+	parseCommaDelimitedOption(e) {
+		return e === void 0 ? [] : e.split(",").map((e) => e.trim()).filter(Boolean);
+	}
+	parseFlagOption(e) {
+		return e ?? !0;
+	}
+	parseOptionalOption(e) {
+		let t = e?.trim();
+		return t === void 0 || t.length === 0 ? void 0 : t;
+	}
+	parsePathOption(e) {
+		return this.parseOptionalOption(e) ?? process.cwd();
+	}
+	async promptForSelect(e) {
+		this.assertCanPrompt(e.subject);
+		let t = (await this.promptRunner({
+			choices: e.choices.map((e) => ({
+				title: e,
+				value: e
+			})),
+			message: e.message,
+			name: "value",
+			type: "select"
+		})).value;
+		if (t === void 0) throw I(e.subject);
+		let n = e.choices.find((e) => e === t);
+		if (n === void 0) throw Error(`Prompt did not resolve to one of: ${e.choices.join(", ")}.`);
+		return n;
+	}
+};
+z = R([t(), L("design:paramtypes", [])], z);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-configuration/src/modules/input/input.module.ts
+var B = class {};
+B = R([n({
+	controllers: [],
+	exports: [z],
+	imports: [],
+	providers: [z]
+})], B);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-configuration/src/modules/override-resolution/override-resolution.constants.ts
+var V = (e) => `${e.flag} overrides a value the configuration does not declare. Add \`${e.field}\` to the configuration this run reads, then use ${e.flag} to change it.`, H = class {
+	constructor() {}
+	resolveOverride(e) {
+		let { authored: t, configured: n, field: r, flag: i, override: a } = e;
+		if (a === void 0 || a.length === 0) return n;
+		if (t === void 0) throw new P(V({
+			field: r,
+			flag: i
+		}));
+		return [...a];
+	}
+	applyOverrides(e) {
+		let { authored: t, overrides: n, resolved: r } = e;
+		return n === void 0 ? r : {
+			...r,
+			exclude: this.resolveOverride({
+				authored: t.exclude,
+				configured: r.exclude,
+				field: "exclude",
+				flag: "--exclude",
+				override: n.exclude
+			}),
+			include: this.resolveOverride({
+				authored: t.include,
+				configured: r.include,
+				field: "include",
+				flag: "--include",
+				override: n.include
+			})
+		};
+	}
+};
+H = R([t(), L("design:paramtypes", [])], H);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-configuration/src/modules/override-resolution/override-resolution.module.ts
+var U = class {};
+U = R([n({
+	controllers: [],
+	exports: [H],
+	imports: [],
+	providers: [H]
+})], U);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-configuration/src/modules/configuration/configuration-loader.service.ts
+var W = class {
+	constructor() {}
+	readDefaultExport(e) {
+		if (typeof e != "object" || !e) return {};
+		let t = e.default;
+		return typeof t == "object" && t ? t : e;
+	}
+	findConfigurationFile(e) {
+		let t = o.resolve(e);
+		for (;;) {
+			for (let e of p) {
+				let n = o.join(t, e);
+				if (i(n)) return n;
+			}
+			let e = o.dirname(t);
+			if (e === t) return;
+			t = e;
+		}
+	}
+	findProjectConfigurationFile(e) {
+		for (let t of p) {
+			let n = o.join(e, t);
+			if (i(n)) return n;
+		}
+	}
+	findWorkspaceRoot() {
+		let e = o.resolve(process.cwd());
+		for (;;) {
+			let t = e;
+			if (_.some((e) => i(o.join(t, e)))) return e;
+			let n = o.dirname(e);
+			if (n === e) return;
+			e = n;
+		}
+	}
+	async loadConfigurationModule(e) {
+		if (e.extension === ".json") return JSON.parse(await a(e.configurationPath, "utf8"));
+		let t = c(s(import.meta.url));
+		return this.readDefaultExport(await t.import(e.configurationPath, { default: !0 }));
+	}
+	async parseConfigurationFile(e) {
+		let t = o.extname(e).toLowerCase();
+		if (!f.has(t)) throw new l(e);
+		let n = await this.loadConfigurationModule({
+			configurationPath: e,
+			extension: t
+		});
+		return E.parse(n);
+	}
+	async readAuthoredConfiguration(e) {
+		let t = o.resolve(e.searchDirectory ?? process.cwd()), n = e.configurationPath === void 0 ? this.findConfigurationFile(t) : this.resolveConfigurationPath(e.configurationPath);
+		return n === void 0 ? {} : this.parseConfigurationFile(n);
+	}
+	resolveConfigurationPath(e) {
+		let t = o.resolve(e);
+		if (i(t)) return t;
+		let n = this.findWorkspaceRoot();
+		if (n === void 0) throw new N(t);
+		let r = o.resolve(n, e);
+		if (!i(r)) throw new N(t);
+		return r;
+	}
+};
+W = R([t(), L("design:paramtypes", [])], W);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-configuration/src/modules/configuration/flag-resolution.service.ts
+var G = class {
+	inputService;
+	constructor(e) {
+		this.inputService = e;
+	}
+	describeAcceptedCheckNames(e) {
+		return `${e}. It takes a comma-separated set drawn from ${k.map((e) => `"${e}"`).join(" and ")}, as in "--check ${k.join(",")}".`;
+	}
+	emptyMode() {
+		return {
+			checksBoundaries: !1,
+			checksReports: !1,
+			writes: !1
+		};
+	}
+	async promptForMode() {
+		let e = await this.inputService.promptForSelect({
+			choices: j,
+			message: "Check declared boundaries, check every configured export is current, or write them?",
+			subject: M
+		});
+		return {
+			errors: [],
+			mode: {
+				checksBoundaries: e === D,
+				checksReports: e === O,
+				writes: e === "write"
+			}
+		};
+	}
+	readCheckNames(e, t) {
+		if (e === void 0) return /* @__PURE__ */ new Set();
+		let n = e === !0 ? [] : e.split(",").map((e) => e.trim()).filter((e) => e !== "");
+		return n.length === 0 ? (t.push(this.describeAcceptedCheckNames("--check needs a value")), /* @__PURE__ */ new Set()) : this.validateCheckNames(n, t);
+	}
+	validateCheckNames(e, t) {
+		let n = /* @__PURE__ */ new Set();
+		for (let r of e) {
+			if (k.includes(r)) {
+				n.add(r);
+				continue;
+			}
+			t.push(this.describeAcceptedCheckNames(`--check does not accept "${r}"`));
+		}
+		return n;
+	}
+	async selectMode(e) {
+		let t = [], n = this.readCheckNames(e.check, t), r = e.write === !0;
+		return t.length > 0 ? {
+			errors: t,
+			mode: this.emptyMode()
+		} : n.size === 0 && !r ? this.promptForMode() : (r && n.has("reports") && t.push(`--write cannot be combined with --check ${O}: an export cannot be stale in the run that just wrote it. Drop one of them, or run --write and --check ${O} separately.`), {
+			errors: t,
+			mode: {
+				checksBoundaries: n.has(D),
+				checksReports: n.has(O),
+				writes: r
+			}
+		});
+	}
+	touchesFiles(e) {
+		return e.checksReports || e.writes;
+	}
+};
+G = R([t(), L("design:paramtypes", [z === void 0 ? Object : z])], G);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-configuration/src/modules/configuration/configuration.service.ts
+var K = class {
+	configurationLoaderService;
+	flagResolutionService;
+	inputService;
+	overrideResolutionService;
+	constructor(e, t, n, r) {
+		this.configurationLoaderService = e, this.flagResolutionService = t, this.inputService = n, this.overrideResolutionService = r;
+	}
+	isProjectNamedOnCommandLine(e) {
+		let { selection: t } = e.configuration;
+		return this.matchesAnyName(e.projectName, e.projectRoot, t.projects) || (e.projectTags ?? []).some((e) => t.tags.includes(e));
+	}
+	matchesAnyGlob(e, t) {
+		return t.some((t) => o.matchesGlob(e, t));
+	}
+	matchesAnyName(e, t, n) {
+		return this.matchesAnyGlob(e, n) || t !== void 0 && this.matchesAnyGlob(t, n);
+	}
+	resolveBoundaries(e) {
+		return {
+			fileImports: {
+				python: e?.fileImports?.python ?? [],
+				typescript: e?.fileImports?.typescript ?? []
+			},
+			nestjsModules: e?.nestjsModules ?? [],
+			nxProjects: e?.nxProjects ?? []
+		};
+	}
+	resolveGraphOutput(e) {
+		let t = e?.target ?? "none", n = e?.markdown;
+		return {
+			json: e?.json === void 0 ? void 0 : { path: e.json.path },
+			markdown: n === void 0 ? void 0 : {
+				anchor: n.anchor,
+				path: n.path ?? "README.md"
+			},
+			target: t
+		};
+	}
+	resolveSelection(e) {
+		return {
+			projects: this.splitSelectionArgument(e?.projects),
+			tags: this.splitSelectionArgument(e?.tags)
+		};
+	}
+	splitSelectionArgument(e) {
+		return (e ?? "").split(",").map((e) => e.trim()).filter((e) => e.length > 0);
+	}
+	isProjectIncluded(e) {
+		let { configuration: t, projectName: n, projectRoot: r } = e, i = this.matchesAnyName(n, r, t.include) || this.isProjectNamedOnCommandLine(e), a = this.matchesAnyName(n, r, t.exclude);
+		return i && !a;
+	}
+	isProjectSelected(e) {
+		let { selection: t } = e.configuration;
+		return t.projects.length === 0 && t.tags.length === 0 || this.isProjectNamedOnCommandLine(e);
+	}
+	async loadConfiguration(e = {}) {
+		let t = await this.configurationLoaderService.readAuthoredConfiguration(e);
+		return this.overrideResolutionService.applyOverrides({
+			authored: t,
+			overrides: e.overrides,
+			resolved: this.resolveConfiguration(t, e.selection)
+		});
+	}
+	async loadProjectConfiguration(e) {
+		let t = o.resolve(e.projectRoot), n = this.configurationLoaderService.findProjectConfigurationFile(t);
+		if (n === void 0) return;
+		let r = o.extname(n).toLowerCase();
+		if (!f.has(r)) throw new l(n);
+		let i = await this.configurationLoaderService.loadConfigurationModule({
+			configurationPath: n,
+			extension: r
+		});
+		return w.parse(i);
+	}
+	parseCommaDelimitedOption(e) {
+		return this.inputService.parseCommaDelimitedOption(e);
+	}
+	parseFlagOption(e) {
+		return this.inputService.parseFlagOption(e);
+	}
+	parseOptionalOption(e) {
+		return this.inputService.parseOptionalOption(e);
+	}
+	parsePathOption(e) {
+		return this.inputService.parsePathOption(e);
+	}
+	resolveConfiguration(e, t) {
+		return {
+			boundaries: this.resolveBoundaries(e.boundaries),
+			exclude: e.exclude ?? [],
+			include: e.include ?? [...g],
+			projectGraph: e.projectGraph,
+			selection: this.resolveSelection(t),
+			workspace: e.workspace ?? {}
+		};
+	}
+	resolveForProject(e) {
+		let { configuration: t, graphType: n, projectConfiguration: r, projectName: i, projectRoot: a, projectTags: o } = e;
+		return !this.isProjectIncluded({
+			configuration: t,
+			projectName: i,
+			projectRoot: a,
+			projectTags: o
+		}) || r === void 0 ? {
+			json: void 0,
+			markdown: void 0,
+			target: "none"
+		} : this.resolveGraphOutput(r[n]);
+	}
+	resolveForWorkspace(e, t) {
+		return this.resolveGraphOutput(e.workspace[t]);
+	}
+	async selectMode(e) {
+		return this.flagResolutionService.selectMode(e);
+	}
+	touchesFiles(e) {
+		return this.flagResolutionService.touchesFiles(e);
+	}
+};
+K = R([t(), L("design:paramtypes", [
+	W === void 0 ? Object : W,
+	G === void 0 ? Object : G,
+	z === void 0 ? Object : z,
+	H === void 0 ? Object : H
+])], K);
+//#endregion
+//#region packages/ic-suite/codependix/codependix-configuration/src/modules/configuration/configuration.module.ts
+var q = class {};
+q = R([n({
+	controllers: [],
+	exports: [K],
+	imports: [B, U],
+	providers: [
+		W,
+		K,
+		G
+	]
+})], q);
+//#endregion
+export { D as CHECK_BOUNDARIES, k as CHECK_NAMES, O as CHECK_REPORTS, A as CHECK_SEPARATOR, d as CODEPENDIX_EXPORT_TARGETS, u as CODEPENDIX_GRAPH_TYPES, p as CONFIGURATION_FILE_NAMES, N as ConfigurationFileNotFoundError, q as ConfigurationModule, K as ConfigurationService, m as DEFAULT_EXPORT_TARGET, g as DEFAULT_INCLUDE_GLOBS, h as DEFAULT_MARKDOWN_PATH, P as InputError, _ as REPOSITORY_ROOT_MARKERS, j as RUN_MODE_CHOICES, M as RUN_MODE_SUBJECT, l as UnknownConfigurationFileTypeError, E as codependixConfigurationSchema, w as codependixProjectConfigurationSchema, F as missingInputError, I as promptCancelledError };

package/package.json

@@ -1,6 +1,65 @@
 {
+  "author": "Jimmy Paolini",
+  "bugs": {
+    "url": "https://github.com/organizzolini/codebase/issues"
+  },
+  "dependencies": {
+    "@codependix/core": "0.0.3",
+    "@nestjs/common": "^11.1.21 || ^12.0.1",
+    "jiti": "^2.7.0",
+    "prompts": "^2.4.2",
+    "reflect-metadata": "^0.2.2",
+    "zod": "^4.4.3"
+  },
+  "description": "Configuration reader, glob resolution, and boundary constraint definitions 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",
+    "@types/prompts": "^2.4.9",
+    "@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": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "homepage": "https://github.com/organizzolini/codebase/tree/main/packages/ic-suite/codependix/codependix-configuration#readme",
+  "keywords": [
+    "boundaries",
+    "codependix",
+    "configuration",
+    "constraints",
+    "rules"
+  ],
+  "license": "MIT",
+  "main": "./dist/src/index.js",
   "name": "@codependix/configuration",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "directory": "packages/ic-suite/codependix/codependix-configuration",
+    "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"
 }