@alveolus/arch 0.3.0 → 0.4.0

package/README.md

@@ -14,6 +14,11 @@ import { defineConfig } from "@alveolus/arch";
 
 export default defineConfig({
 	boundedContexts: { catalog: "catalog", notifications: "notifications", ordering: "ordering" },
+	contextMap: {
+		catalog: { consumes: [] },
+		notifications: { consumes: ["ordering"] },
+		ordering: { consumes: ["catalog"] },
+	},
 	root: "src",
 	subdomains: { core: ["catalog", "ordering"], generic: ["notifications"] },
 });

package/dist/bin.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { r as Cli, t as Docs } from "./docs-DsQHpTtV.mjs";
+import { r as Cli, t as Docs } from "./docs-DcFgskuN.mjs";
 import { fileURLToPath } from "node:url";
 //#region src/bin.ts
 const docs = new Docs(fileURLToPath(new URL("../docs/", import.meta.url)));

package/dist/{docs-DsQHpTtV.mjs → docs-DcFgskuN.mjs}

@@ -839,24 +839,22 @@ var Architecture = class {
 };
 //#endregion
 //#region src/architecture/context-map.ts
-var ContextMap = class ContextMap {
+var ContextMap = class {
 	upstreams;
 	constructor(upstreams) {
 		this.upstreams = upstreams;
 	}
-	static ofEdges(edges) {
-		const upstreams = {};
-		for (const { from, to } of edges) {
-			const known = upstreams[from] ?? [];
-			if (!known.includes(to)) upstreams[from] = [...known, to];
-		}
-		return new ContextMap(upstreams);
-	}
 	get contexts() {
-		const names = new Set(Object.keys(this.upstreams));
+		return Object.keys(this.upstreams);
+	}
+	get consumed() {
+		const names = /* @__PURE__ */ new Set();
 		for (const targets of Object.values(this.upstreams)) for (const target of targets) names.add(target);
 		return [...names];
 	}
+	selfConsumers() {
+		return this.contexts.filter((context) => this.allows(context, context));
+	}
 	allows(from, to) {
 		return (this.upstreams[from] ?? []).includes(to);
 	}
@@ -868,9 +866,6 @@ var ContextMap = class ContextMap {
 			if (found !== void 0) return found;
 		}
 	}
-	cycleThrough(from, to) {
-		return this.reaches(to, from, /* @__PURE__ */ new Set());
-	}
 	cycleFrom(context, path, visiting, done) {
 		if (done.has(context)) return;
 		if (visiting.has(context)) return [...path.slice(path.indexOf(context)), context];
@@ -882,12 +877,6 @@ var ContextMap = class ContextMap {
 		visiting.delete(context);
 		done.add(context);
 	}
-	reaches(from, target, seen) {
-		if (from === target) return true;
-		if (seen.has(from)) return false;
-		seen.add(from);
-		return (this.upstreams[from] ?? []).some((upstream) => this.reaches(upstream, target, seen));
-	}
 };
 //#endregion
 //#region src/rules/framework/wording.ts
@@ -1374,23 +1363,13 @@ var NoLeakyHostServiceRule = class extends ClassRule {
 var NoUnmappedContextRule = class extends Rule {
 	meta = {
 		contexts: "every",
-		description: "A bounded context consuming one the context map does not allow, or two contexts that depend on each other.",
+		description: "A bounded context consuming one the context map does not allow.",
 		id: "strategic/no-unmapped-context",
-		messages: {
-			cycle: "{from} consumes {to}, which consumes {from} back: two contexts that depend on each other can no longer change alone; declare a contextMap and reverse one dependency.",
-			unmapped: "{from} consumes {to}, which the context map does not allow: add {to} to contextMap.{from}, or reverse the dependency."
-		}
+		messages: { unmapped: "{from} consumes {to}, which the context map does not allow: reverse the dependency, or if {from} really is downstream of {to}, add {to} to contextMap.{from}.consumes." }
 	};
 	check(architecture) {
-		const consumptions = this.consumptionsIn(architecture);
-		const declared = architecture.contextMap;
 		const findings = [];
-		if (declared !== void 0) {
-			for (const consumption of consumptions) if (!declared.allows(consumption.from, consumption.to)) findings.push(this.consumptionFinding(consumption, "unmapped"));
-			return findings;
-		}
-		const observed = ContextMap.ofEdges(consumptions);
-		for (const consumption of consumptions) if (observed.cycleThrough(consumption.from, consumption.to)) findings.push(this.consumptionFinding(consumption, "cycle"));
+		for (const consumption of this.consumptionsIn(architecture)) if (!architecture.contextMap.allows(consumption.from, consumption.to)) findings.push(this.consumptionFinding(consumption));
 		return findings;
 	}
 	consumptionsIn(architecture) {
@@ -1411,9 +1390,9 @@ var NoUnmappedContextRule = class extends Rule {
 		}
 		return consumptions;
 	}
-	consumptionFinding(consumption, messageId) {
+	consumptionFinding(consumption) {
 		const { dependency, file, from, to } = consumption;
-		return this.finding(file, dependency.line, dependency.label, messageId, {
+		return this.finding(file, dependency.line, dependency.label, "unmapped", {
 			from,
 			to
 		});
@@ -2118,7 +2097,7 @@ var Config = class {
 		this.applicationDependencies = this.domainDependencies.with(new AllowedPackages(config.applicationDependencies));
 		this.ignored = [...testFiles, ...config.ignore ?? []];
 		this.extraFolders = config.layout?.extraFolders ?? {};
-		this.contextMap = config.contextMap === void 0 ? void 0 : this.validContextMap(config.contextMap, Object.keys(config.boundedContexts));
+		this.contextMap = this.validContextMap(config.contextMap, Object.keys(config.boundedContexts));
 		this.rules = config.rules;
 		const sharedKernel = config.sharedKernel ?? "shared-kernel";
 		this.contextFolders = [...this.classifiedContexts(config.subdomains ?? {}, config.boundedContexts), {
@@ -2152,10 +2131,16 @@ var Config = class {
 		if (unclassified.length > 0) throw new Error(`boundedContexts declares ${unclassified.join(", ")}, which subdomains does not classify: list each context under subdomains.core, subdomains.supporting or subdomains.generic.`);
 		return folders;
 	}
-	validContextMap(upstreams, contexts) {
+	validContextMap(relations, contexts) {
+		const upstreams = {};
+		for (const [name, { consumes }] of Object.entries(relations)) upstreams[name] = consumes;
 		const map = new ContextMap(upstreams);
-		const unknown = map.contexts.filter((name) => !contexts.includes(name));
+		const unknown = [.../* @__PURE__ */ new Set([...map.contexts, ...map.consumed])].filter((name) => !contexts.includes(name));
 		if (unknown.length > 0) throw new Error(`contextMap names ${unknown.join(", ")}, which boundedContexts does not declare.`);
+		const unlisted = contexts.filter((name) => !map.contexts.includes(name));
+		if (unlisted.length > 0) throw new Error(`contextMap does not list ${unlisted.join(", ")}: every bounded context lists the contexts it consumes, consumes: [] when none.`);
+		const selfConsumers = map.selfConsumers();
+		if (selfConsumers.length > 0) throw new Error(`contextMap lists ${selfConsumers.join(", ")} as consuming itself: a context consumes other contexts only.`);
 		const cycle = map.cycle();
 		if (cycle !== void 0) throw new Error(`contextMap has a cycle: ${cycle.join(" → ")}. Two contexts that depend on each other can no longer change alone: reverse one dependency.`);
 		return map;
@@ -2182,7 +2167,7 @@ const schema = z.strictObject({
 	applicationDependencies: packageDependencies.exactOptional(),
 	boundedContexts: z.record(z.string(), z.string()),
 	compositionRoot: z.string().exactOptional(),
-	contextMap: z.record(z.string(), z.array(z.string())).exactOptional(),
+	contextMap: z.record(z.string(), z.strictObject({ consumes: z.array(z.string()) })),
 	domainDependencies: packageDependencies.exactOptional(),
 	ignore: z.array(z.string()).exactOptional(),
 	layout: z.strictObject({ extraFolders: z.strictObject({
@@ -2781,6 +2766,7 @@ const scaffolds = [
 
 export default defineConfig({
 	boundedContexts: {},
+	contextMap: {},
 	root: "src",
 });
 `,
@@ -2799,7 +2785,7 @@ The documentation is installed with the package: read it with \`npx alveolus exp
 1. Before writing a class, read its building block: \`npx alveolus explain aggregates\`, \`entities\`, \`value-objects\`, \`domain-events\`, \`domain-errors\`, \`ports\`, \`repositories\`, \`command-handlers\`, \`query-handlers\`, \`result\`.
 2. Where a file goes and what each layer may import: \`npx alveolus explain project-layout\`.
 3. After each change, run \`npx alveolus arch check\`.
-4. On a violation, read the rule before changing the code: \`npx alveolus explain <rule>\`, with the rule id of the report, such as \`layers/no-impure-domain\`. Fix the cause: never turn a rule off, add a disable comment or edit \`alveolus.baseline.json\` by hand without asking.
+4. On a violation, read the rule before changing the code: \`npx alveolus explain <rule>\`, with the rule id of the report, such as \`layers/no-impure-domain\`. Fix the cause: never turn a rule off, add a disable comment, add a context to \`contextMap\` or edit \`alveolus.baseline.json\` by hand without asking.
 `,
 		path: ".claude/skills/alveolus/SKILL.md"
 	},
@@ -3056,4 +3042,4 @@ var Docs = class Docs {
 //#endregion
 export { TsMorphImporter as a, Config as c, RuleRegistry as d, Rule as f, Baseline as h, Init as i, Report as l, AllowedPackages as m, Page as n, Importer as o, Architecture as p, Cli as r, ConfigLoader as s, Docs as t, Checker as u };
 
-//# sourceMappingURL=docs-DsQHpTtV.mjs.map
+//# sourceMappingURL=docs-DcFgskuN.mjs.map