@codometer/configuration 0.0.1

package/dist/src/index.js

@@ -0,0 +1,450 @@
+import { CODOMETER_SEVERITIES as e, CODOMETER_STATISTIC_GROUPS as t, CODOMETER_SYMBOL_KINDS as n, CODOMETER_SYMBOL_MODIFIERS as r, ConfigurationFileNotFoundError as i, InvalidConfigurationError as a, InvalidLimitValueError as o, UnknownConfigurationFileTypeError as s } from "@codometer/core";
+import { z as c } from "zod";
+import { Injectable as l, Module as u } from "@nestjs/common";
+import { existsSync as d } from "node:fs";
+import { readFile as f } from "node:fs/promises";
+import p from "node:path";
+import { fileURLToPath as m } from "node:url";
+import { createJiti as h } from "jiti";
+import { parse as g } from "jsonc-parser";
+//#region packages/ic-suite/codometer/codometer-configuration/src/modules/configuration/configuration-flags.constants.ts
+var _ = "limits", v = "reports", y = [_, v], b = ",", x = "json", S = "markdown", C = [x, S], w = /* @__PURE__ */ new Set([
+	".cjs",
+	".cts",
+	".js",
+	".json",
+	".jsonc",
+	".mjs",
+	".mts",
+	".ts"
+]), T = [
+	"codometer.config.ts",
+	"codometer.config.mts",
+	"codometer.config.cts",
+	"codometer.config.js",
+	"codometer.config.mjs",
+	"codometer.config.cjs",
+	"codometer.config.json",
+	"codometer.config.jsonc"
+], E = [
+	"**/.nx/**",
+	"**/build/**",
+	"**/coverage/**",
+	"**/dist/**",
+	"**/node_modules/**"
+], D = [
+	"7c3aed",
+	"0284c7",
+	"16a34a",
+	"ea580c",
+	"db2777",
+	"0ea5e9",
+	"059669",
+	"ca8a04"
+], O = "conventions", k = "codebase", A = {
+	analyses: ["language"],
+	include: ["**/*"],
+	name: k
+}, ee = "gzip", te = ".", ne = "fail", re = /* @__PURE__ */ new Map([
+	["b", 1],
+	["gb", 1e9],
+	["kb", 1e3],
+	["mb", 1e6],
+	["tb", 0xe8d4a51000]
+]), ie = /^(\d+(?:\.\d+)?)\s*([a-z]*)$/i, ae = 2, oe = "<!-- codometer:end -->", j = "<!-- codometer:start -->", M = "python3", N = [".git", "pnpm-workspace.yaml"], P = ["language", "size"], F = [
+	"css",
+	"hcl",
+	"python",
+	"shell",
+	"sql",
+	"toml",
+	"typescript",
+	"yaml"
+], I = [
+	"brotli",
+	"gzip",
+	"none"
+], L = "A codometer configuration must name a `format` of \"json\" or \"markdown\", and nothing supplies one for it. Set it in this file, or spread a shared default object that sets it — every run has to be told which report shape it produces, and a directory with no configuration file anywhere above it fails here rather than measuring with a format nobody chose.", R = ["json", "markdown"], z = [
+	"characters",
+	"lines",
+	"words"
+], B = () => c.custom((e) => typeof e == "function", { message: "Expected a function" }), V = c.object({
+	kind: c.enum(n).optional(),
+	language: c.enum(F).optional(),
+	maximumCharacters: c.number().int().min(1).optional(),
+	maximumLines: c.number().int().min(1).optional(),
+	maximumWords: c.number().int().min(1).optional(),
+	severity: c.enum(e).optional()
+}), H = c.object({
+	color: c.string().optional(),
+	comment: V.optional(),
+	group: c.enum(t).optional(),
+	label: c.string(),
+	patterns: c.array(c.string()).min(1).optional(),
+	symbols: c.object({
+		kinds: c.array(c.enum(n)).min(1),
+		modifiers: c.array(c.enum(r)).optional()
+	}).optional()
+}).refine((e) => e.patterns !== void 0 || e.symbols !== void 0 || e.comment !== void 0, { message: "A statistic needs patterns to match files, symbols to match declarations, or a comment selector to match a budget — otherwise it counts nothing." }), U = c.object({
+	analyses: c.array(c.enum(P)).min(1),
+	compression: c.enum(I).optional(),
+	directory: c.string().min(1).optional(),
+	exclude: c.array(c.string().refine((e) => !e.startsWith("!"), { message: "An exclude glob already removes files, so a leading `!` has nothing to negate — write the glob without it." })).optional(),
+	include: c.array(c.string()).min(1),
+	name: c.string().min(1)
+}).superRefine((e, t) => {
+	e.include.some((e) => !e.startsWith("!")) || t.addIssue({
+		code: "custom",
+		message: `Input "${e.name}" has no include glob that adds files — every pattern in its include list starts with "!", so it would hold nothing to measure.`
+	});
+}), W = c.object({
+	custom: c.array(c.string().min(1)).optional(),
+	indentation: c.number().int().min(0).optional(),
+	path: c.string(),
+	type: c.literal("json")
+}), G = c.object({
+	custom: c.array(c.string().min(1)).optional(),
+	description: c.string().optional(),
+	endMarker: c.string().optional(),
+	path: c.string().optional(),
+	startMarker: c.string().optional(),
+	type: c.literal("markdown"),
+	write: B().optional()
+}).refine((e) => e.path !== void 0 || e.write !== void 0, { message: "Markdown output needs a path, a write function, or both — otherwise nothing names the file to write." }), K = c.object({
+	custom: c.array(H).refine((e) => new Set(e.map((e) => e.label)).size === e.length, { message: "Every custom statistic needs its own label." }).optional(),
+	defaultInput: c.string().min(1).optional(),
+	exclude: c.array(c.string()).optional(),
+	excludeFrom: c.array(c.string()).optional(),
+	format: c.enum(R, { error: L }),
+	inputs: c.array(U).refine((e) => new Set(e.map((e) => e.name)).size === e.length, { message: "Every input needs its own name." }).optional(),
+	limits: c.array(c.object({
+		label: c.string().min(1).optional(),
+		metric: c.string().min(1),
+		severity: c.enum(e).optional(),
+		value: c.union([c.number(), c.string()])
+	})).optional(),
+	outputs: c.array(c.union([W, G])).superRefine((e, t) => {
+		let n = e.find((t, n) => e.findIndex((e) => e.type === t.type) < n);
+		n !== void 0 && t.addIssue({
+			code: "custom",
+			message: `A configuration may declare at most one output per type, and this one declares more than one "${n.type}" output. Nothing on the command line could address the second, so write the one destination this repository means.`
+		});
+	}).optional(),
+	python: c.object({ command: c.string().optional() }).optional()
+}).superRefine((e, t) => {
+	let n = new Set((e.custom ?? []).map((e) => e.label));
+	for (let r of e.outputs ?? []) for (let e of r.custom ?? []) n.has(e) || t.addIssue({
+		code: "custom",
+		message: `The "${r.type}" output selects the custom statistic "${e}", but no top-level "custom" entry declares that label. Declare it in "custom", or select a label that is.`
+	});
+});
+//#endregion
+//#region \0@oxc-project+runtime@0.151.0/helpers/esm/decorateMetadata.js
+function q(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 J(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/codometer/codometer-configuration/src/modules/configuration/configuration-flags.service.ts
+var Y = class {
+	constructor() {}
+	describeAcceptedCheckNames(e) {
+		return `${e}. It takes a comma-separated set drawn from ${y.map((e) => `"${e}"`).join(" and ")}, as in "--check ${y.join(",")}".`;
+	}
+	readCheckNames(e, t) {
+		if (e === void 0) return /* @__PURE__ */ new Set();
+		if (e === !0) return t.push(this.describeAcceptedCheckNames("--check needs a value")), /* @__PURE__ */ new Set();
+		let n = 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 (y.includes(r)) {
+				n.add(r);
+				continue;
+			}
+			t.push(this.describeAcceptedCheckNames(`--check does not accept "${r}"`));
+		}
+		return n;
+	}
+	parseDefaultedOption(e, t) {
+		return this.parseOptionalOption(e) ?? t;
+	}
+	parseDirectoryOption(e) {
+		return this.parseDefaultedOption(e, process.cwd());
+	}
+	parseOptionalOption(e) {
+		return typeof e == "string" && e !== "" ? e : void 0;
+	}
+	resolveFormat(e, t, n) {
+		if (e === void 0) return t;
+		let r = C.find((t) => t === e);
+		return r === void 0 && n.push(`--format does not accept "${e}". It takes one of ${C.map((e) => `"${e}"`).join(" and ")}, as in "--format ${S}".`), r;
+	}
+	selectMode(e) {
+		let t = [], n = this.readCheckNames(e.check, t), r = {
+			checksLimits: n.has(_),
+			checksReports: n.has(v),
+			writesJson: e.outputJson !== void 0,
+			writesMarkdown: e.outputMarkdown !== void 0
+		};
+		return r.checksReports && (r.writesJson || r.writesMarkdown) && t.push(`--output-json or --output-markdown cannot be combined with --check ${v}: a report cannot be stale in the run that just wrote it. Drop --check ${v}, or run it separately from the run that writes.`), {
+			errors: t,
+			mode: r
+		};
+	}
+};
+Y = J([l(), q("design:paramtypes", [])], Y);
+//#endregion
+//#region packages/ic-suite/codometer/codometer-configuration/src/modules/configuration/configuration-loader.service.ts
+var X = class {
+	constructor() {}
+	findConfigurationFile(e) {
+		let t = p.resolve(e);
+		for (;;) {
+			for (let e of T) {
+				let n = p.join(t, e);
+				if (d(n)) return n;
+			}
+			let e = p.dirname(t);
+			if (e === t) return;
+			t = e;
+		}
+	}
+	findRepositoryRoot() {
+		let e = p.resolve(process.cwd());
+		for (;;) {
+			let t = e;
+			if (N.some((e) => d(p.join(t, e)))) return e;
+			let n = p.dirname(e);
+			if (n === e) return;
+			e = n;
+		}
+	}
+	async loadConfigurationModule(e) {
+		if (e.extension === ".json" || e.extension === ".jsonc") return this.loadJsonConfiguration(e);
+		let t = h(m(import.meta.url));
+		return this.readDefaultExport(await t.import(e.configurationPath, { default: !0 }));
+	}
+	async loadJsonConfiguration(e) {
+		let t = await f(e.configurationPath, "utf8");
+		return e.extension === ".jsonc" ? g(t) : JSON.parse(t);
+	}
+	readDefaultExport(e) {
+		if (typeof e != "object" || !e) return {};
+		let t = e.default;
+		return typeof t == "object" && t ? t : e;
+	}
+	resolveConfigurationPath(e) {
+		let t = p.resolve(e);
+		if (d(t)) return t;
+		let n = this.findRepositoryRoot();
+		if (n === void 0) throw new i(t);
+		let r = p.resolve(n, e);
+		if (!d(r)) throw new i(t);
+		return r;
+	}
+	async load(e = {}) {
+		let t = p.resolve(e.searchDirectory ?? process.cwd()), n = e.configurationPath === void 0 ? this.findConfigurationFile(t) : this.resolveConfigurationPath(e.configurationPath);
+		if (n === void 0) return;
+		let r = p.extname(n).toLowerCase();
+		if (!w.has(r)) throw new s(n);
+		return {
+			configuration: await this.loadConfigurationModule({
+				configurationPath: n,
+				extension: r
+			}),
+			path: n
+		};
+	}
+};
+X = J([l(), q("design:paramtypes", [])], X);
+//#endregion
+//#region packages/ic-suite/codometer/codometer-configuration/src/modules/configuration/configuration-resolver.service.ts
+var Z = class {
+	constructor() {}
+	parseConfigurationInternal(e) {
+		let t = K.safeParse(e);
+		if (!t.success) throw new a(c.prettifyError(t.error));
+		return t.data;
+	}
+	parseLimitValue(e) {
+		if (typeof e.value != "number") return this.parseLimitValueText(e.metric, e.value);
+		if (!Number.isFinite(e.value) || e.value < 0) throw new o(e.metric, String(e.value));
+		return e.value;
+	}
+	parseLimitValueText(e, t) {
+		let [, n, r] = ie.exec(t.trim()) ?? [];
+		if (n === void 0 || r === void 0) throw new o(e, t);
+		if (r === "") return Number(n);
+		let i = re.get(r.toLowerCase());
+		if (i === void 0) throw new o(e, t);
+		return Math.round(Number(n) * i);
+	}
+	resolveCustomStatistics(e) {
+		let t = /* @__PURE__ */ new Map();
+		return (e ?? []).map((e) => {
+			let n = e.group ?? "conventions", r = t.get(n) ?? 0;
+			t.set(n, r + 1);
+			let { comment: i } = e;
+			return {
+				color: e.color ?? D[r % D.length] ?? "7c3aed",
+				comment: i === void 0 ? void 0 : {
+					kind: i.kind,
+					language: i.language,
+					maximumCharacters: i.maximumCharacters,
+					maximumLines: i.maximumLines,
+					maximumWords: i.maximumWords,
+					severity: i.severity ?? "fail"
+				},
+				group: n,
+				label: e.label,
+				patterns: e.patterns ?? [],
+				symbols: e.symbols
+			};
+		});
+	}
+	resolveInput(e) {
+		return {
+			analyses: [...e.analyses],
+			compression: e.compression ?? "gzip",
+			directory: e.directory ?? ".",
+			exclude: [.../* @__PURE__ */ new Set([...e.include.filter((e) => e.startsWith("!")).map((e) => e.slice(1)), ...e.exclude ?? []])],
+			include: e.include.filter((e) => !e.startsWith("!")),
+			name: e.name
+		};
+	}
+	resolveInputs(e) {
+		let t = e ?? [];
+		return (t.some((e) => e.name === "codebase") ? t : [A, ...t]).map((e) => this.resolveInput(e));
+	}
+	resolveJsonOutput(e, t) {
+		return {
+			custom: this.selectCustomStatistics(e.custom, t),
+			indentation: e.indentation ?? 2,
+			path: e.path,
+			type: "json"
+		};
+	}
+	resolveLimits(e) {
+		return (e ?? []).map((e) => ({
+			label: e.label,
+			metric: e.metric,
+			severity: e.severity ?? "fail",
+			value: this.parseLimitValue(e)
+		}));
+	}
+	resolveMarkdownOutput(e, t) {
+		return {
+			custom: this.selectCustomStatistics(e.custom, t),
+			description: e.description,
+			endMarker: e.endMarker ?? "<!-- codometer:end -->",
+			path: e.path,
+			startMarker: e.startMarker ?? "<!-- codometer:start -->",
+			type: "markdown",
+			write: e.write
+		};
+	}
+	resolveOutputs(e, t) {
+		return (e ?? []).map((e) => e.type === "json" ? this.resolveJsonOutput(e, t) : this.resolveMarkdownOutput(e, t));
+	}
+	selectCustomStatistics(e, t) {
+		let n = new Map(t.map((e) => [e.label, e]));
+		return (e ?? []).flatMap((e) => {
+			let t = n.get(e);
+			return t === void 0 ? [] : [t];
+		});
+	}
+	parseConfiguration(e) {
+		return this.parseConfigurationInternal(e);
+	}
+	resolveConfiguration(e) {
+		let t = this.resolveCustomStatistics(e.custom);
+		return {
+			custom: t,
+			defaultInput: e.defaultInput,
+			exclude: [.../* @__PURE__ */ new Set([...E, ...e.exclude ?? []])],
+			excludeFrom: e.excludeFrom ?? [],
+			format: e.format,
+			inputs: this.resolveInputs(e.inputs),
+			limits: this.resolveLimits(e.limits),
+			outputs: this.resolveOutputs(e.outputs, t),
+			python: { command: e.python?.command ?? "python3" }
+		};
+	}
+};
+Z = J([l(), q("design:paramtypes", [])], Z);
+//#endregion
+//#region packages/ic-suite/codometer/codometer-configuration/src/modules/configuration/configuration.service.ts
+var Q = class {
+	configurationLoaderService;
+	configurationResolverService;
+	configurationFlagsService;
+	constructor(e, t, n) {
+		this.configurationLoaderService = e, this.configurationResolverService = t, this.configurationFlagsService = n;
+	}
+	async loadConfiguration(e = {}) {
+		let { configuration: t } = await this.loadConfigurationFile(e);
+		return t;
+	}
+	async loadConfigurationFile(e = {}) {
+		let t = await this.configurationLoaderService.load(e);
+		return t === void 0 ? {
+			configuration: this.resolveConfiguration(this.parseConfiguration({})),
+			path: void 0
+		} : {
+			configuration: this.resolveConfiguration(this.parseConfiguration(t.configuration)),
+			path: t.path
+		};
+	}
+	parseConfiguration(e) {
+		return this.configurationResolverService.parseConfiguration(e);
+	}
+	parseDefaultedOption(e, t) {
+		return this.configurationFlagsService.parseDefaultedOption(e, t);
+	}
+	parseDirectoryOption(e) {
+		return this.configurationFlagsService.parseDirectoryOption(e);
+	}
+	parseOptionalOption(e) {
+		return this.configurationFlagsService.parseOptionalOption(e);
+	}
+	resolveConfiguration(e) {
+		return this.configurationResolverService.resolveConfiguration(e);
+	}
+	resolveFormat(e, t, n) {
+		return this.configurationFlagsService.resolveFormat(e, t, n);
+	}
+	selectMode(e) {
+		return this.configurationFlagsService.selectMode(e);
+	}
+};
+Q = J([l(), q("design:paramtypes", [
+	X === void 0 ? Object : X,
+	Z === void 0 ? Object : Z,
+	Y === void 0 ? Object : Y
+])], Q);
+//#endregion
+//#region packages/ic-suite/codometer/codometer-configuration/src/modules/configuration/configuration.module.ts
+var $ = class {};
+$ = J([u({
+	controllers: [],
+	exports: [Q],
+	imports: [],
+	providers: [
+		Y,
+		X,
+		Z,
+		Q
+	]
+})], $);
+//#endregion
+export { _ as CHECK_LIMITS, y as CHECK_NAMES, v as CHECK_REPORTS, b as CHECK_SEPARATOR, P as CODOMETER_ANALYSES, F as CODOMETER_COMMENT_LANGUAGES, I as CODOMETER_COMPRESSIONS, z as CODOMETER_DOCUMENTATION_UNITS, R as CODOMETER_FORMATS, T as CONFIGURATION_FILE_NAMES, $ as ConfigurationModule, Q as ConfigurationService, A as DEFAULT_CODEBASE_INPUT, D as DEFAULT_CUSTOM_STATISTIC_COLORS, O as DEFAULT_CUSTOM_STATISTIC_GROUP, E as DEFAULT_EXCLUDE_GLOBS, ee as DEFAULT_INPUT_COMPRESSION, te as DEFAULT_INPUT_DIRECTORY, k as DEFAULT_INPUT_NAME, ae as DEFAULT_JSON_INDENTATION, ne as DEFAULT_LIMIT_SEVERITY, oe as DEFAULT_MARKDOWN_END_MARKER, j as DEFAULT_MARKDOWN_START_MARKER, M as DEFAULT_PYTHON_COMMAND, x as FORMAT_JSON, S as FORMAT_MARKDOWN, C as FORMAT_NAMES, L as MISSING_FORMAT_MESSAGE, N as REPOSITORY_ROOT_MARKERS, K as codometerConfigurationSchema };

package/package.json

@@ -0,0 +1,64 @@
+{
+  "author": "Jimmy Paolini",
+  "bugs": {
+    "url": "https://github.com/Organizzolini/codebase/issues"
+  },
+  "dependencies": {
+    "@codometer/core": "0.0.1",
+    "@nestjs/common": "^11.1.21 || ^12.0.1",
+    "jiti": "^2.7.0",
+    "jsonc-parser": "^3.3.1",
+    "reflect-metadata": "^0.2.2",
+    "zod": "^4.4.3"
+  },
+  "description": "Configuration loader, limit definitions, and counter resolution for Codometer",
+  "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": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "homepage": "https://github.com/Organizzolini/codebase/tree/main/packages/ic-suite/codometer/codometer-configuration#readme",
+  "keywords": [
+    "codometer",
+    "configuration",
+    "counters",
+    "limits",
+    "thresholds"
+  ],
+  "license": "MIT",
+  "main": "./dist/src/index.js",
+  "name": "@codometer/configuration",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "directory": "packages/ic-suite/codometer/codometer-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.1"
+}