@mark1russell7/boundaries 0.0.0-bootstrap.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mark Russell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,73 @@
 # @mark1russell7/boundaries
 
-This version is a placeholder. The release workflow of https://github.com/mark1russell7/template publishes the real versions. Use a later version.
+This package gives the import boundaries of a pnpm workspace as a [dependency-cruiser](https://github.com/sverweij/dependency-cruiser) configuration. Each package is a unit. Another package imports it only through an entry of its `package.json`.
+
+## Rules
+
+| Rule | It fails when |
+|---|---|
+| `relative-import-out-of-<package>` | A relative import (`../../b/src/x.js`) goes into the folder of a different package. |
+| `deep-import-into-<package>` | An import gets to a file of a package that is not an entry of its `package.json` (`exports`, `main`, `module`, `types` or `bin`). |
+| `not-a-declared-export` | An import of a workspace package does not resolve. The path is not in its `exports`, or the package is not built. |
+| `import-of-the-app-<package>` | A package imports an app. An app is a leaf of the graph. This rule is only on with the option `apps`. |
+
+A type-only import is a boundary too. Tests, fixtures and declaration files are not part of a boundary.
+
+## Use
+
+Install the package, `dependency-cruiser` and, for TypeScript 7 or for source with no TypeScript compiler, `@swc/core`:
+
+```sh
+pnpm add -D @mark1russell7/boundaries dependency-cruiser @swc/core
+```
+
+Write `.dependency-cruiser.mjs` at the root of the repository:
+
+```js
+import { boundaries } from "@mark1russell7/boundaries";
+
+export default boundaries(import.meta.dirname);
+```
+
+Add the script `"check:boundaries": "depcruise --config .dependency-cruiser.mjs packages"`. The shared CI of the template starts `check:boundaries` after `build` (`CI.md`).
+
+## Options
+
+`boundaries(root, options)` reads the packages of `pnpm-workspace.yaml`. These options change it:
+
+| Option | Default | What it sets |
+|---|---|---|
+| `packages` | the `packages` list of `pnpm-workspace.yaml` | The globs of the package folders. |
+| `apps` | none | The apps. `"private"` makes each private package an app. |
+| `reference` | none | A text before each comment, for example the name of the decision record. |
+| `forbidden` | none | More rules of the repository, after the rules of the boundaries. |
+| `options` | the default options | More options of dependency-cruiser. They replace the default options that have the same key. |
+
+An example with the rules of a repository:
+
+```js
+const { boundaries } = require("@mark1russell7/boundaries");
+
+module.exports = boundaries(__dirname, {
+  apps: "private",
+  reference: "Invariant I9 of ARCHITECTURE.md.",
+  forbidden: [
+    {
+      name: "transport-imports-server",
+      severity: "error",
+      from: { path: "^packages/client/src/adapters/" },
+      to: { path: "^packages/server/" },
+    },
+  ],
+});
+```
+
+## The parser
+
+dependency-cruiser reads TypeScript with the TypeScript compiler of the repository only for TypeScript 2 to 6. With TypeScript 7, or with no TypeScript, `boundaries()` sets the parser `swc` when `@swc/core` is installed. Without `@swc/core`, dependency-cruiser reads only JavaScript. That is enough for a check of built JavaScript.
+
+## Other exports
+
+- `boundaryRules(packages, options)` gives only the rules, for a list of packages.
+- `workspacePackages(root, globs)` gives the packages of the workspace and their entries.
+- `defaultOptions(root)` and `parserOptions(root)` give the default options.

package/build/index.cjs

@@ -0,0 +1,269 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let node_fs = require("node:fs");
+let node_module = require("node:module");
+let node_path = require("node:path");
+// src/index.ts
+/**
+* The import boundaries of a workspace, as a dependency-cruiser configuration. Each package is a
+* unit. Another package imports it only through an entry of its package.json (`exports`, `main`,
+* `module`, `types`, `bin`). A relative path or a deep path into its folder is not an entry.
+*
+* A repository uses it from its `.dependency-cruiser.cjs`:
+*
+* ```js
+* const { boundaries } = require("@mark1russell7/boundaries");
+* module.exports = boundaries(__dirname, { apps: "private" });
+* ```
+*/
+const escape = (text) => text.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+/** The `packages` list of a pnpm-workspace.yaml file. It reads only that list, with no YAML library. */
+function workspaceGlobs(yaml) {
+	const globs = [];
+	let inList = false;
+	for (const raw of yaml.split(/\r?\n/)) {
+		const hash = raw.indexOf(" #");
+		const line = (hash === -1 ? raw : raw.slice(0, hash)).trimEnd();
+		const trimmed = line.trimStart();
+		if (trimmed === "" || trimmed.startsWith("#")) continue;
+		if (/^packages\s*:/.test(line)) {
+			inList = true;
+			continue;
+		}
+		if (!inList) continue;
+		if (trimmed === line) break;
+		if (!trimmed.startsWith("-")) continue;
+		const item = trimmed.slice(1).trim().replace(/^["']/, "").replace(/["']$/, "");
+		if (item) globs.push(item);
+	}
+	return globs;
+}
+function isDir(path) {
+	try {
+		return (0, node_fs.statSync)(path).isDirectory();
+	} catch {
+		return false;
+	}
+}
+/** The folders that a glob of pnpm-workspace.yaml gives: "a/b", "a/*" and "a/**". */
+function expand(root, glob) {
+	const clean = glob.replace(/^\.\//, "").replace(/\/$/, "");
+	const star = clean.indexOf("*");
+	if (star === -1) return isDir((0, node_path.join)(root, clean)) ? [clean] : [];
+	const base = clean.slice(0, star).replace(/\/$/, "");
+	const recursive = clean.slice(star).startsWith("**");
+	const found = [];
+	const walk = (dir, depth) => {
+		let entries;
+		try {
+			entries = (0, node_fs.readdirSync)((0, node_path.join)(root, dir), { withFileTypes: true });
+		} catch {
+			return;
+		}
+		for (const entry of entries) {
+			if (!entry.isDirectory() || entry.name === "node_modules" || entry.name.startsWith(".")) continue;
+			const child = dir === "" ? entry.name : `${dir}/${entry.name}`;
+			found.push(child);
+			if (recursive && depth < 6) walk(child, depth + 1);
+		}
+	};
+	walk(base, 0);
+	return found;
+}
+/** The leaf strings of an `exports` value, with their subpath keys. */
+function exportTargets(value, out = []) {
+	if (typeof value === "string") out.push(value);
+	else if (Array.isArray(value)) for (const item of value) exportTargets(item, out);
+	else if (value && typeof value === "object") for (const item of Object.values(value)) exportTargets(item, out);
+	return out;
+}
+/**
+* The RegExp source of an entry target of a package. The extension can change, because
+* dependency-cruiser resolves "./x.js" to the source file x.ts, and "*" of a subpath pattern matches
+* each path.
+*/
+function entryPattern(dir, target) {
+	return `^${node_path.posix.normalize(node_path.posix.join(dir, target.replace(/^\.\//, ""))).replace(/\.d\.[cm]?ts$|\.[cm]?[jt]sx?$/, "").split("*").map(escape).join(".*")}(${EXTENSIONS})?$`;
+}
+const EXTENSIONS = [
+	".js",
+	".mjs",
+	".cjs",
+	".jsx",
+	".ts",
+	".mts",
+	".cts",
+	".tsx",
+	".d.ts",
+	".d.mts",
+	".d.cts"
+].map(escape).join("|");
+/** The entries of a package.json: the files that other packages can import. */
+function packageEntries(dir, manifest) {
+	const targets = exportTargets(manifest["exports"]);
+	for (const field of [
+		"main",
+		"module",
+		"types",
+		"typings"
+	]) {
+		const value = manifest[field];
+		if (typeof value === "string") targets.push(value);
+	}
+	if (typeof manifest["bin"] === "string") targets.push(manifest["bin"]);
+	else if (manifest["bin"] && typeof manifest["bin"] === "object") targets.push(...exportTargets(manifest["bin"]));
+	if (targets.length === 0 && manifest["exports"] === void 0) targets.push("./index.js");
+	return [...new Set(targets.filter((t) => !t.endsWith(".json") || t === "./package.json").map((t) => entryPattern(dir, t)))];
+}
+/** The packages of the workspace in the folder `root`. */
+function workspacePackages(root, globs) {
+	let list = globs;
+	if (!list) {
+		try {
+			list = workspaceGlobs((0, node_fs.readFileSync)((0, node_path.join)(root, "pnpm-workspace.yaml"), "utf8"));
+		} catch {
+			list = [];
+		}
+		if (list.length === 0) list = ["packages/*"];
+	}
+	const excluded = list.filter((g) => g.startsWith("!")).flatMap((g) => expand(root, g.slice(1)));
+	const dirs = [...new Set(list.filter((g) => !g.startsWith("!")).flatMap((g) => expand(root, g)))].filter((d) => !excluded.includes(d));
+	const found = [];
+	for (const dir of dirs.sort()) {
+		let manifest;
+		try {
+			manifest = JSON.parse((0, node_fs.readFileSync)((0, node_path.join)(root, dir, "package.json"), "utf8"));
+		} catch {
+			continue;
+		}
+		if (typeof manifest["name"] !== "string") continue;
+		found.push({
+			name: manifest["name"],
+			dir,
+			private: manifest["private"] === true,
+			entries: packageEntries(dir, manifest)
+		});
+	}
+	return found;
+}
+/** The rules of the boundaries for a list of packages. `boundaries()` reads the list from the workspace. */
+function boundaryRules(packages, opts = {}) {
+	const why = (text) => opts.reference ? `${opts.reference} ${text}` : text;
+	const anyPackage = packages.map((p) => `^${escape(p.dir)}/`);
+	const rules = [];
+	for (const pkg of packages) {
+		const own = `^${escape(pkg.dir)}/`;
+		const others = anyPackage.filter((path) => path !== own);
+		if (others.length > 0) rules.push({
+			name: `relative-import-out-of-${slug(pkg.name)}`,
+			severity: "error",
+			comment: why(`A relative import leaves the package ${pkg.name}. Import the other package by its name, through an entry of its package.json.`),
+			from: { path: own },
+			to: {
+				path: others,
+				pathNot: own,
+				dependencyTypes: ["local"]
+			}
+		});
+		rules.push({
+			name: `deep-import-into-${slug(pkg.name)}`,
+			severity: "error",
+			comment: why(`An import reaches into the folder of ${pkg.name} at a file that is not an entry of its package.json (exports, main, module, types or bin). Import an entry, or add the file to the exports of ${pkg.name}.`),
+			from: { pathNot: own },
+			to: pkg.entries.length > 0 ? {
+				path: own,
+				pathNot: pkg.entries
+			} : { path: own }
+		});
+	}
+	const names = packages.map((p) => escape(p.name));
+	if (names.length > 0) rules.push({
+		name: "not-a-declared-export",
+		severity: "error",
+		comment: why("An import of a package of this workspace does not resolve. The path is not an entry of its exports, or the package is not built."),
+		from: {},
+		to: {
+			path: `^(${names.join("|")})(/|$)`,
+			couldNotResolve: true
+		}
+	});
+	const apps = opts.apps === "private" ? packages.filter((p) => p.private) : packages.filter((p) => (opts.apps ?? []).includes(p.name));
+	for (const app of apps) rules.push({
+		name: `import-of-the-app-${slug(app.name)}`,
+		severity: "error",
+		comment: why(`A package imports the app ${app.name}. An app is a leaf: no other package imports it. Move the shared code to a library package.`),
+		from: { pathNot: `^${escape(app.dir)}/` },
+		to: { path: `^${escape(app.dir)}/` }
+	});
+	return rules;
+}
+const slug = (name) => name.replace(/^@/, "").replace(/[^A-Za-z0-9]+/g, "-");
+/**
+* The parser of the TypeScript source. dependency-cruiser reads TypeScript with the TypeScript
+* compiler of the repository only for TypeScript 2 to 6. With TypeScript 7 or no TypeScript, it reads
+* TypeScript with swc when @swc/core is installed. Else it reads only JavaScript (acorn): that is
+* enough for a check of built JavaScript.
+*/
+function parserOptions(root) {
+	if (!root) return {};
+	const require$1 = (0, node_module.createRequire)((0, node_path.join)(root, "package.json"));
+	try {
+		const { version } = require$1("typescript/package.json");
+		if (Number(version.split(".")[0]) < 7) return { tsPreCompilationDeps: true };
+	} catch {}
+	for (const from of [require$1, (0, node_module.createRequire)(require("url").pathToFileURL(__filename).href)]) try {
+		from.resolve("@swc/core");
+		return { parser: "swc" };
+	} catch {}
+	return {};
+}
+/**
+* The default options: the source of the packages, with type-only imports, resolved as Node resolves
+* them. There is no `includeOnly`, because it also removes the imports that do not resolve, and the
+* rule not-a-declared-export needs them. The "types" condition is not used: it resolves to a
+* declaration file, and the analysis excludes declaration files, so a deep import does not show.
+*/
+function defaultOptions(root) {
+	return {
+		...parserOptions(root),
+		exclude: { path: [
+			"(^|/)node_modules/",
+			"\\.(test|spec|e2e)\\.[cm]?[jt]sx?$",
+			"\\.d\\.[cm]?ts$",
+			"/(test|tests|e2e|__tests__|fixtures)/"
+		] },
+		doNotFollow: { path: ["(^|/)node_modules/"] },
+		enhancedResolveOptions: {
+			exportsFields: ["exports"],
+			conditionNames: [
+				"import",
+				"require",
+				"node",
+				"default"
+			],
+			mainFields: ["module", "main"]
+		},
+		skipAnalysisNotInRules: true
+	};
+}
+/** The dependency-cruiser configuration of the boundaries for the workspace in the folder `root`. */
+function boundaries(root, opts = {}) {
+	const packages = workspacePackages(root, opts.packages);
+	const options = {
+		...defaultOptions(root),
+		...opts.options
+	};
+	return {
+		forbidden: [...boundaryRules(packages, opts), ...opts.forbidden ?? []],
+		options
+	};
+}
+exports.boundaries = boundaries;
+exports.boundaryRules = boundaryRules;
+exports.defaultOptions = defaultOptions;
+exports.entryPattern = entryPattern;
+exports.packageEntries = packageEntries;
+exports.parserOptions = parserOptions;
+exports.workspaceGlobs = workspaceGlobs;
+exports.workspacePackages = workspacePackages;
+
+//# sourceMappingURL=index.cjs.map

package/build/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["statSync","join","readdirSync","posix","readFileSync","require","createRequire"],"sources":["../src/index.ts"],"sourcesContent":["/**\n * The import boundaries of a workspace, as a dependency-cruiser configuration. Each package is a\n * unit. Another package imports it only through an entry of its package.json (`exports`, `main`,\n * `module`, `types`, `bin`). A relative path or a deep path into its folder is not an entry.\n *\n * A repository uses it from its `.dependency-cruiser.cjs`:\n *\n * ```js\n * const { boundaries } = require(\"@mark1russell7/boundaries\");\n * module.exports = boundaries(__dirname, { apps: \"private\" });\n * ```\n */\nimport { readdirSync, readFileSync, statSync } from \"node:fs\";\nimport { createRequire } from \"node:module\";\nimport { join, posix } from \"node:path\";\n\n/** A rule of dependency-cruiser (the `forbidden` list). The package does not depend on the types of dependency-cruiser. */\nexport interface Rule {\n  name: string;\n  severity: \"error\" | \"warn\" | \"info\" | \"ignore\";\n  comment?: string;\n  from: Record<string, unknown>;\n  to: Record<string, unknown>;\n}\n\n/** A dependency-cruiser configuration. */\nexport interface Config {\n  forbidden: Rule[];\n  options: Record<string, unknown>;\n}\n\n/** A package of the workspace. */\nexport interface WorkspacePackage {\n  /** The name in package.json. */\n  name: string;\n  /** The folder, relative to the root, with \"/\". */\n  dir: string;\n  private: boolean;\n  /** RegExp sources of the files that other packages can import. */\n  entries: string[];\n}\n\nexport interface BoundaryOptions {\n  /**\n   * Globs of the package folders, for example `[\"packages/*\"]`. The default is the `packages` list of\n   * pnpm-workspace.yaml, or `[\"packages/*\"]` when the file does not exist.\n   */\n  packages?: string[];\n  /** The apps: the leaves of the graph, which no other package imports. \"private\" means each private package. */\n  apps?: \"private\" | string[];\n  /** A text before each comment, for example the decision record of the rules. */\n  reference?: string;\n  /** More rules, after the rules of the boundaries. */\n  forbidden?: Rule[];\n  /** More options of dependency-cruiser. They replace the default options with the same key. */\n  options?: Record<string, unknown>;\n}\n\nconst escape = (text: string): string => text.replace(/[.*+?^${}()|[\\]\\\\]/g, \"\\\\$&\");\n\n/** The `packages` list of a pnpm-workspace.yaml file. It reads only that list, with no YAML library. */\nexport function workspaceGlobs(yaml: string): string[] {\n  const globs: string[] = [];\n  let inList = false;\n  // String operations, not one large RegExp: a RegExp with nested whitespace groups can be slow on some input.\n  for (const raw of yaml.split(/\\r?\\n/)) {\n    const hash = raw.indexOf(\" #\");\n    const line = (hash === -1 ? raw : raw.slice(0, hash)).trimEnd();\n    const trimmed = line.trimStart();\n    if (trimmed === \"\" || trimmed.startsWith(\"#\")) continue;\n    if (/^packages\\s*:/.test(line)) {\n      inList = true;\n      continue;\n    }\n    if (!inList) continue;\n    if (trimmed === line) break;\n    if (!trimmed.startsWith(\"-\")) continue;\n    const item = trimmed.slice(1).trim().replace(/^[\"']/, \"\").replace(/[\"']$/, \"\");\n    if (item) globs.push(item);\n  }\n  return globs;\n}\n\nfunction isDir(path: string): boolean {\n  try {\n    return statSync(path).isDirectory();\n  } catch {\n    return false;\n  }\n}\n\n/** The folders that a glob of pnpm-workspace.yaml gives: \"a/b\", \"a/*\" and \"a/**\". */\nfunction expand(root: string, glob: string): string[] {\n  const clean = glob.replace(/^\\.\\//, \"\").replace(/\\/$/, \"\");\n  const star = clean.indexOf(\"*\");\n  if (star === -1) return isDir(join(root, clean)) ? [clean] : [];\n  const base = clean.slice(0, star).replace(/\\/$/, \"\");\n  const recursive = clean.slice(star).startsWith(\"**\");\n  const found: string[] = [];\n  const walk = (dir: string, depth: number): void => {\n    let entries;\n    try {\n      entries = readdirSync(join(root, dir), { withFileTypes: true });\n    } catch {\n      return;\n    }\n    for (const entry of entries) {\n      if (!entry.isDirectory() || entry.name === \"node_modules\" || entry.name.startsWith(\".\")) continue;\n      const child = dir === \"\" ? entry.name : `${dir}/${entry.name}`;\n      found.push(child);\n      if (recursive && depth < 6) walk(child, depth + 1);\n    }\n  };\n  walk(base, 0);\n  return found;\n}\n\n/** The leaf strings of an `exports` value, with their subpath keys. */\nfunction exportTargets(value: unknown, out: string[] = []): string[] {\n  if (typeof value === \"string\") out.push(value);\n  else if (Array.isArray(value)) for (const item of value) exportTargets(item, out);\n  else if (value && typeof value === \"object\") for (const item of Object.values(value)) exportTargets(item, out);\n  return out;\n}\n\n/**\n * The RegExp source of an entry target of a package. The extension can change, because\n * dependency-cruiser resolves \"./x.js\" to the source file x.ts, and \"*\" of a subpath pattern matches\n * each path.\n */\nexport function entryPattern(dir: string, target: string): string {\n  const path = posix.normalize(posix.join(dir, target.replace(/^\\.\\//, \"\")));\n  const stem = path.replace(/\\.d\\.[cm]?ts$|\\.[cm]?[jt]sx?$/, \"\");\n  const source = stem.split(\"*\").map(escape).join(\".*\");\n  // A flat list, because dependency-cruiser refuses a RegExp with nested quantifiers (safe-regex).\n  return `^${source}(${EXTENSIONS})?$`;\n}\n\nconst EXTENSIONS = [\".js\", \".mjs\", \".cjs\", \".jsx\", \".ts\", \".mts\", \".cts\", \".tsx\", \".d.ts\", \".d.mts\", \".d.cts\"].map(escape).join(\"|\");\n\n/** The entries of a package.json: the files that other packages can import. */\nexport function packageEntries(dir: string, manifest: Record<string, unknown>): string[] {\n  const targets = exportTargets(manifest[\"exports\"]);\n  for (const field of [\"main\", \"module\", \"types\", \"typings\"]) {\n    const value = manifest[field];\n    if (typeof value === \"string\") targets.push(value);\n  }\n  if (typeof manifest[\"bin\"] === \"string\") targets.push(manifest[\"bin\"]);\n  else if (manifest[\"bin\"] && typeof manifest[\"bin\"] === \"object\") targets.push(...exportTargets(manifest[\"bin\"]));\n  // With no entry field, Node resolves the package to index.js.\n  if (targets.length === 0 && manifest[\"exports\"] === undefined) targets.push(\"./index.js\");\n  return [...new Set(targets.filter((t) => !t.endsWith(\".json\") || t === \"./package.json\").map((t) => entryPattern(dir, t)))];\n}\n\n/** The packages of the workspace in the folder `root`. */\nexport function workspacePackages(root: string, globs?: string[]): WorkspacePackage[] {\n  let list = globs;\n  if (!list) {\n    try {\n      list = workspaceGlobs(readFileSync(join(root, \"pnpm-workspace.yaml\"), \"utf8\"));\n    } catch {\n      list = [];\n    }\n    if (list.length === 0) list = [\"packages/*\"];\n  }\n  const excluded = list.filter((g) => g.startsWith(\"!\")).flatMap((g) => expand(root, g.slice(1)));\n  const dirs = [...new Set(list.filter((g) => !g.startsWith(\"!\")).flatMap((g) => expand(root, g)))].filter((d) => !excluded.includes(d));\n  const found: WorkspacePackage[] = [];\n  for (const dir of dirs.sort()) {\n    let manifest: Record<string, unknown>;\n    try {\n      manifest = JSON.parse(readFileSync(join(root, dir, \"package.json\"), \"utf8\")) as Record<string, unknown>;\n    } catch {\n      continue;\n    }\n    if (typeof manifest[\"name\"] !== \"string\") continue;\n    found.push({ name: manifest[\"name\"], dir, private: manifest[\"private\"] === true, entries: packageEntries(dir, manifest) });\n  }\n  return found;\n}\n\n/** The rules of the boundaries for a list of packages. `boundaries()` reads the list from the workspace. */\nexport function boundaryRules(packages: WorkspacePackage[], opts: Pick<BoundaryOptions, \"apps\" | \"reference\"> = {}): Rule[] {\n  const why = (text: string): string => (opts.reference ? `${opts.reference} ${text}` : text);\n  const anyPackage = packages.map((p) => `^${escape(p.dir)}/`);\n  const rules: Rule[] = [];\n  for (const pkg of packages) {\n    const own = `^${escape(pkg.dir)}/`;\n    const others = anyPackage.filter((path) => path !== own);\n    if (others.length > 0) {\n      rules.push({\n        name: `relative-import-out-of-${slug(pkg.name)}`,\n        severity: \"error\",\n        comment: why(`A relative import leaves the package ${pkg.name}. Import the other package by its name, through an entry of its package.json.`),\n        from: { path: own },\n        to: { path: others, pathNot: own, dependencyTypes: [\"local\"] },\n      });\n    }\n    rules.push({\n      name: `deep-import-into-${slug(pkg.name)}`,\n      severity: \"error\",\n      comment: why(\n        `An import reaches into the folder of ${pkg.name} at a file that is not an entry of its package.json (exports, main, module, types or bin). Import an entry, or add the file to the exports of ${pkg.name}.`,\n      ),\n      from: { pathNot: own },\n      to: pkg.entries.length > 0 ? { path: own, pathNot: pkg.entries } : { path: own },\n    });\n  }\n  const names = packages.map((p) => escape(p.name));\n  if (names.length > 0) {\n    rules.push({\n      name: \"not-a-declared-export\",\n      severity: \"error\",\n      comment: why(\"An import of a package of this workspace does not resolve. The path is not an entry of its exports, or the package is not built.\"),\n      from: {},\n      to: { path: `^(${names.join(\"|\")})(/|$)`, couldNotResolve: true },\n    });\n  }\n  const apps =\n    opts.apps === \"private\" ? packages.filter((p) => p.private) : packages.filter((p) => (opts.apps ?? []).includes(p.name));\n  for (const app of apps) {\n    rules.push({\n      name: `import-of-the-app-${slug(app.name)}`,\n      severity: \"error\",\n      comment: why(`A package imports the app ${app.name}. An app is a leaf: no other package imports it. Move the shared code to a library package.`),\n      from: { pathNot: `^${escape(app.dir)}/` },\n      to: { path: `^${escape(app.dir)}/` },\n    });\n  }\n  return rules;\n}\n\nconst slug = (name: string): string => name.replace(/^@/, \"\").replace(/[^A-Za-z0-9]+/g, \"-\");\n\n/**\n * The parser of the TypeScript source. dependency-cruiser reads TypeScript with the TypeScript\n * compiler of the repository only for TypeScript 2 to 6. With TypeScript 7 or no TypeScript, it reads\n * TypeScript with swc when @swc/core is installed. Else it reads only JavaScript (acorn): that is\n * enough for a check of built JavaScript.\n */\nexport function parserOptions(root?: string): Record<string, unknown> {\n  if (!root) return {};\n  const require = createRequire(join(root, \"package.json\"));\n  try {\n    const { version } = require(\"typescript/package.json\") as { version: string };\n    // A type-only import is a boundary too. This option needs the TypeScript compiler.\n    if (Number(version.split(\".\")[0]) < 7) return { tsPreCompilationDeps: true };\n  } catch {\n    // No TypeScript in the repository\n  }\n  // @swc/core from the repository, or next to this package (a peer dependency)\n  for (const from of [require, createRequire(import.meta.url)]) {\n    try {\n      from.resolve(\"@swc/core\");\n      return { parser: \"swc\" };\n    } catch {\n      // Not there\n    }\n  }\n  return {};\n}\n\n/**\n * The default options: the source of the packages, with type-only imports, resolved as Node resolves\n * them. There is no `includeOnly`, because it also removes the imports that do not resolve, and the\n * rule not-a-declared-export needs them. The \"types\" condition is not used: it resolves to a\n * declaration file, and the analysis excludes declaration files, so a deep import does not show.\n */\nexport function defaultOptions(root?: string): Record<string, unknown> {\n  return {\n    ...parserOptions(root),\n    exclude: {\n      path: [\"(^|/)node_modules/\", \"\\\\.(test|spec|e2e)\\\\.[cm]?[jt]sx?$\", \"\\\\.d\\\\.[cm]?ts$\", \"/(test|tests|e2e|__tests__|fixtures)/\"],\n    },\n    doNotFollow: { path: [\"(^|/)node_modules/\"] },\n    enhancedResolveOptions: {\n      exportsFields: [\"exports\"],\n      conditionNames: [\"import\", \"require\", \"node\", \"default\"],\n      mainFields: [\"module\", \"main\"],\n    },\n    skipAnalysisNotInRules: true,\n  };\n}\n\n/** The dependency-cruiser configuration of the boundaries for the workspace in the folder `root`. */\nexport function boundaries(root: string, opts: BoundaryOptions = {}): Config {\n  const packages = workspacePackages(root, opts.packages);\n  const options = { ...defaultOptions(root), ...opts.options };\n  return {\n    forbidden: [...boundaryRules(packages, opts), ...(opts.forbidden ?? [])],\n    options,\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AA0DA,MAAM,UAAU,SAAyB,KAAK,QAAQ,uBAAuB,MAAM;;AAGnF,SAAgB,eAAe,MAAwB;CACrD,MAAM,QAAkB,CAAC;CACzB,IAAI,SAAS;CAEb,KAAK,MAAM,OAAO,KAAK,MAAM,OAAO,GAAG;EACrC,MAAM,OAAO,IAAI,QAAQ,IAAI;EAC7B,MAAM,QAAQ,SAAS,KAAK,MAAM,IAAI,MAAM,GAAG,IAAI,EAAA,CAAG,QAAQ;EAC9D,MAAM,UAAU,KAAK,UAAU;EAC/B,IAAI,YAAY,MAAM,QAAQ,WAAW,GAAG,GAAG;EAC/C,IAAI,gBAAgB,KAAK,IAAI,GAAG;GAC9B,SAAS;GACT;EACF;EACA,IAAI,CAAC,QAAQ;EACb,IAAI,YAAY,MAAM;EACtB,IAAI,CAAC,QAAQ,WAAW,GAAG,GAAG;EAC9B,MAAM,OAAO,QAAQ,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,SAAS,EAAE,CAAC,CAAC,QAAQ,SAAS,EAAE;EAC7E,IAAI,MAAM,MAAM,KAAK,IAAI;CAC3B;CACA,OAAO;AACT;AAEA,SAAS,MAAM,MAAuB;CACpC,IAAI;EACF,QAAA,GAAOA,QAAAA,SAAAA,CAAS,IAAI,CAAC,CAAC,YAAY;CACpC,QAAQ;EACN,OAAO;CACT;AACF;;AAGA,SAAS,OAAO,MAAc,MAAwB;CACpD,MAAM,QAAQ,KAAK,QAAQ,SAAS,EAAE,CAAC,CAAC,QAAQ,OAAO,EAAE;CACzD,MAAM,OAAO,MAAM,QAAQ,GAAG;CAC9B,IAAI,SAAS,IAAI,OAAO,OAAA,GAAMC,UAAAA,KAAAA,CAAK,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;CAC9D,MAAM,OAAO,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,QAAQ,OAAO,EAAE;CACnD,MAAM,YAAY,MAAM,MAAM,IAAI,CAAC,CAAC,WAAW,IAAI;CACnD,MAAM,QAAkB,CAAC;CACzB,MAAM,QAAQ,KAAa,UAAwB;EACjD,IAAI;EACJ,IAAI;GACF,WAAA,GAAUC,QAAAA,YAAAA,EAAAA,GAAYD,UAAAA,KAAAA,CAAK,MAAM,GAAG,GAAG,EAAE,eAAe,KAAK,CAAC;EAChE,QAAQ;GACN;EACF;EACA,KAAK,MAAM,SAAS,SAAS;GAC3B,IAAI,CAAC,MAAM,YAAY,KAAK,MAAM,SAAS,kBAAkB,MAAM,KAAK,WAAW,GAAG,GAAG;GACzF,MAAM,QAAQ,QAAQ,KAAK,MAAM,OAAO,GAAG,IAAI,GAAG,MAAM;GACxD,MAAM,KAAK,KAAK;GAChB,IAAI,aAAa,QAAQ,GAAG,KAAK,OAAO,QAAQ,CAAC;EACnD;CACF;CACA,KAAK,MAAM,CAAC;CACZ,OAAO;AACT;;AAGA,SAAS,cAAc,OAAgB,MAAgB,CAAC,GAAa;CACnE,IAAI,OAAO,UAAU,UAAU,IAAI,KAAK,KAAK;MACxC,IAAI,MAAM,QAAQ,KAAK,GAAG,KAAK,MAAM,QAAQ,OAAO,cAAc,MAAM,GAAG;MAC3E,IAAI,SAAS,OAAO,UAAU,UAAU,KAAK,MAAM,QAAQ,OAAO,OAAO,KAAK,GAAG,cAAc,MAAM,GAAG;CAC7G,OAAO;AACT;;;;;;AAOA,SAAgB,aAAa,KAAa,QAAwB;CAKhE,OAAO,IAJME,UAAAA,MAAM,UAAUA,UAAAA,MAAM,KAAK,KAAK,OAAO,QAAQ,SAAS,EAAE,CAAC,CACxD,CAAC,CAAC,QAAQ,iCAAiC,EACzC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,KAAK,IAEhC,EAAE,GAAG,WAAW;AAClC;AAEA,MAAM,aAAa;CAAC;CAAO;CAAQ;CAAQ;CAAQ;CAAO;CAAQ;CAAQ;CAAQ;CAAS;CAAU;AAAQ,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,KAAK,GAAG;;AAGnI,SAAgB,eAAe,KAAa,UAA6C;CACvF,MAAM,UAAU,cAAc,SAAS,UAAU;CACjD,KAAK,MAAM,SAAS;EAAC;EAAQ;EAAU;EAAS;CAAS,GAAG;EAC1D,MAAM,QAAQ,SAAS;EACvB,IAAI,OAAO,UAAU,UAAU,QAAQ,KAAK,KAAK;CACnD;CACA,IAAI,OAAO,SAAS,WAAW,UAAU,QAAQ,KAAK,SAAS,MAAM;MAChE,IAAI,SAAS,UAAU,OAAO,SAAS,WAAW,UAAU,QAAQ,KAAK,GAAG,cAAc,SAAS,MAAM,CAAC;CAE/G,IAAI,QAAQ,WAAW,KAAK,SAAS,eAAe,KAAA,GAAW,QAAQ,KAAK,YAAY;CACxF,OAAO,CAAC,GAAG,IAAI,IAAI,QAAQ,QAAQ,MAAM,CAAC,EAAE,SAAS,OAAO,KAAK,MAAM,gBAAgB,CAAC,CAAC,KAAK,MAAM,aAAa,KAAK,CAAC,CAAC,CAAC,CAAC;AAC5H;;AAGA,SAAgB,kBAAkB,MAAc,OAAsC;CACpF,IAAI,OAAO;CACX,IAAI,CAAC,MAAM;EACT,IAAI;GACF,OAAO,gBAAA,GAAeC,QAAAA,aAAAA,EAAAA,GAAaH,UAAAA,KAAAA,CAAK,MAAM,qBAAqB,GAAG,MAAM,CAAC;EAC/E,QAAQ;GACN,OAAO,CAAC;EACV;EACA,IAAI,KAAK,WAAW,GAAG,OAAO,CAAC,YAAY;CAC7C;CACA,MAAM,WAAW,KAAK,QAAQ,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC,CAAC,SAAS,MAAM,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAC9F,MAAM,OAAO,CAAC,GAAG,IAAI,IAAI,KAAK,QAAQ,MAAM,CAAC,EAAE,WAAW,GAAG,CAAC,CAAC,CAAC,SAAS,MAAM,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,MAAM,CAAC,SAAS,SAAS,CAAC,CAAC;CACrI,MAAM,QAA4B,CAAC;CACnC,KAAK,MAAM,OAAO,KAAK,KAAK,GAAG;EAC7B,IAAI;EACJ,IAAI;GACF,WAAW,KAAK,OAAA,GAAMG,QAAAA,aAAAA,EAAAA,GAAaH,UAAAA,KAAAA,CAAK,MAAM,KAAK,cAAc,GAAG,MAAM,CAAC;EAC7E,QAAQ;GACN;EACF;EACA,IAAI,OAAO,SAAS,YAAY,UAAU;EAC1C,MAAM,KAAK;GAAE,MAAM,SAAS;GAAS;GAAK,SAAS,SAAS,eAAe;GAAM,SAAS,eAAe,KAAK,QAAQ;EAAE,CAAC;CAC3H;CACA,OAAO;AACT;;AAGA,SAAgB,cAAc,UAA8B,OAAoD,CAAC,GAAW;CAC1H,MAAM,OAAO,SAA0B,KAAK,YAAY,GAAG,KAAK,UAAU,GAAG,SAAS;CACtF,MAAM,aAAa,SAAS,KAAK,MAAM,IAAI,OAAO,EAAE,GAAG,EAAE,EAAE;CAC3D,MAAM,QAAgB,CAAC;CACvB,KAAK,MAAM,OAAO,UAAU;EAC1B,MAAM,MAAM,IAAI,OAAO,IAAI,GAAG,EAAE;EAChC,MAAM,SAAS,WAAW,QAAQ,SAAS,SAAS,GAAG;EACvD,IAAI,OAAO,SAAS,GAClB,MAAM,KAAK;GACT,MAAM,0BAA0B,KAAK,IAAI,IAAI;GAC7C,UAAU;GACV,SAAS,IAAI,wCAAwC,IAAI,KAAK,8EAA8E;GAC5I,MAAM,EAAE,MAAM,IAAI;GAClB,IAAI;IAAE,MAAM;IAAQ,SAAS;IAAK,iBAAiB,CAAC,OAAO;GAAE;EAC/D,CAAC;EAEH,MAAM,KAAK;GACT,MAAM,oBAAoB,KAAK,IAAI,IAAI;GACvC,UAAU;GACV,SAAS,IACP,wCAAwC,IAAI,KAAK,gJAAgJ,IAAI,KAAK,EAC5M;GACA,MAAM,EAAE,SAAS,IAAI;GACrB,IAAI,IAAI,QAAQ,SAAS,IAAI;IAAE,MAAM;IAAK,SAAS,IAAI;GAAQ,IAAI,EAAE,MAAM,IAAI;EACjF,CAAC;CACH;CACA,MAAM,QAAQ,SAAS,KAAK,MAAM,OAAO,EAAE,IAAI,CAAC;CAChD,IAAI,MAAM,SAAS,GACjB,MAAM,KAAK;EACT,MAAM;EACN,UAAU;EACV,SAAS,IAAI,kIAAkI;EAC/I,MAAM,CAAC;EACP,IAAI;GAAE,MAAM,KAAK,MAAM,KAAK,GAAG,EAAE;GAAS,iBAAiB;EAAK;CAClE,CAAC;CAEH,MAAM,OACJ,KAAK,SAAS,YAAY,SAAS,QAAQ,MAAM,EAAE,OAAO,IAAI,SAAS,QAAQ,OAAO,KAAK,QAAQ,CAAC,EAAA,CAAG,SAAS,EAAE,IAAI,CAAC;CACzH,KAAK,MAAM,OAAO,MAChB,MAAM,KAAK;EACT,MAAM,qBAAqB,KAAK,IAAI,IAAI;EACxC,UAAU;EACV,SAAS,IAAI,6BAA6B,IAAI,KAAK,4FAA4F;EAC/I,MAAM,EAAE,SAAS,IAAI,OAAO,IAAI,GAAG,EAAE,GAAG;EACxC,IAAI,EAAE,MAAM,IAAI,OAAO,IAAI,GAAG,EAAE,GAAG;CACrC,CAAC;CAEH,OAAO;AACT;AAEA,MAAM,QAAQ,SAAyB,KAAK,QAAQ,MAAM,EAAE,CAAC,CAAC,QAAQ,kBAAkB,GAAG;;;;;;;AAQ3F,SAAgB,cAAc,MAAwC;CACpE,IAAI,CAAC,MAAM,OAAO,CAAC;CACnB,MAAMI,aAAAA,GAAUC,YAAAA,cAAAA,EAAAA,GAAcL,UAAAA,KAAAA,CAAK,MAAM,cAAc,CAAC;CACxD,IAAI;EACF,MAAM,EAAE,YAAYI,UAAQ,yBAAyB;EAErD,IAAI,OAAO,QAAQ,MAAM,GAAG,CAAC,CAAC,EAAE,IAAI,GAAG,OAAO,EAAE,sBAAsB,KAAK;CAC7E,QAAQ,CAER;CAEA,KAAK,MAAM,QAAQ,CAACA,YAAAA,GAASC,YAAAA,cAAAA,CAAAA,QAAAA,KAAAA,CAAAA,CAAAA,cAAAA,UAAAA,CAAAA,CAAAA,IAA6B,CAAC,GACzD,IAAI;EACF,KAAK,QAAQ,WAAW;EACxB,OAAO,EAAE,QAAQ,MAAM;CACzB,QAAQ,CAER;CAEF,OAAO,CAAC;AACV;;;;;;;AAQA,SAAgB,eAAe,MAAwC;CACrE,OAAO;EACL,GAAG,cAAc,IAAI;EACrB,SAAS,EACP,MAAM;GAAC;GAAsB;GAAsC;GAAmB;EAAuC,EAC/H;EACA,aAAa,EAAE,MAAM,CAAC,oBAAoB,EAAE;EAC5C,wBAAwB;GACtB,eAAe,CAAC,SAAS;GACzB,gBAAgB;IAAC;IAAU;IAAW;IAAQ;GAAS;GACvD,YAAY,CAAC,UAAU,MAAM;EAC/B;EACA,wBAAwB;CAC1B;AACF;;AAGA,SAAgB,WAAW,MAAc,OAAwB,CAAC,GAAW;CAC3E,MAAM,WAAW,kBAAkB,MAAM,KAAK,QAAQ;CACtD,MAAM,UAAU;EAAE,GAAG,eAAe,IAAI;EAAG,GAAG,KAAK;CAAQ;CAC3D,OAAO;EACL,WAAW,CAAC,GAAG,cAAc,UAAU,IAAI,GAAG,GAAI,KAAK,aAAa,CAAC,CAAE;EACvE;CACF;AACF"}

package/build/index.d.cts

@@ -0,0 +1,69 @@
+/** A rule of dependency-cruiser (the `forbidden` list). The package does not depend on the types of dependency-cruiser. */
+export interface Rule {
+  name: string;
+  severity: "error" | "warn" | "info" | "ignore";
+  comment?: string;
+  from: Record<string, unknown>;
+  to: Record<string, unknown>;
+}
+/** A dependency-cruiser configuration. */
+export interface Config {
+  forbidden: Rule[];
+  options: Record<string, unknown>;
+}
+/** A package of the workspace. */
+export interface WorkspacePackage {
+  /** The name in package.json. */
+  name: string;
+  /** The folder, relative to the root, with "/". */
+  dir: string;
+  private: boolean;
+  /** RegExp sources of the files that other packages can import. */
+  entries: string[];
+}
+export interface BoundaryOptions {
+  /**
+   * Globs of the package folders, for example `["packages/*"]`. The default is the `packages` list of
+   * pnpm-workspace.yaml, or `["packages/*"]` when the file does not exist.
+   */
+  packages?: string[];
+  /** The apps: the leaves of the graph, which no other package imports. "private" means each private package. */
+  apps?: "private" | string[];
+  /** A text before each comment, for example the decision record of the rules. */
+  reference?: string;
+  /** More rules, after the rules of the boundaries. */
+  forbidden?: Rule[];
+  /** More options of dependency-cruiser. They replace the default options with the same key. */
+  options?: Record<string, unknown>;
+}
+/** The `packages` list of a pnpm-workspace.yaml file. It reads only that list, with no YAML library. */
+export declare function workspaceGlobs(yaml: string): string[];
+/**
+ * The RegExp source of an entry target of a package. The extension can change, because
+ * dependency-cruiser resolves "./x.js" to the source file x.ts, and "*" of a subpath pattern matches
+ * each path.
+ */
+export declare function entryPattern(dir: string, target: string): string;
+/** The entries of a package.json: the files that other packages can import. */
+export declare function packageEntries(dir: string, manifest: Record<string, unknown>): string[];
+/** The packages of the workspace in the folder `root`. */
+export declare function workspacePackages(root: string, globs?: string[]): WorkspacePackage[];
+/** The rules of the boundaries for a list of packages. `boundaries()` reads the list from the workspace. */
+export declare function boundaryRules(packages: WorkspacePackage[], opts?: Pick<BoundaryOptions, "apps" | "reference">): Rule[];
+/**
+ * The parser of the TypeScript source. dependency-cruiser reads TypeScript with the TypeScript
+ * compiler of the repository only for TypeScript 2 to 6. With TypeScript 7 or no TypeScript, it reads
+ * TypeScript with swc when @swc/core is installed. Else it reads only JavaScript (acorn): that is
+ * enough for a check of built JavaScript.
+ */
+export declare function parserOptions(root?: string): Record<string, unknown>;
+/**
+ * The default options: the source of the packages, with type-only imports, resolved as Node resolves
+ * them. There is no `includeOnly`, because it also removes the imports that do not resolve, and the
+ * rule not-a-declared-export needs them. The "types" condition is not used: it resolves to a
+ * declaration file, and the analysis excludes declaration files, so a deep import does not show.
+ */
+export declare function defaultOptions(root?: string): Record<string, unknown>;
+/** The dependency-cruiser configuration of the boundaries for the workspace in the folder `root`. */
+export declare function boundaries(root: string, opts?: BoundaryOptions): Config;
+//# sourceMappingURL=index.d.cts.map

package/build/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"mappings":";iBAiBiB;EACf;EACA;EACA;EACA,MAAM;EACN,IAAI;;;iBAIW;EACf,WAAW;EACX,SAAS;;;iBAIM;;EAEf;;EAEA;EACA;;EAEA;;iBAGe;;;;;EAKf;;EAEA;;EAEA;;EAEA,YAAY;;EAEZ,UAAU;;;wBAMI,eAAe;;;;;;wBAqEf,aAAa,aAAa;;wBAW1B,eAAe,aAAa,UAAU;;wBActC,kBAAkB,cAAc,mBAAmB;;wBA2BnD,cAAc,UAAU,oBAAoB,OAAM,KAAK,yCAA8C;;;;;;;wBA0DrG,cAAc,gBAAgB;;;;;;;wBA4B9B,eAAe,gBAAgB;;wBAiB/B,WAAW,cAAc,OAAM,kBAAuB"}

package/build/index.d.ts

@@ -0,0 +1,69 @@
+/** A rule of dependency-cruiser (the `forbidden` list). The package does not depend on the types of dependency-cruiser. */
+export interface Rule {
+  name: string;
+  severity: "error" | "warn" | "info" | "ignore";
+  comment?: string;
+  from: Record<string, unknown>;
+  to: Record<string, unknown>;
+}
+/** A dependency-cruiser configuration. */
+export interface Config {
+  forbidden: Rule[];
+  options: Record<string, unknown>;
+}
+/** A package of the workspace. */
+export interface WorkspacePackage {
+  /** The name in package.json. */
+  name: string;
+  /** The folder, relative to the root, with "/". */
+  dir: string;
+  private: boolean;
+  /** RegExp sources of the files that other packages can import. */
+  entries: string[];
+}
+export interface BoundaryOptions {
+  /**
+   * Globs of the package folders, for example `["packages/*"]`. The default is the `packages` list of
+   * pnpm-workspace.yaml, or `["packages/*"]` when the file does not exist.
+   */
+  packages?: string[];
+  /** The apps: the leaves of the graph, which no other package imports. "private" means each private package. */
+  apps?: "private" | string[];
+  /** A text before each comment, for example the decision record of the rules. */
+  reference?: string;
+  /** More rules, after the rules of the boundaries. */
+  forbidden?: Rule[];
+  /** More options of dependency-cruiser. They replace the default options with the same key. */
+  options?: Record<string, unknown>;
+}
+/** The `packages` list of a pnpm-workspace.yaml file. It reads only that list, with no YAML library. */
+export declare function workspaceGlobs(yaml: string): string[];
+/**
+ * The RegExp source of an entry target of a package. The extension can change, because
+ * dependency-cruiser resolves "./x.js" to the source file x.ts, and "*" of a subpath pattern matches
+ * each path.
+ */
+export declare function entryPattern(dir: string, target: string): string;
+/** The entries of a package.json: the files that other packages can import. */
+export declare function packageEntries(dir: string, manifest: Record<string, unknown>): string[];
+/** The packages of the workspace in the folder `root`. */
+export declare function workspacePackages(root: string, globs?: string[]): WorkspacePackage[];
+/** The rules of the boundaries for a list of packages. `boundaries()` reads the list from the workspace. */
+export declare function boundaryRules(packages: WorkspacePackage[], opts?: Pick<BoundaryOptions, "apps" | "reference">): Rule[];
+/**
+ * The parser of the TypeScript source. dependency-cruiser reads TypeScript with the TypeScript
+ * compiler of the repository only for TypeScript 2 to 6. With TypeScript 7 or no TypeScript, it reads
+ * TypeScript with swc when @swc/core is installed. Else it reads only JavaScript (acorn): that is
+ * enough for a check of built JavaScript.
+ */
+export declare function parserOptions(root?: string): Record<string, unknown>;
+/**
+ * The default options: the source of the packages, with type-only imports, resolved as Node resolves
+ * them. There is no `includeOnly`, because it also removes the imports that do not resolve, and the
+ * rule not-a-declared-export needs them. The "types" condition is not used: it resolves to a
+ * declaration file, and the analysis excludes declaration files, so a deep import does not show.
+ */
+export declare function defaultOptions(root?: string): Record<string, unknown>;
+/** The dependency-cruiser configuration of the boundaries for the workspace in the folder `root`. */
+export declare function boundaries(root: string, opts?: BoundaryOptions): Config;
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";iBAiBiB;EACf;EACA;EACA;EACA,MAAM;EACN,IAAI;;;iBAIW;EACf,WAAW;EACX,SAAS;;;iBAIM;;EAEf;;EAEA;EACA;;EAEA;;iBAGe;;;;;EAKf;;EAEA;;EAEA;;EAEA,YAAY;;EAEZ,UAAU;;;wBAMI,eAAe;;;;;;wBAqEf,aAAa,aAAa;;wBAW1B,eAAe,aAAa,UAAU;;wBActC,kBAAkB,cAAc,mBAAmB;;wBA2BnD,cAAc,UAAU,oBAAoB,OAAM,KAAK,yCAA8C;;;;;;;wBA0DrG,cAAc,gBAAgB;;;;;;;wBA4B9B,eAAe,gBAAgB;;wBAiB/B,WAAW,cAAc,OAAM,kBAAuB"}

package/build/index.js

@@ -0,0 +1,261 @@
+import { createRequire } from "node:module";
+import { readFileSync, readdirSync, statSync } from "node:fs";
+import { join, posix } from "node:path";
+// src/index.ts
+/**
+* The import boundaries of a workspace, as a dependency-cruiser configuration. Each package is a
+* unit. Another package imports it only through an entry of its package.json (`exports`, `main`,
+* `module`, `types`, `bin`). A relative path or a deep path into its folder is not an entry.
+*
+* A repository uses it from its `.dependency-cruiser.cjs`:
+*
+* ```js
+* const { boundaries } = require("@mark1russell7/boundaries");
+* module.exports = boundaries(__dirname, { apps: "private" });
+* ```
+*/
+const escape = (text) => text.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+/** The `packages` list of a pnpm-workspace.yaml file. It reads only that list, with no YAML library. */
+function workspaceGlobs(yaml) {
+	const globs = [];
+	let inList = false;
+	for (const raw of yaml.split(/\r?\n/)) {
+		const hash = raw.indexOf(" #");
+		const line = (hash === -1 ? raw : raw.slice(0, hash)).trimEnd();
+		const trimmed = line.trimStart();
+		if (trimmed === "" || trimmed.startsWith("#")) continue;
+		if (/^packages\s*:/.test(line)) {
+			inList = true;
+			continue;
+		}
+		if (!inList) continue;
+		if (trimmed === line) break;
+		if (!trimmed.startsWith("-")) continue;
+		const item = trimmed.slice(1).trim().replace(/^["']/, "").replace(/["']$/, "");
+		if (item) globs.push(item);
+	}
+	return globs;
+}
+function isDir(path) {
+	try {
+		return statSync(path).isDirectory();
+	} catch {
+		return false;
+	}
+}
+/** The folders that a glob of pnpm-workspace.yaml gives: "a/b", "a/*" and "a/**". */
+function expand(root, glob) {
+	const clean = glob.replace(/^\.\//, "").replace(/\/$/, "");
+	const star = clean.indexOf("*");
+	if (star === -1) return isDir(join(root, clean)) ? [clean] : [];
+	const base = clean.slice(0, star).replace(/\/$/, "");
+	const recursive = clean.slice(star).startsWith("**");
+	const found = [];
+	const walk = (dir, depth) => {
+		let entries;
+		try {
+			entries = readdirSync(join(root, dir), { withFileTypes: true });
+		} catch {
+			return;
+		}
+		for (const entry of entries) {
+			if (!entry.isDirectory() || entry.name === "node_modules" || entry.name.startsWith(".")) continue;
+			const child = dir === "" ? entry.name : `${dir}/${entry.name}`;
+			found.push(child);
+			if (recursive && depth < 6) walk(child, depth + 1);
+		}
+	};
+	walk(base, 0);
+	return found;
+}
+/** The leaf strings of an `exports` value, with their subpath keys. */
+function exportTargets(value, out = []) {
+	if (typeof value === "string") out.push(value);
+	else if (Array.isArray(value)) for (const item of value) exportTargets(item, out);
+	else if (value && typeof value === "object") for (const item of Object.values(value)) exportTargets(item, out);
+	return out;
+}
+/**
+* The RegExp source of an entry target of a package. The extension can change, because
+* dependency-cruiser resolves "./x.js" to the source file x.ts, and "*" of a subpath pattern matches
+* each path.
+*/
+function entryPattern(dir, target) {
+	return `^${posix.normalize(posix.join(dir, target.replace(/^\.\//, ""))).replace(/\.d\.[cm]?ts$|\.[cm]?[jt]sx?$/, "").split("*").map(escape).join(".*")}(${EXTENSIONS})?$`;
+}
+const EXTENSIONS = [
+	".js",
+	".mjs",
+	".cjs",
+	".jsx",
+	".ts",
+	".mts",
+	".cts",
+	".tsx",
+	".d.ts",
+	".d.mts",
+	".d.cts"
+].map(escape).join("|");
+/** The entries of a package.json: the files that other packages can import. */
+function packageEntries(dir, manifest) {
+	const targets = exportTargets(manifest["exports"]);
+	for (const field of [
+		"main",
+		"module",
+		"types",
+		"typings"
+	]) {
+		const value = manifest[field];
+		if (typeof value === "string") targets.push(value);
+	}
+	if (typeof manifest["bin"] === "string") targets.push(manifest["bin"]);
+	else if (manifest["bin"] && typeof manifest["bin"] === "object") targets.push(...exportTargets(manifest["bin"]));
+	if (targets.length === 0 && manifest["exports"] === void 0) targets.push("./index.js");
+	return [...new Set(targets.filter((t) => !t.endsWith(".json") || t === "./package.json").map((t) => entryPattern(dir, t)))];
+}
+/** The packages of the workspace in the folder `root`. */
+function workspacePackages(root, globs) {
+	let list = globs;
+	if (!list) {
+		try {
+			list = workspaceGlobs(readFileSync(join(root, "pnpm-workspace.yaml"), "utf8"));
+		} catch {
+			list = [];
+		}
+		if (list.length === 0) list = ["packages/*"];
+	}
+	const excluded = list.filter((g) => g.startsWith("!")).flatMap((g) => expand(root, g.slice(1)));
+	const dirs = [...new Set(list.filter((g) => !g.startsWith("!")).flatMap((g) => expand(root, g)))].filter((d) => !excluded.includes(d));
+	const found = [];
+	for (const dir of dirs.sort()) {
+		let manifest;
+		try {
+			manifest = JSON.parse(readFileSync(join(root, dir, "package.json"), "utf8"));
+		} catch {
+			continue;
+		}
+		if (typeof manifest["name"] !== "string") continue;
+		found.push({
+			name: manifest["name"],
+			dir,
+			private: manifest["private"] === true,
+			entries: packageEntries(dir, manifest)
+		});
+	}
+	return found;
+}
+/** The rules of the boundaries for a list of packages. `boundaries()` reads the list from the workspace. */
+function boundaryRules(packages, opts = {}) {
+	const why = (text) => opts.reference ? `${opts.reference} ${text}` : text;
+	const anyPackage = packages.map((p) => `^${escape(p.dir)}/`);
+	const rules = [];
+	for (const pkg of packages) {
+		const own = `^${escape(pkg.dir)}/`;
+		const others = anyPackage.filter((path) => path !== own);
+		if (others.length > 0) rules.push({
+			name: `relative-import-out-of-${slug(pkg.name)}`,
+			severity: "error",
+			comment: why(`A relative import leaves the package ${pkg.name}. Import the other package by its name, through an entry of its package.json.`),
+			from: { path: own },
+			to: {
+				path: others,
+				pathNot: own,
+				dependencyTypes: ["local"]
+			}
+		});
+		rules.push({
+			name: `deep-import-into-${slug(pkg.name)}`,
+			severity: "error",
+			comment: why(`An import reaches into the folder of ${pkg.name} at a file that is not an entry of its package.json (exports, main, module, types or bin). Import an entry, or add the file to the exports of ${pkg.name}.`),
+			from: { pathNot: own },
+			to: pkg.entries.length > 0 ? {
+				path: own,
+				pathNot: pkg.entries
+			} : { path: own }
+		});
+	}
+	const names = packages.map((p) => escape(p.name));
+	if (names.length > 0) rules.push({
+		name: "not-a-declared-export",
+		severity: "error",
+		comment: why("An import of a package of this workspace does not resolve. The path is not an entry of its exports, or the package is not built."),
+		from: {},
+		to: {
+			path: `^(${names.join("|")})(/|$)`,
+			couldNotResolve: true
+		}
+	});
+	const apps = opts.apps === "private" ? packages.filter((p) => p.private) : packages.filter((p) => (opts.apps ?? []).includes(p.name));
+	for (const app of apps) rules.push({
+		name: `import-of-the-app-${slug(app.name)}`,
+		severity: "error",
+		comment: why(`A package imports the app ${app.name}. An app is a leaf: no other package imports it. Move the shared code to a library package.`),
+		from: { pathNot: `^${escape(app.dir)}/` },
+		to: { path: `^${escape(app.dir)}/` }
+	});
+	return rules;
+}
+const slug = (name) => name.replace(/^@/, "").replace(/[^A-Za-z0-9]+/g, "-");
+/**
+* The parser of the TypeScript source. dependency-cruiser reads TypeScript with the TypeScript
+* compiler of the repository only for TypeScript 2 to 6. With TypeScript 7 or no TypeScript, it reads
+* TypeScript with swc when @swc/core is installed. Else it reads only JavaScript (acorn): that is
+* enough for a check of built JavaScript.
+*/
+function parserOptions(root) {
+	if (!root) return {};
+	const require = createRequire(join(root, "package.json"));
+	try {
+		const { version } = require("typescript/package.json");
+		if (Number(version.split(".")[0]) < 7) return { tsPreCompilationDeps: true };
+	} catch {}
+	for (const from of [require, createRequire(import.meta.url)]) try {
+		from.resolve("@swc/core");
+		return { parser: "swc" };
+	} catch {}
+	return {};
+}
+/**
+* The default options: the source of the packages, with type-only imports, resolved as Node resolves
+* them. There is no `includeOnly`, because it also removes the imports that do not resolve, and the
+* rule not-a-declared-export needs them. The "types" condition is not used: it resolves to a
+* declaration file, and the analysis excludes declaration files, so a deep import does not show.
+*/
+function defaultOptions(root) {
+	return {
+		...parserOptions(root),
+		exclude: { path: [
+			"(^|/)node_modules/",
+			"\\.(test|spec|e2e)\\.[cm]?[jt]sx?$",
+			"\\.d\\.[cm]?ts$",
+			"/(test|tests|e2e|__tests__|fixtures)/"
+		] },
+		doNotFollow: { path: ["(^|/)node_modules/"] },
+		enhancedResolveOptions: {
+			exportsFields: ["exports"],
+			conditionNames: [
+				"import",
+				"require",
+				"node",
+				"default"
+			],
+			mainFields: ["module", "main"]
+		},
+		skipAnalysisNotInRules: true
+	};
+}
+/** The dependency-cruiser configuration of the boundaries for the workspace in the folder `root`. */
+function boundaries(root, opts = {}) {
+	const packages = workspacePackages(root, opts.packages);
+	const options = {
+		...defaultOptions(root),
+		...opts.options
+	};
+	return {
+		forbidden: [...boundaryRules(packages, opts), ...opts.forbidden ?? []],
+		options
+	};
+}
+export { boundaries, boundaryRules, defaultOptions, entryPattern, packageEntries, parserOptions, workspaceGlobs, workspacePackages };
+
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["/**\n * The import boundaries of a workspace, as a dependency-cruiser configuration. Each package is a\n * unit. Another package imports it only through an entry of its package.json (`exports`, `main`,\n * `module`, `types`, `bin`). A relative path or a deep path into its folder is not an entry.\n *\n * A repository uses it from its `.dependency-cruiser.cjs`:\n *\n * ```js\n * const { boundaries } = require(\"@mark1russell7/boundaries\");\n * module.exports = boundaries(__dirname, { apps: \"private\" });\n * ```\n */\nimport { readdirSync, readFileSync, statSync } from \"node:fs\";\nimport { createRequire } from \"node:module\";\nimport { join, posix } from \"node:path\";\n\n/** A rule of dependency-cruiser (the `forbidden` list). The package does not depend on the types of dependency-cruiser. */\nexport interface Rule {\n  name: string;\n  severity: \"error\" | \"warn\" | \"info\" | \"ignore\";\n  comment?: string;\n  from: Record<string, unknown>;\n  to: Record<string, unknown>;\n}\n\n/** A dependency-cruiser configuration. */\nexport interface Config {\n  forbidden: Rule[];\n  options: Record<string, unknown>;\n}\n\n/** A package of the workspace. */\nexport interface WorkspacePackage {\n  /** The name in package.json. */\n  name: string;\n  /** The folder, relative to the root, with \"/\". */\n  dir: string;\n  private: boolean;\n  /** RegExp sources of the files that other packages can import. */\n  entries: string[];\n}\n\nexport interface BoundaryOptions {\n  /**\n   * Globs of the package folders, for example `[\"packages/*\"]`. The default is the `packages` list of\n   * pnpm-workspace.yaml, or `[\"packages/*\"]` when the file does not exist.\n   */\n  packages?: string[];\n  /** The apps: the leaves of the graph, which no other package imports. \"private\" means each private package. */\n  apps?: \"private\" | string[];\n  /** A text before each comment, for example the decision record of the rules. */\n  reference?: string;\n  /** More rules, after the rules of the boundaries. */\n  forbidden?: Rule[];\n  /** More options of dependency-cruiser. They replace the default options with the same key. */\n  options?: Record<string, unknown>;\n}\n\nconst escape = (text: string): string => text.replace(/[.*+?^${}()|[\\]\\\\]/g, \"\\\\$&\");\n\n/** The `packages` list of a pnpm-workspace.yaml file. It reads only that list, with no YAML library. */\nexport function workspaceGlobs(yaml: string): string[] {\n  const globs: string[] = [];\n  let inList = false;\n  // String operations, not one large RegExp: a RegExp with nested whitespace groups can be slow on some input.\n  for (const raw of yaml.split(/\\r?\\n/)) {\n    const hash = raw.indexOf(\" #\");\n    const line = (hash === -1 ? raw : raw.slice(0, hash)).trimEnd();\n    const trimmed = line.trimStart();\n    if (trimmed === \"\" || trimmed.startsWith(\"#\")) continue;\n    if (/^packages\\s*:/.test(line)) {\n      inList = true;\n      continue;\n    }\n    if (!inList) continue;\n    if (trimmed === line) break;\n    if (!trimmed.startsWith(\"-\")) continue;\n    const item = trimmed.slice(1).trim().replace(/^[\"']/, \"\").replace(/[\"']$/, \"\");\n    if (item) globs.push(item);\n  }\n  return globs;\n}\n\nfunction isDir(path: string): boolean {\n  try {\n    return statSync(path).isDirectory();\n  } catch {\n    return false;\n  }\n}\n\n/** The folders that a glob of pnpm-workspace.yaml gives: \"a/b\", \"a/*\" and \"a/**\". */\nfunction expand(root: string, glob: string): string[] {\n  const clean = glob.replace(/^\\.\\//, \"\").replace(/\\/$/, \"\");\n  const star = clean.indexOf(\"*\");\n  if (star === -1) return isDir(join(root, clean)) ? [clean] : [];\n  const base = clean.slice(0, star).replace(/\\/$/, \"\");\n  const recursive = clean.slice(star).startsWith(\"**\");\n  const found: string[] = [];\n  const walk = (dir: string, depth: number): void => {\n    let entries;\n    try {\n      entries = readdirSync(join(root, dir), { withFileTypes: true });\n    } catch {\n      return;\n    }\n    for (const entry of entries) {\n      if (!entry.isDirectory() || entry.name === \"node_modules\" || entry.name.startsWith(\".\")) continue;\n      const child = dir === \"\" ? entry.name : `${dir}/${entry.name}`;\n      found.push(child);\n      if (recursive && depth < 6) walk(child, depth + 1);\n    }\n  };\n  walk(base, 0);\n  return found;\n}\n\n/** The leaf strings of an `exports` value, with their subpath keys. */\nfunction exportTargets(value: unknown, out: string[] = []): string[] {\n  if (typeof value === \"string\") out.push(value);\n  else if (Array.isArray(value)) for (const item of value) exportTargets(item, out);\n  else if (value && typeof value === \"object\") for (const item of Object.values(value)) exportTargets(item, out);\n  return out;\n}\n\n/**\n * The RegExp source of an entry target of a package. The extension can change, because\n * dependency-cruiser resolves \"./x.js\" to the source file x.ts, and \"*\" of a subpath pattern matches\n * each path.\n */\nexport function entryPattern(dir: string, target: string): string {\n  const path = posix.normalize(posix.join(dir, target.replace(/^\\.\\//, \"\")));\n  const stem = path.replace(/\\.d\\.[cm]?ts$|\\.[cm]?[jt]sx?$/, \"\");\n  const source = stem.split(\"*\").map(escape).join(\".*\");\n  // A flat list, because dependency-cruiser refuses a RegExp with nested quantifiers (safe-regex).\n  return `^${source}(${EXTENSIONS})?$`;\n}\n\nconst EXTENSIONS = [\".js\", \".mjs\", \".cjs\", \".jsx\", \".ts\", \".mts\", \".cts\", \".tsx\", \".d.ts\", \".d.mts\", \".d.cts\"].map(escape).join(\"|\");\n\n/** The entries of a package.json: the files that other packages can import. */\nexport function packageEntries(dir: string, manifest: Record<string, unknown>): string[] {\n  const targets = exportTargets(manifest[\"exports\"]);\n  for (const field of [\"main\", \"module\", \"types\", \"typings\"]) {\n    const value = manifest[field];\n    if (typeof value === \"string\") targets.push(value);\n  }\n  if (typeof manifest[\"bin\"] === \"string\") targets.push(manifest[\"bin\"]);\n  else if (manifest[\"bin\"] && typeof manifest[\"bin\"] === \"object\") targets.push(...exportTargets(manifest[\"bin\"]));\n  // With no entry field, Node resolves the package to index.js.\n  if (targets.length === 0 && manifest[\"exports\"] === undefined) targets.push(\"./index.js\");\n  return [...new Set(targets.filter((t) => !t.endsWith(\".json\") || t === \"./package.json\").map((t) => entryPattern(dir, t)))];\n}\n\n/** The packages of the workspace in the folder `root`. */\nexport function workspacePackages(root: string, globs?: string[]): WorkspacePackage[] {\n  let list = globs;\n  if (!list) {\n    try {\n      list = workspaceGlobs(readFileSync(join(root, \"pnpm-workspace.yaml\"), \"utf8\"));\n    } catch {\n      list = [];\n    }\n    if (list.length === 0) list = [\"packages/*\"];\n  }\n  const excluded = list.filter((g) => g.startsWith(\"!\")).flatMap((g) => expand(root, g.slice(1)));\n  const dirs = [...new Set(list.filter((g) => !g.startsWith(\"!\")).flatMap((g) => expand(root, g)))].filter((d) => !excluded.includes(d));\n  const found: WorkspacePackage[] = [];\n  for (const dir of dirs.sort()) {\n    let manifest: Record<string, unknown>;\n    try {\n      manifest = JSON.parse(readFileSync(join(root, dir, \"package.json\"), \"utf8\")) as Record<string, unknown>;\n    } catch {\n      continue;\n    }\n    if (typeof manifest[\"name\"] !== \"string\") continue;\n    found.push({ name: manifest[\"name\"], dir, private: manifest[\"private\"] === true, entries: packageEntries(dir, manifest) });\n  }\n  return found;\n}\n\n/** The rules of the boundaries for a list of packages. `boundaries()` reads the list from the workspace. */\nexport function boundaryRules(packages: WorkspacePackage[], opts: Pick<BoundaryOptions, \"apps\" | \"reference\"> = {}): Rule[] {\n  const why = (text: string): string => (opts.reference ? `${opts.reference} ${text}` : text);\n  const anyPackage = packages.map((p) => `^${escape(p.dir)}/`);\n  const rules: Rule[] = [];\n  for (const pkg of packages) {\n    const own = `^${escape(pkg.dir)}/`;\n    const others = anyPackage.filter((path) => path !== own);\n    if (others.length > 0) {\n      rules.push({\n        name: `relative-import-out-of-${slug(pkg.name)}`,\n        severity: \"error\",\n        comment: why(`A relative import leaves the package ${pkg.name}. Import the other package by its name, through an entry of its package.json.`),\n        from: { path: own },\n        to: { path: others, pathNot: own, dependencyTypes: [\"local\"] },\n      });\n    }\n    rules.push({\n      name: `deep-import-into-${slug(pkg.name)}`,\n      severity: \"error\",\n      comment: why(\n        `An import reaches into the folder of ${pkg.name} at a file that is not an entry of its package.json (exports, main, module, types or bin). Import an entry, or add the file to the exports of ${pkg.name}.`,\n      ),\n      from: { pathNot: own },\n      to: pkg.entries.length > 0 ? { path: own, pathNot: pkg.entries } : { path: own },\n    });\n  }\n  const names = packages.map((p) => escape(p.name));\n  if (names.length > 0) {\n    rules.push({\n      name: \"not-a-declared-export\",\n      severity: \"error\",\n      comment: why(\"An import of a package of this workspace does not resolve. The path is not an entry of its exports, or the package is not built.\"),\n      from: {},\n      to: { path: `^(${names.join(\"|\")})(/|$)`, couldNotResolve: true },\n    });\n  }\n  const apps =\n    opts.apps === \"private\" ? packages.filter((p) => p.private) : packages.filter((p) => (opts.apps ?? []).includes(p.name));\n  for (const app of apps) {\n    rules.push({\n      name: `import-of-the-app-${slug(app.name)}`,\n      severity: \"error\",\n      comment: why(`A package imports the app ${app.name}. An app is a leaf: no other package imports it. Move the shared code to a library package.`),\n      from: { pathNot: `^${escape(app.dir)}/` },\n      to: { path: `^${escape(app.dir)}/` },\n    });\n  }\n  return rules;\n}\n\nconst slug = (name: string): string => name.replace(/^@/, \"\").replace(/[^A-Za-z0-9]+/g, \"-\");\n\n/**\n * The parser of the TypeScript source. dependency-cruiser reads TypeScript with the TypeScript\n * compiler of the repository only for TypeScript 2 to 6. With TypeScript 7 or no TypeScript, it reads\n * TypeScript with swc when @swc/core is installed. Else it reads only JavaScript (acorn): that is\n * enough for a check of built JavaScript.\n */\nexport function parserOptions(root?: string): Record<string, unknown> {\n  if (!root) return {};\n  const require = createRequire(join(root, \"package.json\"));\n  try {\n    const { version } = require(\"typescript/package.json\") as { version: string };\n    // A type-only import is a boundary too. This option needs the TypeScript compiler.\n    if (Number(version.split(\".\")[0]) < 7) return { tsPreCompilationDeps: true };\n  } catch {\n    // No TypeScript in the repository\n  }\n  // @swc/core from the repository, or next to this package (a peer dependency)\n  for (const from of [require, createRequire(import.meta.url)]) {\n    try {\n      from.resolve(\"@swc/core\");\n      return { parser: \"swc\" };\n    } catch {\n      // Not there\n    }\n  }\n  return {};\n}\n\n/**\n * The default options: the source of the packages, with type-only imports, resolved as Node resolves\n * them. There is no `includeOnly`, because it also removes the imports that do not resolve, and the\n * rule not-a-declared-export needs them. The \"types\" condition is not used: it resolves to a\n * declaration file, and the analysis excludes declaration files, so a deep import does not show.\n */\nexport function defaultOptions(root?: string): Record<string, unknown> {\n  return {\n    ...parserOptions(root),\n    exclude: {\n      path: [\"(^|/)node_modules/\", \"\\\\.(test|spec|e2e)\\\\.[cm]?[jt]sx?$\", \"\\\\.d\\\\.[cm]?ts$\", \"/(test|tests|e2e|__tests__|fixtures)/\"],\n    },\n    doNotFollow: { path: [\"(^|/)node_modules/\"] },\n    enhancedResolveOptions: {\n      exportsFields: [\"exports\"],\n      conditionNames: [\"import\", \"require\", \"node\", \"default\"],\n      mainFields: [\"module\", \"main\"],\n    },\n    skipAnalysisNotInRules: true,\n  };\n}\n\n/** The dependency-cruiser configuration of the boundaries for the workspace in the folder `root`. */\nexport function boundaries(root: string, opts: BoundaryOptions = {}): Config {\n  const packages = workspacePackages(root, opts.packages);\n  const options = { ...defaultOptions(root), ...opts.options };\n  return {\n    forbidden: [...boundaryRules(packages, opts), ...(opts.forbidden ?? [])],\n    options,\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;AA0DA,MAAM,UAAU,SAAyB,KAAK,QAAQ,uBAAuB,MAAM;;AAGnF,SAAgB,eAAe,MAAwB;CACrD,MAAM,QAAkB,CAAC;CACzB,IAAI,SAAS;CAEb,KAAK,MAAM,OAAO,KAAK,MAAM,OAAO,GAAG;EACrC,MAAM,OAAO,IAAI,QAAQ,IAAI;EAC7B,MAAM,QAAQ,SAAS,KAAK,MAAM,IAAI,MAAM,GAAG,IAAI,EAAA,CAAG,QAAQ;EAC9D,MAAM,UAAU,KAAK,UAAU;EAC/B,IAAI,YAAY,MAAM,QAAQ,WAAW,GAAG,GAAG;EAC/C,IAAI,gBAAgB,KAAK,IAAI,GAAG;GAC9B,SAAS;GACT;EACF;EACA,IAAI,CAAC,QAAQ;EACb,IAAI,YAAY,MAAM;EACtB,IAAI,CAAC,QAAQ,WAAW,GAAG,GAAG;EAC9B,MAAM,OAAO,QAAQ,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,SAAS,EAAE,CAAC,CAAC,QAAQ,SAAS,EAAE;EAC7E,IAAI,MAAM,MAAM,KAAK,IAAI;CAC3B;CACA,OAAO;AACT;AAEA,SAAS,MAAM,MAAuB;CACpC,IAAI;EACF,OAAO,SAAS,IAAI,CAAC,CAAC,YAAY;CACpC,QAAQ;EACN,OAAO;CACT;AACF;;AAGA,SAAS,OAAO,MAAc,MAAwB;CACpD,MAAM,QAAQ,KAAK,QAAQ,SAAS,EAAE,CAAC,CAAC,QAAQ,OAAO,EAAE;CACzD,MAAM,OAAO,MAAM,QAAQ,GAAG;CAC9B,IAAI,SAAS,IAAI,OAAO,MAAM,KAAK,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;CAC9D,MAAM,OAAO,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,QAAQ,OAAO,EAAE;CACnD,MAAM,YAAY,MAAM,MAAM,IAAI,CAAC,CAAC,WAAW,IAAI;CACnD,MAAM,QAAkB,CAAC;CACzB,MAAM,QAAQ,KAAa,UAAwB;EACjD,IAAI;EACJ,IAAI;GACF,UAAU,YAAY,KAAK,MAAM,GAAG,GAAG,EAAE,eAAe,KAAK,CAAC;EAChE,QAAQ;GACN;EACF;EACA,KAAK,MAAM,SAAS,SAAS;GAC3B,IAAI,CAAC,MAAM,YAAY,KAAK,MAAM,SAAS,kBAAkB,MAAM,KAAK,WAAW,GAAG,GAAG;GACzF,MAAM,QAAQ,QAAQ,KAAK,MAAM,OAAO,GAAG,IAAI,GAAG,MAAM;GACxD,MAAM,KAAK,KAAK;GAChB,IAAI,aAAa,QAAQ,GAAG,KAAK,OAAO,QAAQ,CAAC;EACnD;CACF;CACA,KAAK,MAAM,CAAC;CACZ,OAAO;AACT;;AAGA,SAAS,cAAc,OAAgB,MAAgB,CAAC,GAAa;CACnE,IAAI,OAAO,UAAU,UAAU,IAAI,KAAK,KAAK;MACxC,IAAI,MAAM,QAAQ,KAAK,GAAG,KAAK,MAAM,QAAQ,OAAO,cAAc,MAAM,GAAG;MAC3E,IAAI,SAAS,OAAO,UAAU,UAAU,KAAK,MAAM,QAAQ,OAAO,OAAO,KAAK,GAAG,cAAc,MAAM,GAAG;CAC7G,OAAO;AACT;;;;;;AAOA,SAAgB,aAAa,KAAa,QAAwB;CAKhE,OAAO,IAJM,MAAM,UAAU,MAAM,KAAK,KAAK,OAAO,QAAQ,SAAS,EAAE,CAAC,CACxD,CAAC,CAAC,QAAQ,iCAAiC,EACzC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,KAAK,IAEhC,EAAE,GAAG,WAAW;AAClC;AAEA,MAAM,aAAa;CAAC;CAAO;CAAQ;CAAQ;CAAQ;CAAO;CAAQ;CAAQ;CAAQ;CAAS;CAAU;AAAQ,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,KAAK,GAAG;;AAGnI,SAAgB,eAAe,KAAa,UAA6C;CACvF,MAAM,UAAU,cAAc,SAAS,UAAU;CACjD,KAAK,MAAM,SAAS;EAAC;EAAQ;EAAU;EAAS;CAAS,GAAG;EAC1D,MAAM,QAAQ,SAAS;EACvB,IAAI,OAAO,UAAU,UAAU,QAAQ,KAAK,KAAK;CACnD;CACA,IAAI,OAAO,SAAS,WAAW,UAAU,QAAQ,KAAK,SAAS,MAAM;MAChE,IAAI,SAAS,UAAU,OAAO,SAAS,WAAW,UAAU,QAAQ,KAAK,GAAG,cAAc,SAAS,MAAM,CAAC;CAE/G,IAAI,QAAQ,WAAW,KAAK,SAAS,eAAe,KAAA,GAAW,QAAQ,KAAK,YAAY;CACxF,OAAO,CAAC,GAAG,IAAI,IAAI,QAAQ,QAAQ,MAAM,CAAC,EAAE,SAAS,OAAO,KAAK,MAAM,gBAAgB,CAAC,CAAC,KAAK,MAAM,aAAa,KAAK,CAAC,CAAC,CAAC,CAAC;AAC5H;;AAGA,SAAgB,kBAAkB,MAAc,OAAsC;CACpF,IAAI,OAAO;CACX,IAAI,CAAC,MAAM;EACT,IAAI;GACF,OAAO,eAAe,aAAa,KAAK,MAAM,qBAAqB,GAAG,MAAM,CAAC;EAC/E,QAAQ;GACN,OAAO,CAAC;EACV;EACA,IAAI,KAAK,WAAW,GAAG,OAAO,CAAC,YAAY;CAC7C;CACA,MAAM,WAAW,KAAK,QAAQ,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC,CAAC,SAAS,MAAM,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAC9F,MAAM,OAAO,CAAC,GAAG,IAAI,IAAI,KAAK,QAAQ,MAAM,CAAC,EAAE,WAAW,GAAG,CAAC,CAAC,CAAC,SAAS,MAAM,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,MAAM,CAAC,SAAS,SAAS,CAAC,CAAC;CACrI,MAAM,QAA4B,CAAC;CACnC,KAAK,MAAM,OAAO,KAAK,KAAK,GAAG;EAC7B,IAAI;EACJ,IAAI;GACF,WAAW,KAAK,MAAM,aAAa,KAAK,MAAM,KAAK,cAAc,GAAG,MAAM,CAAC;EAC7E,QAAQ;GACN;EACF;EACA,IAAI,OAAO,SAAS,YAAY,UAAU;EAC1C,MAAM,KAAK;GAAE,MAAM,SAAS;GAAS;GAAK,SAAS,SAAS,eAAe;GAAM,SAAS,eAAe,KAAK,QAAQ;EAAE,CAAC;CAC3H;CACA,OAAO;AACT;;AAGA,SAAgB,cAAc,UAA8B,OAAoD,CAAC,GAAW;CAC1H,MAAM,OAAO,SAA0B,KAAK,YAAY,GAAG,KAAK,UAAU,GAAG,SAAS;CACtF,MAAM,aAAa,SAAS,KAAK,MAAM,IAAI,OAAO,EAAE,GAAG,EAAE,EAAE;CAC3D,MAAM,QAAgB,CAAC;CACvB,KAAK,MAAM,OAAO,UAAU;EAC1B,MAAM,MAAM,IAAI,OAAO,IAAI,GAAG,EAAE;EAChC,MAAM,SAAS,WAAW,QAAQ,SAAS,SAAS,GAAG;EACvD,IAAI,OAAO,SAAS,GAClB,MAAM,KAAK;GACT,MAAM,0BAA0B,KAAK,IAAI,IAAI;GAC7C,UAAU;GACV,SAAS,IAAI,wCAAwC,IAAI,KAAK,8EAA8E;GAC5I,MAAM,EAAE,MAAM,IAAI;GAClB,IAAI;IAAE,MAAM;IAAQ,SAAS;IAAK,iBAAiB,CAAC,OAAO;GAAE;EAC/D,CAAC;EAEH,MAAM,KAAK;GACT,MAAM,oBAAoB,KAAK,IAAI,IAAI;GACvC,UAAU;GACV,SAAS,IACP,wCAAwC,IAAI,KAAK,gJAAgJ,IAAI,KAAK,EAC5M;GACA,MAAM,EAAE,SAAS,IAAI;GACrB,IAAI,IAAI,QAAQ,SAAS,IAAI;IAAE,MAAM;IAAK,SAAS,IAAI;GAAQ,IAAI,EAAE,MAAM,IAAI;EACjF,CAAC;CACH;CACA,MAAM,QAAQ,SAAS,KAAK,MAAM,OAAO,EAAE,IAAI,CAAC;CAChD,IAAI,MAAM,SAAS,GACjB,MAAM,KAAK;EACT,MAAM;EACN,UAAU;EACV,SAAS,IAAI,kIAAkI;EAC/I,MAAM,CAAC;EACP,IAAI;GAAE,MAAM,KAAK,MAAM,KAAK,GAAG,EAAE;GAAS,iBAAiB;EAAK;CAClE,CAAC;CAEH,MAAM,OACJ,KAAK,SAAS,YAAY,SAAS,QAAQ,MAAM,EAAE,OAAO,IAAI,SAAS,QAAQ,OAAO,KAAK,QAAQ,CAAC,EAAA,CAAG,SAAS,EAAE,IAAI,CAAC;CACzH,KAAK,MAAM,OAAO,MAChB,MAAM,KAAK;EACT,MAAM,qBAAqB,KAAK,IAAI,IAAI;EACxC,UAAU;EACV,SAAS,IAAI,6BAA6B,IAAI,KAAK,4FAA4F;EAC/I,MAAM,EAAE,SAAS,IAAI,OAAO,IAAI,GAAG,EAAE,GAAG;EACxC,IAAI,EAAE,MAAM,IAAI,OAAO,IAAI,GAAG,EAAE,GAAG;CACrC,CAAC;CAEH,OAAO;AACT;AAEA,MAAM,QAAQ,SAAyB,KAAK,QAAQ,MAAM,EAAE,CAAC,CAAC,QAAQ,kBAAkB,GAAG;;;;;;;AAQ3F,SAAgB,cAAc,MAAwC;CACpE,IAAI,CAAC,MAAM,OAAO,CAAC;CACnB,MAAM,UAAU,cAAc,KAAK,MAAM,cAAc,CAAC;CACxD,IAAI;EACF,MAAM,EAAE,YAAY,QAAQ,yBAAyB;EAErD,IAAI,OAAO,QAAQ,MAAM,GAAG,CAAC,CAAC,EAAE,IAAI,GAAG,OAAO,EAAE,sBAAsB,KAAK;CAC7E,QAAQ,CAER;CAEA,KAAK,MAAM,QAAQ,CAAC,SAAS,cAAc,YAAY,GAAG,CAAC,GACzD,IAAI;EACF,KAAK,QAAQ,WAAW;EACxB,OAAO,EAAE,QAAQ,MAAM;CACzB,QAAQ,CAER;CAEF,OAAO,CAAC;AACV;;;;;;;AAQA,SAAgB,eAAe,MAAwC;CACrE,OAAO;EACL,GAAG,cAAc,IAAI;EACrB,SAAS,EACP,MAAM;GAAC;GAAsB;GAAsC;GAAmB;EAAuC,EAC/H;EACA,aAAa,EAAE,MAAM,CAAC,oBAAoB,EAAE;EAC5C,wBAAwB;GACtB,eAAe,CAAC,SAAS;GACzB,gBAAgB;IAAC;IAAU;IAAW;IAAQ;GAAS;GACvD,YAAY,CAAC,UAAU,MAAM;EAC/B;EACA,wBAAwB;CAC1B;AACF;;AAGA,SAAgB,WAAW,MAAc,OAAwB,CAAC,GAAW;CAC3E,MAAM,WAAW,kBAAkB,MAAM,KAAK,QAAQ;CACtD,MAAM,UAAU;EAAE,GAAG,eAAe,IAAI;EAAG,GAAG,KAAK;CAAQ;CAC3D,OAAO;EACL,WAAW,CAAC,GAAG,cAAc,UAAU,IAAI,GAAG,GAAI,KAAK,aAAa,CAAC,CAAE;EACvE;CACF;AACF"}

package/package.json

@@ -1,13 +1,79 @@
 {
+  "$schema": "https://json.schemastore.org/package",
   "name": "@mark1russell7/boundaries",
-  "version": "0.0.0-bootstrap.0",
-  "description": "A placeholder that lets npm trust the release workflow of mark1russell7/template. Use a later version.",
+  "version": "0.1.0",
+  "description": "The import boundaries of a pnpm workspace as a dependency-cruiser configuration: each package is imported only through the entries of its package.json.",
+  "keywords": [
+    "dependency-cruiser",
+    "monorepo",
+    "pnpm",
+    "workspace",
+    "architecture",
+    "boundaries",
+    "exports",
+    "lint"
+  ],
+  "homepage": "https://github.com/mark1russell7/template/tree/main/packages/boundaries#readme",
+  "bugs": {
+    "url": "https://github.com/mark1russell7/template/issues"
+  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/mark1russell7/template.git"
+    "url": "git+https://github.com/mark1russell7/template.git",
+    "directory": "packages/boundaries"
   },
   "license": "MIT",
+  "author": "Mark Russell (https://github.com/mark1russell7)",
+  "type": "module",
+  "main": "./build/index.js",
+  "files": [
+    "build"
+  ],
   "publishConfig": {
     "access": "public"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "peerDependencies": {
+    "dependency-cruiser": "^17.0.0 || ^18.0.0",
+    "@swc/core": "^1.10.0"
+  },
+  "peerDependenciesMeta": {
+    "dependency-cruiser": {
+      "optional": true
+    },
+    "@swc/core": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@mark1russell7/cue": "^1.0.2",
+    "@types/node": "^26.6.4",
+    "typescript": "^7.0.2",
+    "vitest": "^5.0.3",
+    "dependency-cruiser": "^18.7.0",
+    "tsdown": "^0.23.1",
+    "@swc/core": "^1.15.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc -p tsconfig.json && tsc -p tsconfig.test.json"
+  },
+  "types": "./build/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./build/index.d.ts",
+        "default": "./build/index.js"
+      },
+      "require": {
+        "types": "./build/index.d.cts",
+        "default": "./build/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
   }
-}
+}