@trofimyukdev/repo-truth 0.0.0-stage → 0.1.0

package/dist/measurement-rule.js

@@ -0,0 +1,213 @@
+/**
+ * The measurement rule.
+ *
+ * "A number without a command and a date is not a fact." This check reads the
+ * bodies of the commits in `base..candidate` and the lines the range adds to
+ * changed `.md` files, finds the author's own sentences that assert a
+ * measured quantity, and reports the ones whose BLOCK holds no command or no
+ * date.
+ *
+ * A BLOCK is the whole body of one commit (the message without its subject
+ * line), or one paragraph of a document - the lines between two blank lines,
+ * a fenced block never split. A COMMAND is an inline code span or a fenced
+ * block in the block; a DATE is an ISO date in it.
+ *
+ * A CLAIM is a numeral that carries a unit of measure (`12 ms`, `40%`,
+ * `3 files`, `2x`). Digits alone are not a claim: a version, a SHA, an ISO
+ * date, a section or figure number, a line reference, or a path containing
+ * digits has no unit and is never matched. Lines inside a fenced block, lines
+ * beginning with `>`, and text inside an inline code span are not the
+ * author's own prose and are never read as claims.
+ *
+ * Git is always run with an argument vector, and every failure is a `fail`
+ * record - never a `pass`, never a throw.
+ */
+import { execFile } from "node:child_process";
+const NAME = "RT-02";
+function runGit(cwd, args) {
+    return new Promise((resolve, reject) => {
+        execFile("git", args, { cwd, maxBuffer: 1024 * 1024 * 1024, encoding: "utf8" }, (error, stdout, stderr) => {
+            if (error) {
+                const detail = stderr.trim();
+                reject(new Error(detail.length > 0 ? detail : error.message));
+                return;
+            }
+            resolve(stdout);
+        });
+    });
+}
+/** Units that turn a numeral into a measured quantity. */
+const UNITS = [
+    "ms", "msec", "msecs", "millisecond", "milliseconds", "s", "sec", "secs", "second", "seconds",
+    "min", "mins", "minute", "minutes", "h", "hr", "hrs", "hour", "hours", "days",
+    "b", "kb", "mb", "gb", "tb", "kib", "mib", "gib", "byte", "bytes",
+    "fps", "rps", "loc", "percent",
+    "test", "tests", "case", "cases", "file", "files", "line", "lines", "commit", "commits",
+    "failure", "failures", "failing", "passing", "error", "errors", "warning", "warnings",
+    "check", "checks", "request", "requests", "call", "calls", "time", "times", "run", "runs",
+    "sample", "samples", "iteration", "iterations", "module", "modules", "function", "functions",
+    "violation", "violations", "hit", "hits", "match", "matches", "regression", "regressions",
+];
+/** A numeral not glued to a version, path, reference or identifier, then a unit. */
+const CLAIM = new RegExp("(?<![\\w./#:@$-])(\\d[\\d,]*(?:\\.\\d+)?)(?:\\s?%|x(?!\\w)|×|\\s+(?:" +
+    UNITS.join("|") +
+    ")(?![\\w/-]|\\.\\w))", "i");
+const ISO_DATE = /(?<![\d-])\d{4}-\d{2}-\d{2}(?![\d-])/;
+const CODE_SPAN = /(`+)[^`\n]+?\1/;
+const CODE_SPAN_ALL = /(`+)[^`\n]+?\1/g;
+const FENCE = /^ {0,3}(`{3,}|~{3,})/;
+function annotate(source) {
+    const lines = [];
+    let marker;
+    source.split("\n").forEach((raw, index) => {
+        const text = raw.replace(/\r$/, "");
+        const fence = FENCE.exec(text);
+        let fenced = marker !== undefined;
+        if (marker === undefined) {
+            if (fence) {
+                marker = fence[1];
+                fenced = true;
+            }
+        }
+        else if (fence?.[1] !== undefined && fence[1][0] === marker[0] && fence[1].length >= marker.length && text.trim() === fence[1]) {
+            marker = undefined;
+        }
+        lines.push({ number: index + 1, text, fenced });
+    });
+    return lines;
+}
+/** Split into blocks at blank lines outside fences. */
+function paragraphs(lines) {
+    const blocks = [];
+    let current = [];
+    for (const line of lines) {
+        if (!line.fenced && line.text.trim() === "") {
+            if (current.length > 0)
+                blocks.push(current);
+            current = [];
+        }
+        else {
+            current.push(line);
+        }
+    }
+    if (current.length > 0)
+        blocks.push(current);
+    return blocks;
+}
+function claimIn(line) {
+    if (line.fenced || /^\s*>/.test(line.text))
+        return undefined;
+    const prose = line.text
+        .replace(CODE_SPAN_ALL, " ")
+        .replace(/\]\([^)]*\)/g, "]")
+        .replace(/https?:\/\/\S+/g, " ");
+    return CLAIM.exec(prose)?.[0].trim();
+}
+function missingHalf(block) {
+    const text = block.map((line) => line.text).join("\n");
+    const hasCommand = block.some((line) => line.fenced) || CODE_SPAN.test(text);
+    const hasDate = ISO_DATE.test(text);
+    if (hasCommand && hasDate)
+        return undefined;
+    if (!hasCommand && !hasDate)
+        return "command and date";
+    return hasCommand ? "date" : "command";
+}
+/** Violations in one block; `wanted` limits which lines count as the range's own. */
+function violationsIn(block, wanted, where) {
+    const claims = block
+        .filter((line) => (wanted ? wanted(line) : true))
+        .flatMap((line) => {
+        const figure = claimIn(line);
+        return figure === undefined ? [] : [{ line, figure }];
+    });
+    if (claims.length === 0)
+        return [];
+    const missing = missingHalf(block);
+    if (missing === undefined)
+        return [];
+    return claims.map(({ line, figure }) => `${where(line)}: figure "${figure}" is stated without its ${missing}`);
+}
+async function commitEvidence(cwd, base, candidate) {
+    const listing = await runGit(cwd, ["rev-list", "--reverse", `${base}..${candidate}`, "--"]);
+    const evidence = [];
+    for (const sha of listing.split("\n").filter((l) => l.length > 0)) {
+        const message = (await runGit(cwd, ["show", "-s", "--format=%B", sha])).replace(/\n+$/, "");
+        // The body is everything after the subject line; numbering is body-relative.
+        const lines = annotate(message.split("\n").slice(1).join("\n"));
+        evidence.push(...violationsIn(lines, undefined, (line) => `${sha.slice(0, 7)} body line ${line.number}`));
+    }
+    return evidence;
+}
+function addedLines(diff) {
+    const added = new Set();
+    for (const match of diff.matchAll(/^@@ -\d+(?:,\d+)? \+(\d+)(?:,(\d+))? @@/gm)) {
+        const start = Number(match[1]);
+        const count = match[2] === undefined ? 1 : Number(match[2]);
+        for (let i = 0; i < count; i++)
+            added.add(start + i);
+    }
+    return added;
+}
+async function documentEvidence(cwd, base, candidate) {
+    const span = `${base}...${candidate}`;
+    const names = await runGit(cwd, ["diff", "--name-only", "-z", "--diff-filter=d", span, "--"]);
+    const evidence = [];
+    for (const path of names.split("\0").filter((n) => n.endsWith(".md"))) {
+        const diff = await runGit(cwd, ["diff", "--unified=0", "--no-color", "--no-ext-diff", span, "--", path]);
+        const added = addedLines(diff);
+        if (added.size === 0)
+            continue;
+        const content = await runGit(cwd, ["show", `${candidate}:${path}`]);
+        for (const block of paragraphs(annotate(content))) {
+            if (!block.some((line) => added.has(line.number)))
+                continue;
+            evidence.push(...violationsIn(block, (line) => added.has(line.number), (line) => `${path}:${line.number}`));
+        }
+    }
+    return evidence;
+}
+async function resolvesToCommit(cwd, revision) {
+    if (revision.length === 0 || revision.startsWith("-"))
+        return false;
+    try {
+        await runGit(cwd, ["rev-parse", "--verify", "--quiet", `${revision}^{commit}`]);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Check the commit bodies in `base..candidate` and the lines the range adds
+ * to `.md` files. Fails closed on any git failure.
+ */
+export async function checkMeasurementRule(options) {
+    const { cwd, base, candidate } = options;
+    try {
+        for (const revision of [base, candidate]) {
+            if (!(await resolvesToCommit(cwd, revision))) {
+                return { name: NAME, status: "fail", evidence: [`revision ${revision} names no commit`] };
+            }
+        }
+        const evidence = [
+            ...(await commitEvidence(cwd, base, candidate)),
+            ...(await documentEvidence(cwd, base, candidate)),
+        ];
+        if (evidence.length > 0)
+            return { name: NAME, status: "fail", evidence };
+        return {
+            name: NAME,
+            status: "pass",
+            evidence: [`no unmeasured figure in the commit bodies or added documentation lines of ${base}..${candidate}`],
+        };
+    }
+    catch (error) {
+        return {
+            name: NAME,
+            status: "fail",
+            evidence: [`git failed while reading ${base}..${candidate}: ${error.message}`],
+        };
+    }
+}
+//# sourceMappingURL=measurement-rule.js.map

package/dist/measurement-rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"measurement-rule.js","sourceRoot":"","sources":["../src/measurement-rule.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAI9C,MAAM,IAAI,GAAG,OAAO,CAAC;AAYrB,SAAS,MAAM,CAAC,GAAW,EAAE,IAAuB;IAClD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,QAAQ,CACN,KAAK,EACL,IAAgB,EAChB,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,EACxD,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;YACxB,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC7B,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC9D,OAAO;YACT,CAAC;YACD,OAAO,CAAC,MAAM,CAAC,CAAC;QAClB,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,0DAA0D;AAC1D,MAAM,KAAK,GAAG;IACZ,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS;IAC7F,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAC7E,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO;IACjE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS;IAC9B,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS;IACvF,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU;IACrF,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM;IACzF,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW;IAC5F,WAAW,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa;CAC1F,CAAC;AAEF,oFAAoF;AACpF,MAAM,KAAK,GAAG,IAAI,MAAM,CACtB,sEAAsE;IACpE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;IACf,sBAAsB,EACxB,GAAG,CACJ,CAAC;AAEF,MAAM,QAAQ,GAAG,sCAAsC,CAAC;AACxD,MAAM,SAAS,GAAG,gBAAgB,CAAC;AACnC,MAAM,aAAa,GAAG,iBAAiB,CAAC;AACxC,MAAM,KAAK,GAAG,sBAAsB,CAAC;AAUrC,SAAS,QAAQ,CAAC,MAAc;IAC9B,MAAM,KAAK,GAAW,EAAE,CAAC;IACzB,IAAI,MAA0B,CAAC;IAC/B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;QACxC,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACpC,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,MAAM,GAAG,MAAM,KAAK,SAAS,CAAC;QAClC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBAClB,MAAM,GAAG,IAAI,CAAC;YAChB,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACjI,MAAM,GAAG,SAAS,CAAC;QACrB,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC;AAED,uDAAuD;AACvD,SAAS,UAAU,CAAC,KAAsB;IACxC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,OAAO,GAAW,EAAE,CAAC;IACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAC5C,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;gBAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC7C,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC7C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,OAAO,CAAC,IAAU;IACzB,IAAI,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,SAAS,CAAC;IAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI;SACpB,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;SAC3B,OAAO,CAAC,cAAc,EAAE,GAAG,CAAC;SAC5B,OAAO,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;IACnC,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AACvC,CAAC;AAED,SAAS,WAAW,CAAC,KAAsB;IACzC,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvD,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7E,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,UAAU,IAAI,OAAO;QAAE,OAAO,SAAS,CAAC;IAC5C,IAAI,CAAC,UAAU,IAAI,CAAC,OAAO;QAAE,OAAO,kBAAkB,CAAC;IACvD,OAAO,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACzC,CAAC;AAED,qFAAqF;AACrF,SAAS,YAAY,CACnB,KAAsB,EACtB,MAA6C,EAC7C,KAA6B;IAE7B,MAAM,MAAM,GAAG,KAAK;SACjB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SAChD,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAChB,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7B,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IACL,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACnC,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IACnC,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IACrC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,MAAM,2BAA2B,OAAO,EAAE,CAAC,CAAC;AACjH,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,GAAW,EAAE,IAAY,EAAE,SAAiB;IACxE,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,GAAG,IAAI,KAAK,SAAS,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IAC5F,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;QAClE,MAAM,OAAO,GAAG,CAAC,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC5F,6EAA6E;QAC7E,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAChE,QAAQ,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,cAAc,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5G,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,2CAA2C,CAAC,EAAE,CAAC;QAC/E,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE;YAAE,KAAK,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,GAAW,EAAE,IAAY,EAAE,SAAiB;IAC1E,MAAM,IAAI,GAAG,GAAG,IAAI,MAAM,SAAS,EAAE,CAAC;IACtC,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAC9F,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACtE,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QACzG,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC;YAAE,SAAS;QAC/B,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;QACpE,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YAClD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAAE,SAAS;YAC5D,QAAQ,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC9G,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,GAAW,EAAE,QAAgB;IAC3D,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IACpE,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,QAAQ,WAAW,CAAC,CAAC,CAAC;QAChF,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,OAA+B;IACxE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IACzC,IAAI,CAAC;QACH,KAAK,MAAM,QAAQ,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,CAAC,MAAM,gBAAgB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC;gBAC7C,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,YAAY,QAAQ,kBAAkB,CAAC,EAAE,CAAC;YAC5F,CAAC;QACH,CAAC;QACD,MAAM,QAAQ,GAAG;YACf,GAAG,CAAC,MAAM,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;YAC/C,GAAG,CAAC,MAAM,gBAAgB,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;SAClD,CAAC;QACF,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QACzE,OAAO;YACL,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,CAAC,6EAA6E,IAAI,KAAK,SAAS,EAAE,CAAC;SAC9G,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO;YACL,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,CAAC,4BAA4B,IAAI,KAAK,SAAS,KAAM,KAAe,CAAC,OAAO,EAAE,CAAC;SAC1F,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/portable-paths.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Portable paths.
+ *
+ * Linux accepts almost any byte in a file name, so a repository developed
+ * there can take in `Readme.md` beside `README.md`, a file called `aux.ts` or
+ * a name that ends in a dot, and every check on Linux stays green. A clone on
+ * macOS or Windows then silently keeps one of two files, or cannot check the
+ * tree out at all. This check reads the names a range introduces and reports
+ * the ones another operating system cannot hold.
+ *
+ * A NAME is the path of a tree entry or of a directory above one. The range
+ * INTRODUCES a name when the candidate's tree holds it and the tree of the
+ * merge base does not. Names the base already held are never reported by the
+ * last three rules, and a case collision is reported only when at least one
+ * of its spellings is introduced: a check that fails on names nobody in the
+ * range wrote is a check that gets switched off.
+ *
+ * Both trees are read through git with an argument vector, never from the
+ * working tree.
+ */
+import type { CheckRecord } from "./index.js";
+/** Where to look, and which two revisions bound the range. */
+export interface PortablePathsOptions {
+    /** The git repository to run in. */
+    readonly cwd: string;
+    /** The revision the range starts after. */
+    readonly base: string;
+    /** The revision the range ends at. */
+    readonly candidate: string;
+}
+/**
+ * Check the names `base..candidate` introduces for the ones another operating
+ * system cannot hold. Fails closed: a revision that names no commit, or any
+ * git invocation that fails, is a `fail` record naming the cause - never a
+ * `pass`, and never a thrown error.
+ */
+export declare function checkPortablePaths(options: PortablePathsOptions): Promise<CheckRecord>;

package/dist/portable-paths.js

@@ -0,0 +1,215 @@
+/**
+ * Portable paths.
+ *
+ * Linux accepts almost any byte in a file name, so a repository developed
+ * there can take in `Readme.md` beside `README.md`, a file called `aux.ts` or
+ * a name that ends in a dot, and every check on Linux stays green. A clone on
+ * macOS or Windows then silently keeps one of two files, or cannot check the
+ * tree out at all. This check reads the names a range introduces and reports
+ * the ones another operating system cannot hold.
+ *
+ * A NAME is the path of a tree entry or of a directory above one. The range
+ * INTRODUCES a name when the candidate's tree holds it and the tree of the
+ * merge base does not. Names the base already held are never reported by the
+ * last three rules, and a case collision is reported only when at least one
+ * of its spellings is introduced: a check that fails on names nobody in the
+ * range wrote is a check that gets switched off.
+ *
+ * Both trees are read through git with an argument vector, never from the
+ * working tree.
+ */
+import { execFile } from "node:child_process";
+const NAME = "RT-10";
+function runGit(cwd, args) {
+    return new Promise((resolve, reject) => {
+        execFile("git", args, { cwd, maxBuffer: 1024 * 1024 * 1024, encoding: "buffer" }, (error, stdout, stderr) => {
+            if (error) {
+                const detail = stderr.toString("utf8").trim();
+                reject(new Error(detail.length > 0 ? detail : error.message));
+                return;
+            }
+            resolve(stdout);
+        });
+    });
+}
+/**
+ * Escape every character outside printable ASCII so a name can be printed to
+ * a terminal without replaying whatever control sequence it smuggled in.
+ */
+function escapeText(text) {
+    let escaped = "";
+    for (const char of text) {
+        const codePoint = char.codePointAt(0) ?? 0;
+        if (codePoint >= 0x20 && codePoint <= 0x7e) {
+            escaped += char;
+        }
+        else {
+            escaped += `\\u{${codePoint.toString(16).padStart(4, "0")}}`;
+        }
+    }
+    return escaped;
+}
+function quote(text) {
+    return `"${escapeText(text)}"`;
+}
+/**
+ * Decode a path as UTF-8; a path that is not valid UTF-8 is decoded byte for
+ * byte instead, so that two different byte strings never become one name.
+ */
+function decodePath(bytes) {
+    try {
+        return new TextDecoder("utf-8", { fatal: true }).decode(bytes);
+    }
+    catch {
+        return bytes.toString("latin1");
+    }
+}
+/** Every revision is resolved to a commit before it is used as anything else. */
+async function resolveCommit(cwd, revision) {
+    // A revision that begins with a dash would be read as an option.
+    if (revision.length === 0 || revision.startsWith("-")) {
+        throw new Error(`revision ${quote(revision)} names no commit`);
+    }
+    try {
+        const out = await runGit(cwd, ["rev-parse", "--verify", "--quiet", `${revision}^{commit}`]);
+        const hash = out.toString("utf8").trim();
+        if (hash.length === 0) {
+            throw new Error("empty answer");
+        }
+        return hash;
+    }
+    catch (error) {
+        throw new Error(`revision ${quote(revision)} names no commit: ${error.message}`);
+    }
+}
+async function mergeBase(cwd, base, candidate) {
+    const label = `${base.slice(0, 12)} and ${candidate.slice(0, 12)}`;
+    let out;
+    try {
+        out = await runGit(cwd, ["merge-base", base, candidate]);
+    }
+    catch (error) {
+        throw new Error(`no merge base of ${label}: ${error.message}`);
+    }
+    const hash = out.toString("utf8").trim();
+    if (hash.length === 0) {
+        throw new Error(`no merge base of ${label}`);
+    }
+    return hash;
+}
+/** Every name of a commit's tree: each path and each directory above one. */
+async function readNames(cwd, commit) {
+    let out;
+    try {
+        out = await runGit(cwd, ["ls-tree", "-r", "-z", "--name-only", commit, "--"]);
+    }
+    catch (error) {
+        throw new Error(`could not read the tree of ${commit.slice(0, 12)}: ${error.message}`);
+    }
+    const names = new Set();
+    let start = 0;
+    for (let i = 0; i < out.length; i += 1) {
+        if (out[i] !== 0) {
+            continue;
+        }
+        const path = decodePath(out.subarray(start, i));
+        start = i + 1;
+        if (path.length === 0) {
+            continue;
+        }
+        names.add(path);
+        for (let slash = path.indexOf("/"); slash !== -1; slash = path.indexOf("/", slash + 1)) {
+            names.add(path.slice(0, slash));
+        }
+    }
+    return names;
+}
+const RESERVED = /^(?:con|prn|aux|nul|com[1-9]|lpt[1-9])$/i;
+// eslint-disable-next-line no-control-regex
+const FORBIDDEN_CHARACTER = /[<>:"\\|?*\u0000-\u001f\u007f-\u009f]/;
+function lastComponent(name) {
+    return name.slice(name.lastIndexOf("/") + 1);
+}
+/** The rules that judge one introduced name by itself. */
+function judge(name) {
+    const component = lastComponent(name);
+    const findings = [];
+    if (RESERVED.test(component.split(".")[0] ?? "")) {
+        findings.push(`${quote(name)} is a reserved device name on Windows [reserved]`);
+    }
+    if (component.endsWith(".") || component.endsWith(" ")) {
+        findings.push(`${quote(name)} ends in a dot or a space, which Windows drops [trailing]`);
+    }
+    if (FORBIDDEN_CHARACTER.test(component)) {
+        findings.push(`${quote(name)} holds a character Windows forbids in a name [character]`);
+    }
+    return findings;
+}
+/** Names that differ only in letter case, at least one of them introduced. */
+function caseFindings(candidateNames, introduced) {
+    const groups = new Map();
+    for (const name of candidateNames) {
+        const key = name.toLowerCase();
+        const group = groups.get(key);
+        if (group === undefined) {
+            groups.set(key, [name]);
+        }
+        else {
+            group.push(name);
+        }
+    }
+    const findings = [];
+    for (const group of groups.values()) {
+        if (group.length < 2 || !group.some((name) => introduced.has(name))) {
+            continue;
+        }
+        group.sort();
+        findings.push(`${group.map(quote).join(" and ")} differ only in letter case [case]`);
+    }
+    return findings;
+}
+/**
+ * Check the names `base..candidate` introduces for the ones another operating
+ * system cannot hold. Fails closed: a revision that names no commit, or any
+ * git invocation that fails, is a `fail` record naming the cause - never a
+ * `pass`, and never a thrown error.
+ */
+export async function checkPortablePaths(options) {
+    try {
+        const { cwd, base, candidate } = options;
+        const baseCommit = await resolveCommit(cwd, base);
+        const candidateCommit = await resolveCommit(cwd, candidate);
+        const ancestor = await mergeBase(cwd, baseCommit, candidateCommit);
+        const [heldByBase, candidateNames] = await Promise.all([
+            readNames(cwd, ancestor),
+            readNames(cwd, candidateCommit),
+        ]);
+        const introduced = new Set();
+        for (const name of candidateNames) {
+            if (!heldByBase.has(name)) {
+                introduced.add(name);
+            }
+        }
+        const evidence = caseFindings(candidateNames, introduced);
+        for (const name of [...introduced].sort()) {
+            evidence.push(...judge(name));
+        }
+        if (evidence.length > 0) {
+            return { name: NAME, status: "fail", evidence };
+        }
+        return {
+            name: NAME,
+            status: "pass",
+            evidence: [
+                introduced.size === 0
+                    ? `no name introduced in ${quote(base)}..${quote(candidate)}`
+                    : `${introduced.size} name(s) introduced in ${quote(base)}..${quote(candidate)}, all portable`,
+            ],
+        };
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        return { name: NAME, status: "fail", evidence: [escapeText(message)] };
+    }
+}
+//# sourceMappingURL=portable-paths.js.map

package/dist/portable-paths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"portable-paths.js","sourceRoot":"","sources":["../src/portable-paths.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAI9C,MAAM,IAAI,GAAG,OAAO,CAAC;AAYrB,SAAS,MAAM,CAAC,GAAW,EAAE,IAAuB;IAClD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,QAAQ,CACN,KAAK,EACL,IAAgB,EAChB,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAC1D,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;YACxB,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;gBAC9C,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC9D,OAAO;YACT,CAAC;YACD,OAAO,CAAC,MAAM,CAAC,CAAC;QAClB,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU,CAAC,IAAY;IAC9B,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,SAAS,IAAI,IAAI,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YAC3C,OAAO,IAAI,IAAI,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,OAAO,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC;QAC/D,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,KAAK,CAAC,IAAY;IACzB,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU,CAAC,KAAa;IAC/B,IAAI,CAAC;QACH,OAAO,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACjE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;AACH,CAAC;AAED,iFAAiF;AACjF,KAAK,UAAU,aAAa,CAAC,GAAW,EAAE,QAAgB;IACxD,iEAAiE;IACjE,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,KAAK,CAAC,YAAY,KAAK,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,QAAQ,WAAW,CAAC,CAAC,CAAC;QAC5F,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;QACzC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,YAAY,KAAK,CAAC,QAAQ,CAAC,qBAAsB,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;AACH,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,GAAW,EAAE,IAAY,EAAE,SAAiB;IACnE,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;IACnE,IAAI,GAAW,CAAC;IAChB,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,YAAY,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;IAC3D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,oBAAoB,KAAK,KAAM,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IACD,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;IACzC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,oBAAoB,KAAK,EAAE,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,6EAA6E;AAC7E,KAAK,UAAU,SAAS,CAAC,GAAW,EAAE,MAAc;IAClD,IAAI,GAAW,CAAC;IAChB,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAChF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,8BAA8B,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,KAAM,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACvC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACjB,SAAS;QACX,CAAC;QACD,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QAChD,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC;QACd,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,SAAS;QACX,CAAC;QACD,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChB,KAAK,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;YACvF,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,QAAQ,GAAG,0CAA0C,CAAC;AAC5D,4CAA4C;AAC5C,MAAM,mBAAmB,GAAG,uCAAuC,CAAC;AAEpE,SAAS,aAAa,CAAC,IAAY;IACjC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,0DAA0D;AAC1D,SAAS,KAAK,CAAC,IAAY;IACzB,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IACtC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QACjD,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;IAClF,CAAC;IACD,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACvD,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;IAC3F,CAAC;IACD,IAAI,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QACxC,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAC;IAC1F,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,8EAA8E;AAC9E,SAAS,YAAY,CAAC,cAAmC,EAAE,UAA+B;IACxF,MAAM,MAAM,GAAG,IAAI,GAAG,EAAoB,CAAC;IAC3C,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE,CAAC;QAClC,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IACD,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;QACpC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACpE,SAAS;QACX,CAAC;QACD,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;IACvF,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,OAA6B;IACpE,IAAI,CAAC;QACH,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;QACzC,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAClD,MAAM,eAAe,GAAG,MAAM,aAAa,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC5D,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC;QAEnE,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACrD,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC;YACxB,SAAS,CAAC,GAAG,EAAE,eAAe,CAAC;SAChC,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;QACrC,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE,CAAC;YAClC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1B,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;QAED,MAAM,QAAQ,GAAG,YAAY,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QAC1D,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;YAC1C,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAChC,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QAClD,CAAC;QACD,OAAO;YACL,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE;gBACR,UAAU,CAAC,IAAI,KAAK,CAAC;oBACnB,CAAC,CAAC,yBAAyB,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,SAAS,CAAC,EAAE;oBAC7D,CAAC,CAAC,GAAG,UAAU,CAAC,IAAI,0BAA0B,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,SAAS,CAAC,gBAAgB;aACjG;SACF,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;IACzE,CAAC;AACH,CAAC"}

package/dist/registry.d.ts

@@ -0,0 +1,43 @@
+/**
+ * The registry of checks `repo-truth check` runs.
+ *
+ * This array is data the command reads when it runs; the command holds no list
+ * of its own. Adding a check means adding an entry here and nothing else.
+ */
+import type { CheckRecord } from "./index.js";
+import type { OptionKind, OptionKinds } from "./config.js";
+/** The repository a check runs in. */
+export interface Repository {
+    /** The working directory git runs in. */
+    readonly cwd: string;
+    /** The path --config named, as it was given; absent when the settings were read from repo-truth.json at the base. */
+    readonly config?: string;
+}
+/** The range a check answers for, as resolved commit ids. */
+export interface ResolvedRange {
+    /** The commit the range starts after (exclusive). */
+    readonly base: string;
+    /** The commit the range ends at (inclusive). */
+    readonly candidate: string;
+}
+/** The options a check takes, from the name of each to its kind. */
+export type EntryOptions = {
+    readonly [option: string]: OptionKind;
+};
+export interface RegistryEntry {
+    readonly name: string;
+    /** The options the check takes; absent on an entry written by hand that takes none. */
+    readonly options?: EntryOptions;
+    readonly run: (repo: Repository, range: ResolvedRange, options?: {
+        readonly [option: string]: unknown;
+    }) => CheckRecord | Promise<CheckRecord>;
+}
+/** The options of every entry given, by entry name, in the form parseConfig reads. */
+export declare function optionKindsOf(entries: readonly RegistryEntry[]): OptionKinds;
+/**
+ * The entries for the check modules directly in one directory, in the order of
+ * their file names. A module that cannot be registered becomes an entry whose
+ * record fails and names the file and the cause. A missing directory yields none.
+ */
+export declare function loadCheckDirectory(directory: URL, extension: string): Promise<RegistryEntry[]>;
+export declare const REGISTRY: RegistryEntry[];