@rdjperron/lint 0.5.0 → 0.6.0

package/README.md

@@ -1,12 +1,14 @@
 # @rdjperron/lint
 
 One Oxlint JS plugin, `rdjperron`, with twenty rules against low-evidence code, the config data a
-project spreads into its own `vite.config.ts`, and the check that proves every rule still fires.
+project spreads into its own `vite.config.ts`, the check that proves every rule still fires, and
+the repository checks that hold a repo's documents to their own conventions.
 
 | Entry                    | What it gives you                                                                  |
 | ------------------------ | ---------------------------------------------------------------------------------- |
 | `@rdjperron/lint`        | The plugin. One `jsPlugins` entry, one prefix, twenty rules.                       |
 | `@rdjperron/lint/config` | `recommended`, the override builders, and the `fmt`, `ignore` and `staged` blocks. |
+| `@rdjperron/lint/repo`   | `checkRepo`, five checks on a repo's links, decision register and research names.  |
 | `rdjperron-lint-verify`  | The command that proves every rule still fires. No config, no arguments.           |
 
 Seventeen of the rules are a copy of [dmmulroy/anti-slop](https://github.com/dmmulroy/anti-slop),
@@ -184,6 +186,147 @@ one right after you move `vite-plus`, and in CI.
 One thing not to do: do not delete the fixtures. They are the only thing that catches a rule going
 dead.
 
+## Repository checks
+
+`@rdjperron/lint/repo` is for a repo that keeps a decision register in `docs/decisions.md` and
+dated research in `_research/`. Prose can state those conventions and cannot enforce them. `checkRepo`
+reads the tree and returns what breaks them, so a test fails on a dead link or on a citation of a
+retired decision.
+
+It is plain Node and imports no test runner. You call it from a test of your own:
+
+```ts
+// lib/repo.test.ts
+import { fileURLToPath } from "node:url";
+
+import { CHECKS, checkRepo, HINTS, TITLES } from "@rdjperron/lint/repo";
+import { describe, expect, it } from "vitest";
+
+const faults = checkRepo({
+  root: fileURLToPath(new URL("..", import.meta.url)),
+  codeRoots: ["app", "components", "lib", "convex", "e2e"],
+  linked: ["e2e/README.md"],
+});
+
+describe("the tree", () => {
+  for (const check of CHECKS) {
+    it(TITLES[check], () => {
+      expect(faults[check], HINTS[check]).toEqual([]);
+    });
+  }
+});
+```
+
+Loop over `CHECKS` rather than listing the checks by hand. A check added in a later version then
+runs in your repo the day you move the pin, and nobody has to remember to assert it.
+
+`checkRepo` returns one array of faults per check, empty where the check holds. A fault is one
+line that opens with a path relative to the root, with the line number when the fault has one:
+
+```
+README.md:63 points at docs/not-there.md, which is not there
+src/main.tsx:43 cites D16, which is retired
+_research/notes.md is not named YYYYMMDD.HHMM.topic.md or YYYYMMDD.topic/
+src, named by `codeRoots`, is not there
+```
+
+`TITLES` holds what each check promises, for the test's name. `HINTS` holds one sentence per check
+saying how to fix it, which the example passes to `expect` as the failure message. `CHECKS` is the
+five names: `scans`, `links`, `register`, `citations`, `research`.
+
+`checkRepo` does not throw on a tree or a config it cannot read. A code root that is a file, a
+register that is a directory, a symbolic link that leads nowhere and a root that does not exist
+are each a fault in `scans`, and a link whose percent-escapes do not decode is a fault in `links`.
+
+### What each check holds
+
+| Check       | What it holds                                                                                                                                                                                                                                                                                                                |
+| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `links`     | Every relative Markdown link in the living documents and in each research folder's `README.md` points at a path that exists. A URL with a scheme, a `//host` and a bare `#anchor` are skipped, and an anchor after a path is dropped before the path is tested.                                                              |
+| `register`  | Every row is one line, `- **Dn** Sentence. (YYYY-MM-DD)` or `- **Dn** Sentence. (YYYY-MM-DD, source)`. Each number is given once and is not also in the retired list. No number is missing up to the highest ever given. No other line names a number in bold. A `## Retired` section exists, and it may name no number yet. |
+| `citations` | Every `D<n>` in the scanned files, and in the register's own rows after their number, is a live row. A retired number fails as retired and a number never given fails as unknown.                                                                                                                                            |
+| `research`  | Each entry of `_research/` is a file `YYYYMMDD.HHMM.topic.md` or a folder `YYYYMMDD.topic/` that holds a `README.md`. The topic is lowercase letters, digits and hyphens.                                                                                                                                                    |
+| `scans`     | Every path the config names is there and is the right kind, a file or a directory, defaults included. Every code root yields a file to scan. The register has a row. No symbolic link a walk meets leads nowhere.                                                                                                            |
+
+`scans` exists because a check that reads nothing passes. Rename `lib/` to `src/` without touching
+the config and the citation scan would cover one directory fewer and stay green. With `scans` the
+missing root is a fault.
+
+`scans` holds paths and files, not matches. A repo with no research directory, an empty one, no
+relative link or no citation yet is clean, so a repository can turn the test on from its first
+commit. The one path that may be absent is the research directory.
+
+The living documents are `README.md`, `AGENTS.md` and `BACKLOG.md` at the root, every `.md` file
+under `docs/`, and the documents `linked` names. Their links are held and they are scanned for
+citations, the register excepted. The citation scan also reads every file under a code root with a
+scanned extension, and every file at the root with one. A lockfile is never scanned, meaning a
+name that ends in `-lock.json`, `-lock.yaml` or the like.
+
+The research is frozen once written, so the checks read little of it. The body of a research
+entry is checked for neither links nor citations, since it names paths and numbers as they stood on
+its date. Only a research folder's `README.md` has its links held, and nothing under the research
+directory is scanned for citations, even if you name it as a code root or keep it under `docs/`.
+The retired numbers are every `D<n>` in the `## Retired` section, up to the next `##` heading. The
+prose around the register's rows may name any number.
+
+When the register cannot be read, `scans` says so once, and `register` and `citations` stay empty
+rather than failing every citation in the repo.
+
+### The config
+
+Every path is relative to the root, and `lib`, `./lib` and `lib/` name the same one.
+
+| Field        | Default                                                                               | What it is                                                                                                        |
+| ------------ | ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
+| `root`       | required                                                                              | The repository root. A relative one is resolved against the working directory.                                    |
+| `codeRoots`  | required                                                                              | The directories scanned for citations. `["."]` scans the whole root.                                              |
+| `extensions` | `ts` `tsx` `mts` `cts` `js` `jsx` `mjs` `cjs` `md` `json` `jsonc` `yml` `yaml` `html` | The extensions scanned for citations. Yours replace the default list.                                             |
+| `skip`       | `node_modules` `_generated` `dist`                                                    | Names no walk enters, wherever they sit. Yours are added to the default list.                                     |
+| `leftOut`    | none                                                                                  | Paths no walk enters, as `{ path: reason }`. The reason is for the reader.                                        |
+| `documents`  | `README.md` `AGENTS.md` `BACKLOG.md`                                                  | The living documents at the root. Yours replace the default list, so a repo with no backlog names the two it has. |
+| `docs`       | `docs`                                                                                | The directory whose every `.md` file is a living document.                                                        |
+| `linked`     | none                                                                                  | More living documents, such as `e2e/README.md`.                                                                   |
+| `register`   | `decisions.md` in the `docs` directory                                                | The decision register. It follows `docs`: with `docs: "handbook"` it is `handbook/decisions.md`.                  |
+| `research`   | `_research`                                                                           | The research directory. It may be absent.                                                                         |
+
+`skip` matches a name at any depth, so `skip: ["fixtures"]` leaves out every `fixtures` directory.
+`leftOut` matches one path, for a directory whose name is legitimate elsewhere:
+
+```ts
+leftOut: { "site/.well-known": "certificate fingerprints read like decision numbers" },
+```
+
+Both act on what a walk finds under `docs`, under a code root and at the root. Neither removes a
+document you name in `documents` or `linked`. To stop holding one of those, take it off its list.
+
+A citation is any `D` followed by digits and standing as a word of its own, so recorded data full
+of ids such as `D12` is the usual reason to leave a path out. Leave it out with `skip` or
+`leftOut`, or keep its extension off the list, as with `csv`.
+
+`DEFAULT_DOCUMENTS`, `DEFAULT_EXTENSIONS` and `DEFAULT_SKIP` are exported, for a config that adds
+to a list the field replaces.
+
+### What the checks do not do
+
+They hold form, not truth. A link that resolves may point at the wrong document. A row may be well
+formed and state a rule the code broke last week. A citation of a live number may cite the wrong
+rule. A research entry with a correct name may be empty.
+
+They also leave these alone:
+
+- An anchor is not checked against the headings of its target.
+- A link written as bare text, as `<path>`, inside an HTML tag, with a title in single quotes or
+  with parentheses in its path is not read as a link, or is read wrong.
+- A link that opens with `/` is tested against the filesystem root, not the repository's.
+- The date in a row or in a research name is not checked to be a real date.
+- `**D11.**` and `**D12a**` are neither a row nor row-like, so the register check does not see them.
+- `#D12` and `-D16` count as citations, since the `D` still opens a word.
+- Any file directly under the research directory that is not a dated note is a fault, a
+  `README.md` or a `.DS_Store` included.
+- A linked directory is not entered, since it may lead back to one of its own parents.
+
+Reading the rows against the code is still a review's job.
+
 ## The rules
 
 Each rule file opens with the reason the rule exists and the case where it is legitimate to
@@ -248,6 +391,12 @@ Land a new rule at `warn`, fix or scope what fires, then promote it. When a rule
 code or add a narrowly scoped override with the measurement that justifies it. Never weaken the
 rule, add a cast, or rename a symbol to dodge the check.
 
+## Moving from 0.5
+
+Nothing is removed and nothing changes. 0.6.0 adds `@rdjperron/lint/repo`. A repo that carries the
+checks as a test file of its own replaces that file with the example under "Repository checks",
+and keeps only its config.
+
 ## Moving from 0.4
 
 Nothing is removed. One builder changed what it does, and three are new.

package/dist/repo.d.mts

@@ -0,0 +1,71 @@
+//#region src/repo.d.ts
+/**
+ * The promises a repository's prose can only state, held as faults instead.
+ *
+ *   - a relative Markdown link points at something that is there;
+ *   - the decision register is one well-formed line per row, each number given once;
+ *   - a decision number cited anywhere is a live row in the register, never a retired one;
+ *   - a research entry is named by its date, and a dated folder opens with a README;
+ *   - every path the config names is there and holds something to check.
+ *
+ * Every path in a fault is relative to the root, so it reads as the path you would type to open
+ * the offender. Nothing here imports a test runner: the consumer's test asserts on what
+ * `checkRepo` returns. It never throws on a tree or a config it cannot read: that is a fault too.
+ */
+export interface RepoConfig {
+  /** The repository root, absolute. */
+  root: string;
+  /**
+   * The directories scanned for decision numbers. Every path in this config is relative to the
+   * root, and `lib`, `./lib` and `lib/` name the same one.
+   */
+  codeRoots: readonly string[];
+  /**
+   * The extensions scanned for decision numbers, in the code roots and at the root itself.
+   * Replaces `DEFAULT_EXTENSIONS`.
+   */
+  extensions?: readonly string[];
+  /** Directory and file names no walk enters, wherever they sit. Added to `DEFAULT_SKIP`. */
+  skip?: readonly string[];
+  /** Paths no walk enters, each with the reason it is left out. */
+  leftOut?: {
+    readonly [path: string]: string;
+  };
+  /** The living documents at the root. Replaces `DEFAULT_DOCUMENTS`. */
+  documents?: readonly string[];
+  /** The directory whose every Markdown file is a living document. `docs` by default. */
+  docs?: string;
+  /** More documents held as the living ones are, for their links and their citations. */
+  linked?: readonly string[];
+  /** The decision register. `decisions.md` in the `docs` directory by default. */
+  register?: string;
+  /** The research directory. `_research` by default, and a repo may have none yet. */
+  research?: string;
+}
+export declare const CHECKS: readonly ["scans", "links", "register", "citations", "research"];
+export type Check = (typeof CHECKS)[number];
+/** The faults of each check, empty where the check holds. */
+export type RepoFaults = { readonly [check in Check]: readonly string[]; };
+/** What each check promises, for the title of the consumer's test. */
+export declare const TITLES: {
+  scans: string;
+  links: string;
+  register: string;
+  citations: string;
+  research: string;
+};
+/** What to do about a failing check, for the message of the consumer's assertion. */
+export declare const HINTS: {
+  scans: string;
+  links: string;
+  register: string;
+  citations: string;
+  research: string;
+};
+export declare const DEFAULT_DOCUMENTS: readonly string[];
+export declare const DEFAULT_EXTENSIONS: readonly string[];
+/** Vendored, generated and built trees. */
+export declare const DEFAULT_SKIP: readonly string[];
+export declare function checkRepo(config: RepoConfig): RepoFaults;
+//#endregion
+//# sourceMappingURL=repo.d.mts.map

package/dist/repo.mjs

@@ -0,0 +1,357 @@
+import { lstatSync, readFileSync, readdirSync, statSync } from "node:fs";
+import { dirname, join, posix, relative, resolve } from "node:path";
+//#region src/repo.ts
+/**
+* The promises a repository's prose can only state, held as faults instead.
+*
+*   - a relative Markdown link points at something that is there;
+*   - the decision register is one well-formed line per row, each number given once;
+*   - a decision number cited anywhere is a live row in the register, never a retired one;
+*   - a research entry is named by its date, and a dated folder opens with a README;
+*   - every path the config names is there and holds something to check.
+*
+* Every path in a fault is relative to the root, so it reads as the path you would type to open
+* the offender. Nothing here imports a test runner: the consumer's test asserts on what
+* `checkRepo` returns. It never throws on a tree or a config it cannot read: that is a fault too.
+*/
+const CHECKS = [
+	"scans",
+	"links",
+	"register",
+	"citations",
+	"research"
+];
+/** What each check promises, for the title of the consumer's test. */
+const TITLES = {
+	scans: "every path the config names is there and holds something to check",
+	links: "every relative Markdown link resolves",
+	register: "the register is one well-formed line per row, each number given once",
+	citations: "every decision number cited anywhere is a live row in the register",
+	research: "every research entry is named by its date, and every dated folder has a README"
+};
+/** What to do about a failing check, for the message of the consumer's assertion. */
+const HINTS = {
+	scans: "A check that reads nothing passes on nothing. Correct the path in the config, or remove it with the thing it named.",
+	links: "Fix the path, or delete the link with the thing it pointed at.",
+	register: "A row is one line, its number given once and never after it was retired, and a number that leaves the rows joins the retired list. Rewrite a rule in place under its own number.",
+	citations: "A citation of a retired number, or of one never given, sends the reader nowhere. Cite the row that carries the rule now. `git log -S \"D<n>\"` on the register shows what a retired row said.",
+	research: "The research sorts by name, so the name carries the date. Date an entry by the day it was opened, and give a folder a README that says what is in it."
+};
+const DEFAULT_DOCUMENTS = [
+	"README.md",
+	"AGENTS.md",
+	"BACKLOG.md"
+];
+const DEFAULT_EXTENSIONS = [
+	"ts",
+	"tsx",
+	"mts",
+	"cts",
+	"js",
+	"jsx",
+	"mjs",
+	"cjs",
+	"md",
+	"json",
+	"jsonc",
+	"yml",
+	"yaml",
+	"html"
+];
+/** Vendored, generated and built trees. */
+const DEFAULT_SKIP = [
+	"node_modules",
+	"_generated",
+	"dist"
+];
+function kindOf(tree, path) {
+	try {
+		return statSync(join(tree.root, path)).isDirectory() ? "directory" : "file";
+	} catch {
+		return "absent";
+	}
+}
+function isSymbolicLink(tree, path) {
+	try {
+		return lstatSync(join(tree.root, path)).isSymbolicLink();
+	} catch {
+		return false;
+	}
+}
+function read(tree, path) {
+	return readFileSync(join(tree.root, path), "utf8").replaceAll("\r\n", "\n");
+}
+function names(tree, path) {
+	try {
+		return readdirSync(join(tree.root, path)).toSorted();
+	} catch {
+		return [];
+	}
+}
+function child(base, name) {
+	return base === "" ? name : `${base}/${name}`;
+}
+function walk(tree, base) {
+	return names(tree, base).flatMap((name) => {
+		const path = child(base, name);
+		if (tree.skip.has(name) || tree.leftOut.has(path)) return [];
+		const kind = kindOf(tree, path);
+		if (kind === "file") return [path];
+		if (kind === "absent") tree.broken.add(path);
+		return kind === "directory" && !isSymbolicLink(tree, path) ? walk(tree, path) : [];
+	});
+}
+/** `lib`, `./lib` and `lib/` are one path, and the root itself is the empty one. */
+function normal(path) {
+	const clean = posix.normalize(path).replace(/\/+$/, "");
+	return clean === "." ? "" : clean;
+}
+function hasExtension(name, extensions) {
+	return extensions.some((extension) => name.endsWith(`.${extension}`));
+}
+function lineOf(source, index) {
+	return source.slice(0, index).split("\n").length;
+}
+/** A single note, `YYYYMMDD.HHMM.topic.md`. */
+const DATED_NOTE = /^\d{8}\.\d{4}\.[a-z0-9-]+\.md$/;
+/** Research of several files, `YYYYMMDD.topic/`. */
+const DATED_FOLDER = /^\d{8}\.[a-z0-9-]+$/;
+function researchFaults(tree, entries) {
+	return entries.flatMap((entry) => {
+		if (!(entry.folder ? DATED_FOLDER : DATED_NOTE).test(entry.name)) return [`${entry.path} is not named YYYYMMDD.HHMM.topic.md or YYYYMMDD.topic/`];
+		return entry.folder && kindOf(tree, `${entry.path}/README.md`) !== "file" ? [`${entry.path}/ has no README.md`] : [];
+	});
+}
+/** `](target)`, with an optional title. Bare `path.md` inside backticks is not a link. */
+const LINK = /\]\(([^)\s]+)(?:\s+"[^"]*")?\)/g;
+/** A scheme, a protocol-relative host or a bare anchor: the target is outside the tree. */
+const OUTSIDE = /^(?:[a-z][a-z0-9+.-]*:|\/\/|#)/i;
+function decoded(target) {
+	try {
+		return decodeURI(target.split("#")[0] ?? "");
+	} catch {
+		return;
+	}
+}
+function linksIn(tree, file) {
+	const source = read(tree, file);
+	return [...source.matchAll(LINK)].flatMap((match) => {
+		const target = match[1] ?? "";
+		const path = decoded(target);
+		if (OUTSIDE.test(target) || path === "") return [];
+		const points = path === void 0 ? void 0 : relative(tree.root, resolve(tree.root, dirname(file), path));
+		return [{
+			from: file,
+			target,
+			line: lineOf(source, match.index),
+			points
+		}];
+	});
+}
+function linkFaults(tree, links) {
+	return links.flatMap((link) => {
+		const at = `${link.from}:${link.line} points at ${link.target}`;
+		if (link.points === void 0) return [`${at}, whose percent-escapes do not decode`];
+		return kindOf(tree, link.points) === "absent" ? [`${at}, which is not there`] : [];
+	});
+}
+/** A line that opens as a row does: a list item whose first word is a bold decision number. */
+const ROW_START = /^- \*\*D(\d+)\*\*/gm;
+/** A whole row: the number, one sentence or more, then the date and an optional source. */
+const ROW = /^- \*\*D\d+\*\* \S.*[.?!] \(\d{4}-\d{2}-\d{2}(?:, \S.*)?\)$/;
+/** A line that names a number in bold as a row does, whatever it opens with. */
+const ROW_LIKE = /\*\*D\d+\*\*/;
+const RETIRED_SECTION = /^## Retired[ \t]*$([\s\S]*?)(?=^## |(?![\s\S]))/m;
+/** A mistyped number in the retired list would otherwise print a gap per number below it. */
+const GAPS_SHOWN = 20;
+const CITATION = /\bD(\d+)\b/g;
+function numbersIn(text) {
+	return [...text.matchAll(CITATION)].map((match) => Number(match[1]));
+}
+function readRegister(tree, path) {
+	const text = kindOf(tree, path) === "file" ? read(tree, path) : "";
+	const rows = [...text.matchAll(ROW_START)].map((match) => ({
+		number: Number(match[1]),
+		line: lineOf(text, match.index),
+		text: text.slice(match.index).split("\n", 1)[0] ?? ""
+	}));
+	const section = RETIRED_SECTION.exec(text);
+	return {
+		path,
+		text,
+		rows,
+		live: new Set(rows.map((row) => row.number)),
+		retired: new Set(numbersIn(section?.[1] ?? "")),
+		hasRetiredSection: section !== null
+	};
+}
+function rowFaults(register) {
+	const seen = /* @__PURE__ */ new Set();
+	return register.rows.flatMap((row) => {
+		const at = `${register.path}:${row.line} D${row.number}`;
+		const found = [
+			...ROW.test(row.text) ? [] : [`${at} is not "- **Dn** Sentence. (date, source)"`],
+			...seen.has(row.number) ? [`${at} is a second row`] : [],
+			...register.retired.has(row.number) ? [`${at} is retired`] : []
+		];
+		seen.add(row.number);
+		return found;
+	});
+}
+function gapFaults(register) {
+	const highest = Math.max(0, ...register.live, ...register.retired);
+	const gaps = [];
+	let more = 0;
+	for (let number = 1; number <= highest; number++) {
+		if (register.live.has(number) || register.retired.has(number)) continue;
+		if (gaps.length < GAPS_SHOWN) gaps.push(number);
+		else more++;
+	}
+	return [...gaps.map((number) => `${register.path} D${number} is neither a row nor retired`), ...more === 0 ? [] : [`${register.path} ${more} more numbers up to D${highest} are neither a row nor retired`]];
+}
+function registerFaults(register) {
+	const rowLike = register.text.split("\n").flatMap((text, index) => ROW_LIKE.test(text) && !text.startsWith("- **D") ? [`${register.path}:${index + 1} names a row but is not one: "${text.slice(0, 40)}"`] : []);
+	return [
+		...rowFaults(register),
+		...rowLike,
+		...register.hasRetiredSection ? [] : [`${register.path} has no "## Retired" section`],
+		...gapFaults(register)
+	];
+}
+function citationsIn(tree, file) {
+	const source = read(tree, file);
+	return [...source.matchAll(CITATION)].map((match) => ({
+		where: `${file}:${lineOf(source, match.index)}`,
+		number: Number(match[1])
+	}));
+}
+/** A row may cite another row. The retired list and the prose around the rows are not held. */
+function citationsInRows(register) {
+	return register.rows.flatMap((row) => numbersIn(row.text.slice(row.text.indexOf("**", 4) + 2)).map((number) => ({
+		where: `${register.path}:${row.line}`,
+		number
+	})));
+}
+function citationFaults(register, citations) {
+	return citations.flatMap(({ where, number }) => {
+		if (register.live.has(number)) return [];
+		return register.retired.has(number) ? [`${where} cites D${number}, which is retired`] : [`${where} cites D${number}, which the register has no row for`];
+	});
+}
+function isUnder(path, base) {
+	return base === "" || path === base || path.startsWith(`${base}/`);
+}
+/** `package-lock.json`, `pnpm-lock.yaml`: generated, and full of hashes that read like numbers. */
+const LOCKFILE = /[-_.]lock\.(?:json|jsonc|ya?ml)$/;
+function allNamed(by, paths, want) {
+	return paths.map((path) => ({
+		path: normal(path),
+		by,
+		want
+	}));
+}
+function namedOr(option, path, fallback, want) {
+	return path === void 0 ? {
+		path: fallback,
+		by: `the default of \`${option}\``,
+		want
+	} : {
+		path: normal(path),
+		by: `named by \`${option}\``,
+		want
+	};
+}
+function namedFault(tree, named) {
+	const kind = kindOf(tree, named.path);
+	if (kind === named.want) return [];
+	return [`${named.path === "" ? "." : named.path}, ${named.by}, is ${kind === "absent" ? "not there" : `not a ${named.want}`}`];
+}
+function usable(tree, named) {
+	return named.flatMap((one) => kindOf(tree, one.path) === one.want ? [one.path] : []);
+}
+const NO_FAULTS = {
+	scans: [],
+	links: [],
+	register: [],
+	citations: [],
+	research: []
+};
+function checkRepo(config) {
+	const leftOut = Object.keys(config.leftOut ?? {}).map(normal);
+	const tree = {
+		root: resolve(config.root),
+		skip: /* @__PURE__ */ new Set([...DEFAULT_SKIP, ...config.skip ?? []]),
+		leftOut: new Set(leftOut),
+		extensions: config.extensions ?? DEFAULT_EXTENSIONS,
+		broken: /* @__PURE__ */ new Set()
+	};
+	if (kindOf(tree, "") !== "directory") return {
+		...NO_FAULTS,
+		scans: [`${tree.root}, named by \`root\`, is not a directory`]
+	};
+	const docs = namedOr("docs", config.docs, "docs", "directory");
+	const registerAt = namedOr("register", config.register, child(docs.path, "decisions.md"), "file");
+	const research = namedOr("research", config.research, "_research", "directory");
+	const codeRoots = allNamed("named by `codeRoots`", config.codeRoots, "directory");
+	const documents = config.documents === void 0 ? allNamed("a default of `documents`", DEFAULT_DOCUMENTS, "file") : allNamed("named by `documents`", config.documents, "file");
+	const linked = allNamed("named by `linked`", config.linked ?? [], "file");
+	const researchKind = kindOf(tree, research.path);
+	const entries = (researchKind === "directory" ? names(tree, research.path) : []).flatMap((name) => {
+		const path = child(research.path, name);
+		const kind = kindOf(tree, path);
+		if (kind === "absent") tree.broken.add(path);
+		return kind === "absent" ? [] : [{
+			path,
+			name,
+			folder: kind === "directory"
+		}];
+	});
+	const frozen = (file) => isUnder(file, research.path);
+	const living = [
+		...usable(tree, documents),
+		...walk(tree, docs.path).filter((file) => file.endsWith(".md") && !frozen(file)),
+		...usable(tree, linked)
+	];
+	const linking = /* @__PURE__ */ new Set([...living, ...entries.flatMap((entry) => {
+		const readme = `${entry.path}/README.md`;
+		return entry.folder && kindOf(tree, readme) === "file" ? [readme] : [];
+	})]);
+	const scanned = usable(tree, codeRoots).map((base) => ({
+		base,
+		files: walk(tree, base).filter((file) => hasExtension(file, tree.extensions))
+	}));
+	const atRoot = names(tree, "").filter((name) => hasExtension(name, tree.extensions) && !tree.skip.has(name) && !tree.leftOut.has(name) && kindOf(tree, name) === "file");
+	const citing = [.../* @__PURE__ */ new Set([
+		...living,
+		...scanned.flatMap((scan) => scan.files),
+		...atRoot
+	])].filter((file) => file !== registerAt.path && !frozen(file) && !LOCKFILE.test(file));
+	const held = kindOf(tree, registerAt.path) === "file";
+	const register = readRegister(tree, registerAt.path);
+	const wrongKind = researchKind === "file" ? namedFault(tree, research) : [];
+	const leftOutFaults = leftOut.flatMap((path) => kindOf(tree, path) === "absent" ? [`${path}, named by \`leftOut\`, is not there`] : []);
+	return {
+		scans: [
+			...[
+				...codeRoots,
+				...documents,
+				docs,
+				registerAt,
+				...linked
+			].flatMap((one) => namedFault(tree, one)),
+			...wrongKind,
+			...leftOutFaults,
+			...scanned.flatMap((scan) => scan.files.length === 0 ? [`${scan.base === "" ? "." : scan.base} holds no file to scan for decision numbers`] : []),
+			...held && register.rows.length === 0 ? [`${registerAt.path} holds no row`] : [],
+			...[...tree.broken].toSorted().map((path) => `${path} is a symbolic link that leads nowhere`)
+		],
+		links: linkFaults(tree, [...linking].flatMap((file) => linksIn(tree, file))),
+		register: held ? registerFaults(register) : [],
+		citations: held ? citationFaults(register, [...citing.flatMap((file) => citationsIn(tree, file)), ...citationsInRows(register)]) : [],
+		research: researchFaults(tree, entries)
+	};
+}
+//#endregion
+export { CHECKS, DEFAULT_DOCUMENTS, DEFAULT_EXTENSIONS, DEFAULT_SKIP, HINTS, TITLES, checkRepo };
+
+//# sourceMappingURL=repo.mjs.map

package/dist/repo.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"repo.mjs","names":[],"sources":["../src/repo.ts"],"sourcesContent":["/**\n * The promises a repository's prose can only state, held as faults instead.\n *\n *   - a relative Markdown link points at something that is there;\n *   - the decision register is one well-formed line per row, each number given once;\n *   - a decision number cited anywhere is a live row in the register, never a retired one;\n *   - a research entry is named by its date, and a dated folder opens with a README;\n *   - every path the config names is there and holds something to check.\n *\n * Every path in a fault is relative to the root, so it reads as the path you would type to open\n * the offender. Nothing here imports a test runner: the consumer's test asserts on what\n * `checkRepo` returns. It never throws on a tree or a config it cannot read: that is a fault too.\n */\n\nimport { lstatSync, readdirSync, readFileSync, statSync } from \"node:fs\";\nimport { dirname, join, posix, relative, resolve } from \"node:path\";\n\nexport interface RepoConfig {\n  /** The repository root, absolute. */\n  root: string;\n  /**\n   * The directories scanned for decision numbers. Every path in this config is relative to the\n   * root, and `lib`, `./lib` and `lib/` name the same one.\n   */\n  codeRoots: readonly string[];\n  /**\n   * The extensions scanned for decision numbers, in the code roots and at the root itself.\n   * Replaces `DEFAULT_EXTENSIONS`.\n   */\n  extensions?: readonly string[];\n  /** Directory and file names no walk enters, wherever they sit. Added to `DEFAULT_SKIP`. */\n  skip?: readonly string[];\n  /** Paths no walk enters, each with the reason it is left out. */\n  leftOut?: { readonly [path: string]: string };\n  /** The living documents at the root. Replaces `DEFAULT_DOCUMENTS`. */\n  documents?: readonly string[];\n  /** The directory whose every Markdown file is a living document. `docs` by default. */\n  docs?: string;\n  /** More documents held as the living ones are, for their links and their citations. */\n  linked?: readonly string[];\n  /** The decision register. `decisions.md` in the `docs` directory by default. */\n  register?: string;\n  /** The research directory. `_research` by default, and a repo may have none yet. */\n  research?: string;\n}\n\nexport const CHECKS = [\"scans\", \"links\", \"register\", \"citations\", \"research\"] as const;\n\nexport type Check = (typeof CHECKS)[number];\n\n/** The faults of each check, empty where the check holds. */\nexport type RepoFaults = { readonly [check in Check]: readonly string[] };\n\n/** What each check promises, for the title of the consumer's test. */\nexport const TITLES = {\n  scans: \"every path the config names is there and holds something to check\",\n  links: \"every relative Markdown link resolves\",\n  register: \"the register is one well-formed line per row, each number given once\",\n  citations: \"every decision number cited anywhere is a live row in the register\",\n  research: \"every research entry is named by its date, and every dated folder has a README\",\n} satisfies { readonly [check in Check]: string };\n\n/** What to do about a failing check, for the message of the consumer's assertion. */\nexport const HINTS = {\n  scans:\n    \"A check that reads nothing passes on nothing. Correct the path in the config, or remove it \" +\n    \"with the thing it named.\",\n  links: \"Fix the path, or delete the link with the thing it pointed at.\",\n  register:\n    \"A row is one line, its number given once and never after it was retired, and a number that \" +\n    \"leaves the rows joins the retired list. Rewrite a rule in place under its own number.\",\n  citations:\n    \"A citation of a retired number, or of one never given, sends the reader nowhere. Cite the \" +\n    'row that carries the rule now. `git log -S \"D<n>\"` on the register shows what a retired ' +\n    \"row said.\",\n  research:\n    \"The research sorts by name, so the name carries the date. Date an entry by the day it was \" +\n    \"opened, and give a folder a README that says what is in it.\",\n} satisfies { readonly [check in Check]: string };\n\nexport const DEFAULT_DOCUMENTS: readonly string[] = [\"README.md\", \"AGENTS.md\", \"BACKLOG.md\"];\n\nexport const DEFAULT_EXTENSIONS: readonly string[] = [\n  \"ts\",\n  \"tsx\",\n  \"mts\",\n  \"cts\",\n  \"js\",\n  \"jsx\",\n  \"mjs\",\n  \"cjs\",\n  \"md\",\n  \"json\",\n  \"jsonc\",\n  \"yml\",\n  \"yaml\",\n  \"html\",\n];\n\n/** Vendored, generated and built trees. */\nexport const DEFAULT_SKIP: readonly string[] = [\"node_modules\", \"_generated\", \"dist\"];\n\ninterface Tree {\n  root: string;\n  skip: ReadonlySet<string>;\n  leftOut: ReadonlySet<string>;\n  extensions: readonly string[];\n  /** Symbolic links a walk met that lead nowhere. */\n  broken: Set<string>;\n}\n\ntype Kind = \"file\" | \"directory\" | \"absent\";\n\nfunction kindOf(tree: Tree, path: string): Kind {\n  try {\n    return statSync(join(tree.root, path)).isDirectory() ? \"directory\" : \"file\";\n  } catch {\n    return \"absent\";\n  }\n}\n\nfunction isSymbolicLink(tree: Tree, path: string): boolean {\n  try {\n    return lstatSync(join(tree.root, path)).isSymbolicLink();\n  } catch {\n    return false;\n  }\n}\n\n// A Windows checkout may hand back CRLF, and every pattern here ends its line on `\\n`.\nfunction read(tree: Tree, path: string): string {\n  return readFileSync(join(tree.root, path), \"utf8\").replaceAll(\"\\r\\n\", \"\\n\");\n}\n\nfunction names(tree: Tree, path: string): string[] {\n  try {\n    return readdirSync(join(tree.root, path)).toSorted();\n  } catch {\n    return [];\n  }\n}\n\nfunction child(base: string, name: string): string {\n  return base === \"\" ? name : `${base}/${name}`;\n}\n\n// A linked directory is not entered: it may lead back to one of its own parents.\nfunction walk(tree: Tree, base: string): string[] {\n  return names(tree, base).flatMap((name) => {\n    const path = child(base, name);\n    if (tree.skip.has(name) || tree.leftOut.has(path)) return [];\n    const kind = kindOf(tree, path);\n    if (kind === \"file\") return [path];\n    if (kind === \"absent\") tree.broken.add(path);\n    return kind === \"directory\" && !isSymbolicLink(tree, path) ? walk(tree, path) : [];\n  });\n}\n\n/** `lib`, `./lib` and `lib/` are one path, and the root itself is the empty one. */\nfunction normal(path: string): string {\n  const clean = posix.normalize(path).replace(/\\/+$/, \"\");\n  return clean === \".\" ? \"\" : clean;\n}\n\nfunction hasExtension(name: string, extensions: readonly string[]): boolean {\n  return extensions.some((extension) => name.endsWith(`.${extension}`));\n}\n\nfunction lineOf(source: string, index: number): number {\n  return source.slice(0, index).split(\"\\n\").length;\n}\n\n/** A single note, `YYYYMMDD.HHMM.topic.md`. */\nconst DATED_NOTE = /^\\d{8}\\.\\d{4}\\.[a-z0-9-]+\\.md$/;\n\n/** Research of several files, `YYYYMMDD.topic/`. */\nconst DATED_FOLDER = /^\\d{8}\\.[a-z0-9-]+$/;\n\ninterface Entry {\n  path: string;\n  name: string;\n  folder: boolean;\n}\n\nfunction researchFaults(tree: Tree, entries: readonly Entry[]): string[] {\n  return entries.flatMap((entry) => {\n    if (!(entry.folder ? DATED_FOLDER : DATED_NOTE).test(entry.name)) {\n      return [`${entry.path} is not named YYYYMMDD.HHMM.topic.md or YYYYMMDD.topic/`];\n    }\n    return entry.folder && kindOf(tree, `${entry.path}/README.md`) !== \"file\"\n      ? [`${entry.path}/ has no README.md`]\n      : [];\n  });\n}\n\n/** `](target)`, with an optional title. Bare `path.md` inside backticks is not a link. */\nconst LINK = /\\]\\(([^)\\s]+)(?:\\s+\"[^\"]*\")?\\)/g;\n\n/** A scheme, a protocol-relative host or a bare anchor: the target is outside the tree. */\nconst OUTSIDE = /^(?:[a-z][a-z0-9+.-]*:|\\/\\/|#)/i;\n\ninterface Link {\n  from: string;\n  target: string;\n  line: number;\n  /** Where the target leads, relative to the root. Absent when its escapes do not decode. */\n  points: string | undefined;\n}\n\nfunction decoded(target: string): string | undefined {\n  try {\n    return decodeURI(target.split(\"#\")[0] ?? \"\");\n  } catch {\n    return undefined;\n  }\n}\n\nfunction linksIn(tree: Tree, file: string): Link[] {\n  const source = read(tree, file);\n  return [...source.matchAll(LINK)].flatMap((match) => {\n    const target = match[1] ?? \"\";\n    const path = decoded(target);\n    if (OUTSIDE.test(target) || path === \"\") return [];\n    const points =\n      path === undefined ? undefined : relative(tree.root, resolve(tree.root, dirname(file), path));\n    return [{ from: file, target, line: lineOf(source, match.index), points }];\n  });\n}\n\nfunction linkFaults(tree: Tree, links: readonly Link[]): string[] {\n  return links.flatMap((link) => {\n    const at = `${link.from}:${link.line} points at ${link.target}`;\n    if (link.points === undefined) return [`${at}, whose percent-escapes do not decode`];\n    return kindOf(tree, link.points) === \"absent\" ? [`${at}, which is not there`] : [];\n  });\n}\n\n/** A line that opens as a row does: a list item whose first word is a bold decision number. */\nconst ROW_START = /^- \\*\\*D(\\d+)\\*\\*/gm;\n\n/** A whole row: the number, one sentence or more, then the date and an optional source. */\nconst ROW = /^- \\*\\*D\\d+\\*\\* \\S.*[.?!] \\(\\d{4}-\\d{2}-\\d{2}(?:, \\S.*)?\\)$/;\n\n/** A line that names a number in bold as a row does, whatever it opens with. */\nconst ROW_LIKE = /\\*\\*D\\d+\\*\\*/;\n\nconst RETIRED_SECTION = /^## Retired[ \\t]*$([\\s\\S]*?)(?=^## |(?![\\s\\S]))/m;\n\n/** A mistyped number in the retired list would otherwise print a gap per number below it. */\nconst GAPS_SHOWN = 20;\n\nconst CITATION = /\\bD(\\d+)\\b/g;\n\ninterface Row {\n  number: number;\n  line: number;\n  text: string;\n}\n\ninterface Register {\n  path: string;\n  text: string;\n  rows: readonly Row[];\n  live: ReadonlySet<number>;\n  /** Every number the `## Retired` section names, however its lines wrap. */\n  retired: ReadonlySet<number>;\n  hasRetiredSection: boolean;\n}\n\nfunction numbersIn(text: string): number[] {\n  return [...text.matchAll(CITATION)].map((match) => Number(match[1]));\n}\n\nfunction readRegister(tree: Tree, path: string): Register {\n  const text = kindOf(tree, path) === \"file\" ? read(tree, path) : \"\";\n  const rows = [...text.matchAll(ROW_START)].map((match) => ({\n    number: Number(match[1]),\n    line: lineOf(text, match.index),\n    text: text.slice(match.index).split(\"\\n\", 1)[0] ?? \"\",\n  }));\n  const section = RETIRED_SECTION.exec(text);\n  return {\n    path,\n    text,\n    rows,\n    live: new Set(rows.map((row) => row.number)),\n    retired: new Set(numbersIn(section?.[1] ?? \"\")),\n    hasRetiredSection: section !== null,\n  };\n}\n\nfunction rowFaults(register: Register): string[] {\n  const seen = new Set<number>();\n  return register.rows.flatMap((row) => {\n    const at = `${register.path}:${row.line} D${row.number}`;\n    const found = [\n      ...(ROW.test(row.text) ? [] : [`${at} is not \"- **Dn** Sentence. (date, source)\"`]),\n      ...(seen.has(row.number) ? [`${at} is a second row`] : []),\n      ...(register.retired.has(row.number) ? [`${at} is retired`] : []),\n    ];\n    seen.add(row.number);\n    return found;\n  });\n}\n\nfunction gapFaults(register: Register): string[] {\n  const highest = Math.max(0, ...register.live, ...register.retired);\n  const gaps: number[] = [];\n  let more = 0;\n  for (let number = 1; number <= highest; number++) {\n    if (register.live.has(number) || register.retired.has(number)) continue;\n    if (gaps.length < GAPS_SHOWN) gaps.push(number);\n    else more++;\n  }\n  return [\n    ...gaps.map((number) => `${register.path} D${number} is neither a row nor retired`),\n    ...(more === 0\n      ? []\n      : [`${register.path} ${more} more numbers up to D${highest} are neither a row nor retired`]),\n  ];\n}\n\nfunction registerFaults(register: Register): string[] {\n  const rowLike = register.text\n    .split(\"\\n\")\n    .flatMap((text, index) =>\n      ROW_LIKE.test(text) && !text.startsWith(\"- **D\")\n        ? [`${register.path}:${index + 1} names a row but is not one: \"${text.slice(0, 40)}\"`]\n        : [],\n    );\n  return [\n    ...rowFaults(register),\n    ...rowLike,\n    ...(register.hasRetiredSection ? [] : [`${register.path} has no \"## Retired\" section`]),\n    ...gapFaults(register),\n  ];\n}\n\ninterface Citation {\n  where: string;\n  number: number;\n}\n\nfunction citationsIn(tree: Tree, file: string): Citation[] {\n  const source = read(tree, file);\n  return [...source.matchAll(CITATION)].map((match) => ({\n    where: `${file}:${lineOf(source, match.index)}`,\n    number: Number(match[1]),\n  }));\n}\n\n/** A row may cite another row. The retired list and the prose around the rows are not held. */\nfunction citationsInRows(register: Register): Citation[] {\n  return register.rows.flatMap((row) =>\n    numbersIn(row.text.slice(row.text.indexOf(\"**\", 4) + 2)).map((number) => ({\n      where: `${register.path}:${row.line}`,\n      number,\n    })),\n  );\n}\n\nfunction citationFaults(register: Register, citations: readonly Citation[]): string[] {\n  return citations.flatMap(({ where, number }) => {\n    if (register.live.has(number)) return [];\n    return register.retired.has(number)\n      ? [`${where} cites D${number}, which is retired`]\n      : [`${where} cites D${number}, which the register has no row for`];\n  });\n}\n\nfunction isUnder(path: string, base: string): boolean {\n  return base === \"\" || path === base || path.startsWith(`${base}/`);\n}\n\n/** `package-lock.json`, `pnpm-lock.yaml`: generated, and full of hashes that read like numbers. */\nconst LOCKFILE = /[-_.]lock\\.(?:json|jsonc|ya?ml)$/;\n\ninterface Named {\n  path: string;\n  /** How the path came to be named, for the fault. */\n  by: string;\n  want: Kind;\n}\n\nfunction allNamed(by: string, paths: readonly string[], want: Kind): Named[] {\n  return paths.map((path) => ({ path: normal(path), by, want }));\n}\n\nfunction namedOr(option: string, path: string | undefined, fallback: string, want: Kind): Named {\n  return path === undefined\n    ? { path: fallback, by: `the default of \\`${option}\\``, want }\n    : { path: normal(path), by: `named by \\`${option}\\``, want };\n}\n\nfunction namedFault(tree: Tree, named: Named): string[] {\n  const kind = kindOf(tree, named.path);\n  if (kind === named.want) return [];\n  const shown = named.path === \"\" ? \".\" : named.path;\n  return [`${shown}, ${named.by}, is ${kind === \"absent\" ? \"not there\" : `not a ${named.want}`}`];\n}\n\nfunction usable(tree: Tree, named: readonly Named[]): string[] {\n  return named.flatMap((one) => (kindOf(tree, one.path) === one.want ? [one.path] : []));\n}\n\nconst NO_FAULTS: RepoFaults = { scans: [], links: [], register: [], citations: [], research: [] };\n\nexport function checkRepo(config: RepoConfig): RepoFaults {\n  const leftOut = Object.keys(config.leftOut ?? {}).map(normal);\n  const tree: Tree = {\n    root: resolve(config.root),\n    skip: new Set([...DEFAULT_SKIP, ...(config.skip ?? [])]),\n    leftOut: new Set(leftOut),\n    extensions: config.extensions ?? DEFAULT_EXTENSIONS,\n    broken: new Set(),\n  };\n  if (kindOf(tree, \"\") !== \"directory\") {\n    return { ...NO_FAULTS, scans: [`${tree.root}, named by \\`root\\`, is not a directory`] };\n  }\n\n  const docs = namedOr(\"docs\", config.docs, \"docs\", \"directory\");\n  const registerAt = namedOr(\"register\", config.register, child(docs.path, \"decisions.md\"), \"file\");\n  const research = namedOr(\"research\", config.research, \"_research\", \"directory\");\n  const codeRoots = allNamed(\"named by `codeRoots`\", config.codeRoots, \"directory\");\n  const documents =\n    config.documents === undefined\n      ? allNamed(\"a default of `documents`\", DEFAULT_DOCUMENTS, \"file\")\n      : allNamed(\"named by `documents`\", config.documents, \"file\");\n  const linked = allNamed(\"named by `linked`\", config.linked ?? [], \"file\");\n\n  // A repo has no research until its first, so an absent directory is not a fault.\n  const researchKind = kindOf(tree, research.path);\n  const entries = (researchKind === \"directory\" ? names(tree, research.path) : []).flatMap(\n    (name) => {\n      const path = child(research.path, name);\n      const kind = kindOf(tree, path);\n      if (kind === \"absent\") tree.broken.add(path);\n      return kind === \"absent\" ? [] : [{ path, name, folder: kind === \"directory\" }];\n    },\n  );\n\n  // Inside the research only a folder's README is held: an entry is frozen once it is on the\n  // main branch, so its body names paths and numbers as they stood, and some have moved since.\n  const frozen = (file: string): boolean => isUnder(file, research.path);\n\n  const living = [\n    ...usable(tree, documents),\n    ...walk(tree, docs.path).filter((file) => file.endsWith(\".md\") && !frozen(file)),\n    ...usable(tree, linked),\n  ];\n  const linking = new Set([\n    ...living,\n    ...entries.flatMap((entry) => {\n      const readme = `${entry.path}/README.md`;\n      return entry.folder && kindOf(tree, readme) === \"file\" ? [readme] : [];\n    }),\n  ]);\n\n  const scanned = usable(tree, codeRoots).map((base) => ({\n    base,\n    files: walk(tree, base).filter((file) => hasExtension(file, tree.extensions)),\n  }));\n  const atRoot = names(tree, \"\").filter(\n    (name) =>\n      hasExtension(name, tree.extensions) &&\n      !tree.skip.has(name) &&\n      !tree.leftOut.has(name) &&\n      kindOf(tree, name) === \"file\",\n  );\n  const citing = [\n    ...new Set([...living, ...scanned.flatMap((scan) => scan.files), ...atRoot]),\n  ].filter((file) => file !== registerAt.path && !frozen(file) && !LOCKFILE.test(file));\n\n  // With no register to read, every citation would fail: `scans` says so once instead.\n  const held = kindOf(tree, registerAt.path) === \"file\";\n  const register = readRegister(tree, registerAt.path);\n  const wrongKind = researchKind === \"file\" ? namedFault(tree, research) : [];\n  const leftOutFaults = leftOut.flatMap((path) =>\n    kindOf(tree, path) === \"absent\" ? [`${path}, named by \\`leftOut\\`, is not there`] : [],\n  );\n\n  return {\n    scans: [\n      ...[...codeRoots, ...documents, docs, registerAt, ...linked].flatMap((one) =>\n        namedFault(tree, one),\n      ),\n      ...wrongKind,\n      ...leftOutFaults,\n      ...scanned.flatMap((scan) =>\n        scan.files.length === 0\n          ? [`${scan.base === \"\" ? \".\" : scan.base} holds no file to scan for decision numbers`]\n          : [],\n      ),\n      ...(held && register.rows.length === 0 ? [`${registerAt.path} holds no row`] : []),\n      ...[...tree.broken].toSorted().map((path) => `${path} is a symbolic link that leads nowhere`),\n    ],\n    links: linkFaults(\n      tree,\n      [...linking].flatMap((file) => linksIn(tree, file)),\n    ),\n    register: held ? registerFaults(register) : [],\n    citations: held\n      ? citationFaults(register, [\n          ...citing.flatMap((file) => citationsIn(tree, file)),\n          ...citationsInRows(register),\n        ])\n      : [],\n    research: researchFaults(tree, entries),\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;AA8CA,MAAa,SAAS;CAAC;CAAS;CAAS;CAAY;CAAa;AAAU;;AAQ5E,MAAa,SAAS;CACpB,OAAO;CACP,OAAO;CACP,UAAU;CACV,WAAW;CACX,UAAU;AACZ;;AAGA,MAAa,QAAQ;CACnB,OACE;CAEF,OAAO;CACP,UACE;CAEF,WACE;CAGF,UACE;AAEJ;AAEA,MAAa,oBAAuC;CAAC;CAAa;CAAa;AAAY;AAE3F,MAAa,qBAAwC;CACnD;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF;;AAGA,MAAa,eAAkC;CAAC;CAAgB;CAAc;AAAM;AAapF,SAAS,OAAO,MAAY,MAAoB;CAC9C,IAAI;EACF,OAAO,SAAS,KAAK,KAAK,MAAM,IAAI,CAAC,CAAC,CAAC,YAAY,IAAI,cAAc;CACvE,QAAQ;EACN,OAAO;CACT;AACF;AAEA,SAAS,eAAe,MAAY,MAAuB;CACzD,IAAI;EACF,OAAO,UAAU,KAAK,KAAK,MAAM,IAAI,CAAC,CAAC,CAAC,eAAe;CACzD,QAAQ;EACN,OAAO;CACT;AACF;AAGA,SAAS,KAAK,MAAY,MAAsB;CAC9C,OAAO,aAAa,KAAK,KAAK,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,WAAW,QAAQ,IAAI;AAC5E;AAEA,SAAS,MAAM,MAAY,MAAwB;CACjD,IAAI;EACF,OAAO,YAAY,KAAK,KAAK,MAAM,IAAI,CAAC,CAAC,CAAC,SAAS;CACrD,QAAQ;EACN,OAAO,CAAC;CACV;AACF;AAEA,SAAS,MAAM,MAAc,MAAsB;CACjD,OAAO,SAAS,KAAK,OAAO,GAAG,KAAK,GAAG;AACzC;AAGA,SAAS,KAAK,MAAY,MAAwB;CAChD,OAAO,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS,SAAS;EACzC,MAAM,OAAO,MAAM,MAAM,IAAI;EAC7B,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,QAAQ,IAAI,IAAI,GAAG,OAAO,CAAC;EAC3D,MAAM,OAAO,OAAO,MAAM,IAAI;EAC9B,IAAI,SAAS,QAAQ,OAAO,CAAC,IAAI;EACjC,IAAI,SAAS,UAAU,KAAK,OAAO,IAAI,IAAI;EAC3C,OAAO,SAAS,eAAe,CAAC,eAAe,MAAM,IAAI,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC;CACnF,CAAC;AACH;;AAGA,SAAS,OAAO,MAAsB;CACpC,MAAM,QAAQ,MAAM,UAAU,IAAI,CAAC,CAAC,QAAQ,QAAQ,EAAE;CACtD,OAAO,UAAU,MAAM,KAAK;AAC9B;AAEA,SAAS,aAAa,MAAc,YAAwC;CAC1E,OAAO,WAAW,MAAM,cAAc,KAAK,SAAS,IAAI,WAAW,CAAC;AACtE;AAEA,SAAS,OAAO,QAAgB,OAAuB;CACrD,OAAO,OAAO,MAAM,GAAG,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC;AAC5C;;AAGA,MAAM,aAAa;;AAGnB,MAAM,eAAe;AAQrB,SAAS,eAAe,MAAY,SAAqC;CACvE,OAAO,QAAQ,SAAS,UAAU;EAChC,IAAI,EAAE,MAAM,SAAS,eAAe,WAAA,CAAY,KAAK,MAAM,IAAI,GAC7D,OAAO,CAAC,GAAG,MAAM,KAAK,wDAAwD;EAEhF,OAAO,MAAM,UAAU,OAAO,MAAM,GAAG,MAAM,KAAK,WAAW,MAAM,SAC/D,CAAC,GAAG,MAAM,KAAK,mBAAmB,IAClC,CAAC;CACP,CAAC;AACH;;AAGA,MAAM,OAAO;;AAGb,MAAM,UAAU;AAUhB,SAAS,QAAQ,QAAoC;CACnD,IAAI;EACF,OAAO,UAAU,OAAO,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE;CAC7C,QAAQ;EACN;CACF;AACF;AAEA,SAAS,QAAQ,MAAY,MAAsB;CACjD,MAAM,SAAS,KAAK,MAAM,IAAI;CAC9B,OAAO,CAAC,GAAG,OAAO,SAAS,IAAI,CAAC,CAAC,CAAC,SAAS,UAAU;EACnD,MAAM,SAAS,MAAM,MAAM;EAC3B,MAAM,OAAO,QAAQ,MAAM;EAC3B,IAAI,QAAQ,KAAK,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC;EACjD,MAAM,SACJ,SAAS,KAAA,IAAY,KAAA,IAAY,SAAS,KAAK,MAAM,QAAQ,KAAK,MAAM,QAAQ,IAAI,GAAG,IAAI,CAAC;EAC9F,OAAO,CAAC;GAAE,MAAM;GAAM;GAAQ,MAAM,OAAO,QAAQ,MAAM,KAAK;GAAG;EAAO,CAAC;CAC3E,CAAC;AACH;AAEA,SAAS,WAAW,MAAY,OAAkC;CAChE,OAAO,MAAM,SAAS,SAAS;EAC7B,MAAM,KAAK,GAAG,KAAK,KAAK,GAAG,KAAK,KAAK,aAAa,KAAK;EACvD,IAAI,KAAK,WAAW,KAAA,GAAW,OAAO,CAAC,GAAG,GAAG,sCAAsC;EACnF,OAAO,OAAO,MAAM,KAAK,MAAM,MAAM,WAAW,CAAC,GAAG,GAAG,qBAAqB,IAAI,CAAC;CACnF,CAAC;AACH;;AAGA,MAAM,YAAY;;AAGlB,MAAM,MAAM;;AAGZ,MAAM,WAAW;AAEjB,MAAM,kBAAkB;;AAGxB,MAAM,aAAa;AAEnB,MAAM,WAAW;AAkBjB,SAAS,UAAU,MAAwB;CACzC,OAAO,CAAC,GAAG,KAAK,SAAS,QAAQ,CAAC,CAAC,CAAC,KAAK,UAAU,OAAO,MAAM,EAAE,CAAC;AACrE;AAEA,SAAS,aAAa,MAAY,MAAwB;CACxD,MAAM,OAAO,OAAO,MAAM,IAAI,MAAM,SAAS,KAAK,MAAM,IAAI,IAAI;CAChE,MAAM,OAAO,CAAC,GAAG,KAAK,SAAS,SAAS,CAAC,CAAC,CAAC,KAAK,WAAW;EACzD,QAAQ,OAAO,MAAM,EAAE;EACvB,MAAM,OAAO,MAAM,MAAM,KAAK;EAC9B,MAAM,KAAK,MAAM,MAAM,KAAK,CAAC,CAAC,MAAM,MAAM,CAAC,CAAC,CAAC,MAAM;CACrD,EAAE;CACF,MAAM,UAAU,gBAAgB,KAAK,IAAI;CACzC,OAAO;EACL;EACA;EACA;EACA,MAAM,IAAI,IAAI,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC;EAC3C,SAAS,IAAI,IAAI,UAAU,UAAU,MAAM,EAAE,CAAC;EAC9C,mBAAmB,YAAY;CACjC;AACF;AAEA,SAAS,UAAU,UAA8B;CAC/C,MAAM,uBAAO,IAAI,IAAY;CAC7B,OAAO,SAAS,KAAK,SAAS,QAAQ;EACpC,MAAM,KAAK,GAAG,SAAS,KAAK,GAAG,IAAI,KAAK,IAAI,IAAI;EAChD,MAAM,QAAQ;GACZ,GAAI,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,4CAA4C;GACjF,GAAI,KAAK,IAAI,IAAI,MAAM,IAAI,CAAC,GAAG,GAAG,iBAAiB,IAAI,CAAC;GACxD,GAAI,SAAS,QAAQ,IAAI,IAAI,MAAM,IAAI,CAAC,GAAG,GAAG,YAAY,IAAI,CAAC;EACjE;EACA,KAAK,IAAI,IAAI,MAAM;EACnB,OAAO;CACT,CAAC;AACH;AAEA,SAAS,UAAU,UAA8B;CAC/C,MAAM,UAAU,KAAK,IAAI,GAAG,GAAG,SAAS,MAAM,GAAG,SAAS,OAAO;CACjE,MAAM,OAAiB,CAAC;CACxB,IAAI,OAAO;CACX,KAAK,IAAI,SAAS,GAAG,UAAU,SAAS,UAAU;EAChD,IAAI,SAAS,KAAK,IAAI,MAAM,KAAK,SAAS,QAAQ,IAAI,MAAM,GAAG;EAC/D,IAAI,KAAK,SAAS,YAAY,KAAK,KAAK,MAAM;OACzC;CACP;CACA,OAAO,CACL,GAAG,KAAK,KAAK,WAAW,GAAG,SAAS,KAAK,IAAI,OAAO,8BAA8B,GAClF,GAAI,SAAS,IACT,CAAC,IACD,CAAC,GAAG,SAAS,KAAK,GAAG,KAAK,uBAAuB,QAAQ,+BAA+B,CAC9F;AACF;AAEA,SAAS,eAAe,UAA8B;CACpD,MAAM,UAAU,SAAS,KACtB,MAAM,IAAI,CAAC,CACX,SAAS,MAAM,UACd,SAAS,KAAK,IAAI,KAAK,CAAC,KAAK,WAAW,OAAO,IAC3C,CAAC,GAAG,SAAS,KAAK,GAAG,QAAQ,EAAE,gCAAgC,KAAK,MAAM,GAAG,EAAE,EAAE,EAAE,IACnF,CAAC,CACP;CACF,OAAO;EACL,GAAG,UAAU,QAAQ;EACrB,GAAG;EACH,GAAI,SAAS,oBAAoB,CAAC,IAAI,CAAC,GAAG,SAAS,KAAK,6BAA6B;EACrF,GAAG,UAAU,QAAQ;CACvB;AACF;AAOA,SAAS,YAAY,MAAY,MAA0B;CACzD,MAAM,SAAS,KAAK,MAAM,IAAI;CAC9B,OAAO,CAAC,GAAG,OAAO,SAAS,QAAQ,CAAC,CAAC,CAAC,KAAK,WAAW;EACpD,OAAO,GAAG,KAAK,GAAG,OAAO,QAAQ,MAAM,KAAK;EAC5C,QAAQ,OAAO,MAAM,EAAE;CACzB,EAAE;AACJ;;AAGA,SAAS,gBAAgB,UAAgC;CACvD,OAAO,SAAS,KAAK,SAAS,QAC5B,UAAU,IAAI,KAAK,MAAM,IAAI,KAAK,QAAQ,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,YAAY;EACxE,OAAO,GAAG,SAAS,KAAK,GAAG,IAAI;EAC/B;CACF,EAAE,CACJ;AACF;AAEA,SAAS,eAAe,UAAoB,WAA0C;CACpF,OAAO,UAAU,SAAS,EAAE,OAAO,aAAa;EAC9C,IAAI,SAAS,KAAK,IAAI,MAAM,GAAG,OAAO,CAAC;EACvC,OAAO,SAAS,QAAQ,IAAI,MAAM,IAC9B,CAAC,GAAG,MAAM,UAAU,OAAO,mBAAmB,IAC9C,CAAC,GAAG,MAAM,UAAU,OAAO,oCAAoC;CACrE,CAAC;AACH;AAEA,SAAS,QAAQ,MAAc,MAAuB;CACpD,OAAO,SAAS,MAAM,SAAS,QAAQ,KAAK,WAAW,GAAG,KAAK,EAAE;AACnE;;AAGA,MAAM,WAAW;AASjB,SAAS,SAAS,IAAY,OAA0B,MAAqB;CAC3E,OAAO,MAAM,KAAK,UAAU;EAAE,MAAM,OAAO,IAAI;EAAG;EAAI;CAAK,EAAE;AAC/D;AAEA,SAAS,QAAQ,QAAgB,MAA0B,UAAkB,MAAmB;CAC9F,OAAO,SAAS,KAAA,IACZ;EAAE,MAAM;EAAU,IAAI,oBAAoB,OAAO;EAAK;CAAK,IAC3D;EAAE,MAAM,OAAO,IAAI;EAAG,IAAI,cAAc,OAAO;EAAK;CAAK;AAC/D;AAEA,SAAS,WAAW,MAAY,OAAwB;CACtD,MAAM,OAAO,OAAO,MAAM,MAAM,IAAI;CACpC,IAAI,SAAS,MAAM,MAAM,OAAO,CAAC;CAEjC,OAAO,CAAC,GADM,MAAM,SAAS,KAAK,MAAM,MAAM,KAC7B,IAAI,MAAM,GAAG,OAAO,SAAS,WAAW,cAAc,SAAS,MAAM,QAAQ;AAChG;AAEA,SAAS,OAAO,MAAY,OAAmC;CAC7D,OAAO,MAAM,SAAS,QAAS,OAAO,MAAM,IAAI,IAAI,MAAM,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,CAAE;AACvF;AAEA,MAAM,YAAwB;CAAE,OAAO,CAAC;CAAG,OAAO,CAAC;CAAG,UAAU,CAAC;CAAG,WAAW,CAAC;CAAG,UAAU,CAAC;AAAE;AAEhG,SAAgB,UAAU,QAAgC;CACxD,MAAM,UAAU,OAAO,KAAK,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM;CAC5D,MAAM,OAAa;EACjB,MAAM,QAAQ,OAAO,IAAI;EACzB,sBAAM,IAAI,IAAI,CAAC,GAAG,cAAc,GAAI,OAAO,QAAQ,CAAC,CAAE,CAAC;EACvD,SAAS,IAAI,IAAI,OAAO;EACxB,YAAY,OAAO,cAAc;EACjC,wBAAQ,IAAI,IAAI;CAClB;CACA,IAAI,OAAO,MAAM,EAAE,MAAM,aACvB,OAAO;EAAE,GAAG;EAAW,OAAO,CAAC,GAAG,KAAK,KAAK,wCAAwC;CAAE;CAGxF,MAAM,OAAO,QAAQ,QAAQ,OAAO,MAAM,QAAQ,WAAW;CAC7D,MAAM,aAAa,QAAQ,YAAY,OAAO,UAAU,MAAM,KAAK,MAAM,cAAc,GAAG,MAAM;CAChG,MAAM,WAAW,QAAQ,YAAY,OAAO,UAAU,aAAa,WAAW;CAC9E,MAAM,YAAY,SAAS,wBAAwB,OAAO,WAAW,WAAW;CAChF,MAAM,YACJ,OAAO,cAAc,KAAA,IACjB,SAAS,4BAA4B,mBAAmB,MAAM,IAC9D,SAAS,wBAAwB,OAAO,WAAW,MAAM;CAC/D,MAAM,SAAS,SAAS,qBAAqB,OAAO,UAAU,CAAC,GAAG,MAAM;CAGxE,MAAM,eAAe,OAAO,MAAM,SAAS,IAAI;CAC/C,MAAM,WAAW,iBAAiB,cAAc,MAAM,MAAM,SAAS,IAAI,IAAI,CAAC,EAAA,CAAG,SAC9E,SAAS;EACR,MAAM,OAAO,MAAM,SAAS,MAAM,IAAI;EACtC,MAAM,OAAO,OAAO,MAAM,IAAI;EAC9B,IAAI,SAAS,UAAU,KAAK,OAAO,IAAI,IAAI;EAC3C,OAAO,SAAS,WAAW,CAAC,IAAI,CAAC;GAAE;GAAM;GAAM,QAAQ,SAAS;EAAY,CAAC;CAC/E,CACF;CAIA,MAAM,UAAU,SAA0B,QAAQ,MAAM,SAAS,IAAI;CAErE,MAAM,SAAS;EACb,GAAG,OAAO,MAAM,SAAS;EACzB,GAAG,KAAK,MAAM,KAAK,IAAI,CAAC,CAAC,QAAQ,SAAS,KAAK,SAAS,KAAK,KAAK,CAAC,OAAO,IAAI,CAAC;EAC/E,GAAG,OAAO,MAAM,MAAM;CACxB;CACA,MAAM,0BAAU,IAAI,IAAI,CACtB,GAAG,QACH,GAAG,QAAQ,SAAS,UAAU;EAC5B,MAAM,SAAS,GAAG,MAAM,KAAK;EAC7B,OAAO,MAAM,UAAU,OAAO,MAAM,MAAM,MAAM,SAAS,CAAC,MAAM,IAAI,CAAC;CACvE,CAAC,CACH,CAAC;CAED,MAAM,UAAU,OAAO,MAAM,SAAS,CAAC,CAAC,KAAK,UAAU;EACrD;EACA,OAAO,KAAK,MAAM,IAAI,CAAC,CAAC,QAAQ,SAAS,aAAa,MAAM,KAAK,UAAU,CAAC;CAC9E,EAAE;CACF,MAAM,SAAS,MAAM,MAAM,EAAE,CAAC,CAAC,QAC5B,SACC,aAAa,MAAM,KAAK,UAAU,KAClC,CAAC,KAAK,KAAK,IAAI,IAAI,KACnB,CAAC,KAAK,QAAQ,IAAI,IAAI,KACtB,OAAO,MAAM,IAAI,MAAM,MAC3B;CACA,MAAM,SAAS,CACb,mBAAG,IAAI,IAAI;EAAC,GAAG;EAAQ,GAAG,QAAQ,SAAS,SAAS,KAAK,KAAK;EAAG,GAAG;CAAM,CAAC,CAC7E,CAAC,CAAC,QAAQ,SAAS,SAAS,WAAW,QAAQ,CAAC,OAAO,IAAI,KAAK,CAAC,SAAS,KAAK,IAAI,CAAC;CAGpF,MAAM,OAAO,OAAO,MAAM,WAAW,IAAI,MAAM;CAC/C,MAAM,WAAW,aAAa,MAAM,WAAW,IAAI;CACnD,MAAM,YAAY,iBAAiB,SAAS,WAAW,MAAM,QAAQ,IAAI,CAAC;CAC1E,MAAM,gBAAgB,QAAQ,SAAS,SACrC,OAAO,MAAM,IAAI,MAAM,WAAW,CAAC,GAAG,KAAK,qCAAqC,IAAI,CAAC,CACvF;CAEA,OAAO;EACL,OAAO;GACL,GAAG;IAAC,GAAG;IAAW,GAAG;IAAW;IAAM;IAAY,GAAG;GAAM,CAAC,CAAC,SAAS,QACpE,WAAW,MAAM,GAAG,CACtB;GACA,GAAG;GACH,GAAG;GACH,GAAG,QAAQ,SAAS,SAClB,KAAK,MAAM,WAAW,IAClB,CAAC,GAAG,KAAK,SAAS,KAAK,MAAM,KAAK,KAAK,4CAA4C,IACnF,CAAC,CACP;GACA,GAAI,QAAQ,SAAS,KAAK,WAAW,IAAI,CAAC,GAAG,WAAW,KAAK,cAAc,IAAI,CAAC;GAChF,GAAG,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,SAAS,GAAG,KAAK,uCAAuC;EAC9F;EACA,OAAO,WACL,MACA,CAAC,GAAG,OAAO,CAAC,CAAC,SAAS,SAAS,QAAQ,MAAM,IAAI,CAAC,CACpD;EACA,UAAU,OAAO,eAAe,QAAQ,IAAI,CAAC;EAC7C,WAAW,OACP,eAAe,UAAU,CACvB,GAAG,OAAO,SAAS,SAAS,YAAY,MAAM,IAAI,CAAC,GACnD,GAAG,gBAAgB,QAAQ,CAC7B,CAAC,IACD,CAAC;EACL,UAAU,eAAe,MAAM,OAAO;CACxC;AACF"}

package/dist/verify.mjs

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
 import { s as plugin, t as RULE_IDS } from "./config-CD2iCM6L.mjs";
 import { createRequire } from "node:module";
-import { spawnSync } from "node:child_process";
 import { cpSync, existsSync, mkdtempSync, readdirSync, rmSync, symlinkSync, writeFileSync } from "node:fs";
-import { tmpdir } from "node:os";
 import { join, resolve } from "node:path";
+import { spawnSync } from "node:child_process";
+import { tmpdir } from "node:os";
 import { fileURLToPath } from "node:url";
 //#region src/verify.ts
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rdjperron/lint",
-  "version": "0.5.0",
-  "description": "One Oxlint JS plugin, `rdjperron`: 20 rules against low-evidence code, with the config data, the fixture that proves each rule fires, and the command that checks it.",
+  "version": "0.6.0",
+  "description": "One Oxlint JS plugin, `rdjperron`: 20 rules against low-evidence code, with the config data, the fixture that proves each rule fires, the command that checks it, and the repository checks that hold a repo's links, decision register and research names.",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -26,6 +26,10 @@
       "types": "./dist/config.d.mts",
       "default": "./dist/config.mjs"
     },
+    "./repo": {
+      "types": "./dist/repo.d.mts",
+      "default": "./dist/repo.mjs"
+    },
     "./package.json": "./package.json"
   },
   "dependencies": {