@trofimyukdev/repo-truth 0.0.0-stage → 0.1.0

package/dist/lockfile-drift.js

@@ -0,0 +1,206 @@
+/**
+ * Lockfile drift.
+ *
+ * The manifest (the root `package.json`) and the lockfile are two statements of
+ * one install. A range that changes a dependency field of the manifest without
+ * the lockfile leaves a pin that no longer matches what was asked for (a stale
+ * pin); a range that changes the lockfile without a dependency field of the
+ * manifest moves a version with no request behind it (an unrequested change).
+ * The two are reported in different words because the fix and the alarm differ.
+ *
+ * Lockfiles are never parsed: they are compared by git object id at the two
+ * revisions. Only the manifest is parsed, and only to compare its dependency
+ * fields, so a script or description edit is not drift. A repository with no
+ * manifest or no recognised lockfile gets a `skip` naming what was looked for.
+ */
+import { execFile } from "node:child_process";
+const NAME = "RT-06";
+const MANIFEST = "package.json";
+/** The manifest fields that say what to install. */
+export const DEPENDENCY_FIELDS = [
+    "dependencies",
+    "devDependencies",
+    "peerDependencies",
+    "optionalDependencies",
+    "bundledDependencies",
+    "bundleDependencies",
+];
+/** The lockfiles recognised at the repository root. */
+export const LOCKFILES = [
+    "package-lock.json",
+    "npm-shrinkwrap.json",
+    "yarn.lock",
+    "pnpm-lock.yaml",
+    "bun.lock",
+];
+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 everything outside printable ASCII so a name cannot replay a control sequence. */
+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)}"`;
+}
+async function resolveCommit(cwd, revision) {
+    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}`);
+    }
+}
+/** The blob id of a root file at a commit, or undefined when the commit has no such file. */
+async function blobId(root, commit, path) {
+    const out = (await runGit(root, ["ls-tree", "-z", commit, "--", path])).toString("utf8");
+    const entry = out.split("\0")[0] ?? "";
+    const match = /^(\d+) (\w+) ([0-9a-f]+)\t(.*)$/s.exec(entry);
+    if (match === null || match[4] !== path || match[2] !== "blob") {
+        return undefined;
+    }
+    return match[3];
+}
+function canonical(value) {
+    if (Array.isArray(value)) {
+        return value.map(canonical).sort((x, y) => JSON.stringify(x).localeCompare(JSON.stringify(y)));
+    }
+    if (value !== null && typeof value === "object") {
+        const out = {};
+        for (const key of Object.keys(value).sort()) {
+            out[key] = canonical(value[key]);
+        }
+        return out;
+    }
+    return value;
+}
+/** The dependency fields of a manifest blob, in a form that compares by value. */
+async function dependencyView(root, id, label) {
+    const text = (await runGit(root, ["cat-file", "blob", id])).toString("utf8");
+    let parsed;
+    try {
+        parsed = JSON.parse(text);
+    }
+    catch (error) {
+        throw new Error(`${MANIFEST} at ${label} is not valid JSON: ${error.message}`);
+    }
+    if (parsed === null || typeof parsed !== "object" || Array.isArray(parsed)) {
+        throw new Error(`${MANIFEST} at ${label} is not a JSON object`);
+    }
+    const fields = {};
+    for (const field of DEPENDENCY_FIELDS) {
+        if (Object.prototype.hasOwnProperty.call(parsed, field)) {
+            fields[field] = canonical(parsed[field]);
+        }
+    }
+    return JSON.stringify(fields);
+}
+/**
+ * Compare the manifest's dependency fields and the root lockfiles between the
+ * merge base of `base` and `candidate` and `candidate`. 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 checkLockfileDrift(options) {
+    try {
+        const { cwd, base, candidate } = options;
+        const baseCommit = await resolveCommit(cwd, base);
+        const candidateCommit = await resolveCommit(cwd, candidate);
+        const root = (await runGit(cwd, ["rev-parse", "--show-toplevel"])).toString("utf8").replace(/\r?\n$/, "");
+        let ancestor;
+        try {
+            ancestor = (await runGit(root, ["merge-base", baseCommit, candidateCommit])).toString("utf8").trim();
+        }
+        catch (error) {
+            throw new Error(`no merge base of ${quote(base)} and ${quote(candidate)}: ${error.message}`);
+        }
+        if (ancestor.length === 0) {
+            throw new Error(`no merge base of ${quote(base)} and ${quote(candidate)}`);
+        }
+        const range = `${quote(base)}..${quote(candidate)}`;
+        const looked = `looked for ${MANIFEST} and one of ${LOCKFILES.join(", ")} at the repository root`;
+        const manifestBefore = await blobId(root, ancestor, MANIFEST);
+        const manifestAfter = await blobId(root, candidateCommit, MANIFEST);
+        if (manifestBefore === undefined && manifestAfter === undefined) {
+            return { name: NAME, status: "skip", evidence: [`no ${MANIFEST} found in ${range}; ${looked}`] };
+        }
+        const lockfiles = [];
+        for (const name of LOCKFILES) {
+            const before = await blobId(root, ancestor, name);
+            const after = await blobId(root, candidateCommit, name);
+            if (before !== undefined || after !== undefined) {
+                lockfiles.push({ name, changed: before !== after });
+            }
+        }
+        if (lockfiles.length === 0) {
+            return { name: NAME, status: "skip", evidence: [`no recognised lockfile found in ${range}; ${looked}`] };
+        }
+        let dependenciesChanged = false;
+        if (manifestBefore !== manifestAfter) {
+            const viewBefore = manifestBefore === undefined ? "" : await dependencyView(root, manifestBefore, quote(base));
+            const viewAfter = manifestAfter === undefined ? "" : await dependencyView(root, manifestAfter, quote(candidate));
+            dependenciesChanged = viewBefore !== viewAfter;
+        }
+        const changedLocks = lockfiles.filter((lock) => lock.changed).map((lock) => lock.name);
+        const lockNames = lockfiles.map((lock) => lock.name).join(", ");
+        if (dependenciesChanged && changedLocks.length === 0) {
+            return {
+                name: NAME,
+                status: "fail",
+                evidence: [
+                    `stale pin: a dependency field of ${MANIFEST} changed in ${range} but ${lockNames} did not, so the lockfile no longer records what the manifest asks for`,
+                ],
+            };
+        }
+        if (!dependenciesChanged && changedLocks.length > 0) {
+            return {
+                name: NAME,
+                status: "fail",
+                evidence: [
+                    `unrequested change: ${changedLocks.join(", ")} changed in ${range} but no dependency field of ${MANIFEST} did, so a resolved version moved with no request behind it`,
+                ],
+            };
+        }
+        return {
+            name: NAME,
+            status: "pass",
+            evidence: [
+                dependenciesChanged
+                    ? `${MANIFEST} dependency fields and ${changedLocks.join(", ")} changed together`
+                    : `neither the dependency fields of ${MANIFEST} nor ${lockNames} changed`,
+            ],
+        };
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        return { name: NAME, status: "fail", evidence: [escapeText(message)] };
+    }
+}
+//# sourceMappingURL=lockfile-drift.js.map

package/dist/lockfile-drift.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lockfile-drift.js","sourceRoot":"","sources":["../src/lockfile-drift.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAI9C,MAAM,IAAI,GAAG,OAAO,CAAC;AAYrB,MAAM,QAAQ,GAAG,cAAc,CAAC;AAEhC,oDAAoD;AACpD,MAAM,CAAC,MAAM,iBAAiB,GAAa;IACzC,cAAc;IACd,iBAAiB;IACjB,kBAAkB;IAClB,sBAAsB;IACtB,qBAAqB;IACrB,oBAAoB;CACrB,CAAC;AAEF,uDAAuD;AACvD,MAAM,CAAC,MAAM,SAAS,GAAa;IACjC,mBAAmB;IACnB,qBAAqB;IACrB,WAAW;IACX,gBAAgB;IAChB,UAAU;CACX,CAAC;AAEF,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,4FAA4F;AAC5F,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,KAAK,UAAU,aAAa,CAAC,GAAW,EAAE,QAAgB;IACxD,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,6FAA6F;AAC7F,KAAK,UAAU,MAAM,CAAC,IAAY,EAAE,MAAc,EAAE,IAAY;IAC9D,MAAM,GAAG,GAAG,CAAC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACzF,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACvC,MAAM,KAAK,GAAG,kCAAkC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7D,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;QAC/D,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACjG,CAAC;IACD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAChD,MAAM,GAAG,GAA4B,EAAE,CAAC;QACxC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;YAC5C,GAAG,CAAC,GAAG,CAAC,GAAG,SAAS,CAAE,KAAiC,CAAC,GAAG,CAAC,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,kFAAkF;AAClF,KAAK,UAAU,cAAc,CAAC,IAAY,EAAE,EAAU,EAAE,KAAa;IACnE,MAAM,IAAI,GAAG,CAAC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC7E,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,OAAO,KAAK,uBAAwB,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IACD,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,OAAO,KAAK,uBAAuB,CAAC,CAAC;IAClE,CAAC;IACD,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,KAAK,MAAM,KAAK,IAAI,iBAAiB,EAAE,CAAC;QACtC,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;YACxD,MAAM,CAAC,KAAK,CAAC,GAAG,SAAS,CAAE,MAAkC,CAAC,KAAK,CAAC,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AAChC,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,IAAI,GAAG,CAAC,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC1G,IAAI,QAAgB,CAAC;QACrB,IAAI,CAAC;YACH,QAAQ,GAAG,CAAC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,YAAY,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;QACvG,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,oBAAoB,KAAK,CAAC,IAAI,CAAC,QAAQ,KAAK,CAAC,SAAS,CAAC,KAAM,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1G,CAAC;QACD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,oBAAoB,KAAK,CAAC,IAAI,CAAC,QAAQ,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC7E,CAAC;QAED,MAAM,KAAK,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QACpD,MAAM,MAAM,GAAG,cAAc,QAAQ,eAAe,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC;QAClG,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC9D,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,QAAQ,CAAC,CAAC;QACpE,IAAI,cAAc,KAAK,SAAS,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,MAAM,QAAQ,aAAa,KAAK,KAAK,MAAM,EAAE,CAAC,EAAE,CAAC;QACnG,CAAC;QAED,MAAM,SAAS,GAAyC,EAAE,CAAC;QAC3D,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;YAClD,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,IAAI,CAAC,CAAC;YACxD,IAAI,MAAM,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBAChD,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,KAAK,KAAK,EAAE,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;QACD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,mCAAmC,KAAK,KAAK,MAAM,EAAE,CAAC,EAAE,CAAC;QAC3G,CAAC;QAED,IAAI,mBAAmB,GAAG,KAAK,CAAC;QAChC,IAAI,cAAc,KAAK,aAAa,EAAE,CAAC;YACrC,MAAM,UAAU,GAAG,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,cAAc,CAAC,IAAI,EAAE,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YAC/G,MAAM,SAAS,GAAG,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,cAAc,CAAC,IAAI,EAAE,aAAa,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;YACjH,mBAAmB,GAAG,UAAU,KAAK,SAAS,CAAC;QACjD,CAAC;QACD,MAAM,YAAY,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvF,MAAM,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEhE,IAAI,mBAAmB,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrD,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE;oBACR,oCAAoC,QAAQ,eAAe,KAAK,QAAQ,SAAS,wEAAwE;iBAC1J;aACF,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,mBAAmB,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE;oBACR,uBAAuB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,KAAK,+BAA+B,QAAQ,6DAA6D;iBACvK;aACF,CAAC;QACJ,CAAC;QACD,OAAO;YACL,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE;gBACR,mBAAmB;oBACjB,CAAC,CAAC,GAAG,QAAQ,0BAA0B,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB;oBACjF,CAAC,CAAC,oCAAoC,QAAQ,QAAQ,SAAS,UAAU;aAC5E;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/lowered-thresholds.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Lowered thresholds.
+ *
+ * The cheapest way to make a coverage gate pass is to ask less of it: the
+ * minimum in the runner's configuration goes down, or the key goes away. This
+ * check reads the lines `base..candidate` changes in the files where a
+ * repository states its coverage minimums, pairs each value the range removes
+ * with the value it adds for the same setting, and reports a minimum that went
+ * down (`threshold-lowered`) or disappeared (`threshold-removed`) for a human
+ * to sanction. A raised, new or merely moved value says nothing.
+ *
+ * Only the DIFF is read, by blob id through git, from the merge base of the
+ * two revisions; a low minimum the base already holds is never reported.
+ *
+ * Which files and which spellings count lives in one exported array,
+ * `THRESHOLD_SPELLINGS`, read each time the check runs: a repository on another
+ * runner appends its own entry.
+ */
+import type { CheckRecord } from "./index.js";
+export type ThresholdCategory = "threshold-lowered" | "threshold-removed";
+/** One spelling of a stated minimum. */
+export interface ThresholdSpelling {
+    /** What the evidence calls this spelling. */
+    readonly name: string;
+    /** Tested against a changed path. */
+    readonly files: RegExp;
+    /**
+     * Tested against each line the range removes or adds in such a file. The
+     * named group `value` holds the number; the optional group `key` names the
+     * setting. A line may hold several matches.
+     */
+    readonly pattern: RegExp;
+    /** A line `pattern` matches. */
+    readonly example: string;
+}
+export declare const THRESHOLD_SPELLINGS: ThresholdSpelling[];
+/** One minimum the range lowered or removed. */
+export interface ThresholdFinding {
+    /** `<category>:<file>:<line>`. */
+    readonly id: string;
+    readonly category: ThresholdCategory;
+    readonly file: string;
+    /** The line in the candidate for a lowered value, in the base for a removed one. */
+    readonly line: number;
+    readonly name: string;
+    readonly key: string | null;
+    readonly oldValue: string;
+    readonly newValue: string | null;
+    /** The sanction's reason, or `null` while the finding is unsanctioned. */
+    readonly sanction: string | null;
+}
+export interface LoweredThresholdsRecord extends CheckRecord {
+    readonly findings: readonly ThresholdFinding[];
+}
+export interface LoweredThresholdsOptions {
+    readonly cwd: string;
+    /** The revision the range starts after. */
+    readonly base: string;
+    /** The revision the range ends at. */
+    readonly candidate: string;
+    /** Keys are finding ids or `<category>:<file>`; values are the reasons. */
+    readonly sanctions?: Readonly<Record<string, string>> | undefined;
+}
+/**
+ * Report the coverage minimums `base..candidate` lowers or removes. Fails while
+ * any finding is unsanctioned, and 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 checkLoweredThresholds(options: LoweredThresholdsOptions): Promise<LoweredThresholdsRecord>;

package/dist/lowered-thresholds.js

@@ -0,0 +1,281 @@
+/**
+ * Lowered thresholds.
+ *
+ * The cheapest way to make a coverage gate pass is to ask less of it: the
+ * minimum in the runner's configuration goes down, or the key goes away. This
+ * check reads the lines `base..candidate` changes in the files where a
+ * repository states its coverage minimums, pairs each value the range removes
+ * with the value it adds for the same setting, and reports a minimum that went
+ * down (`threshold-lowered`) or disappeared (`threshold-removed`) for a human
+ * to sanction. A raised, new or merely moved value says nothing.
+ *
+ * Only the DIFF is read, by blob id through git, from the merge base of the
+ * two revisions; a low minimum the base already holds is never reported.
+ *
+ * Which files and which spellings count lives in one exported array,
+ * `THRESHOLD_SPELLINGS`, read each time the check runs: a repository on another
+ * runner appends its own entry.
+ */
+import { execFile } from "node:child_process";
+import { SANCTION_KEY } from "./weakened-tests.js";
+const NAME = "RT-14";
+const NUMBER = "(?<value>\\d+(?:\\.\\d+)?)";
+const KEYS = "(?<key>lines|branches|functions|statements)";
+const RUNNER_CONFIG = /(?:^|\/)(?:(?:vitest|vite|jest)\.config\.(?:[cm]?[jt]s|json)|package\.json|\.nycrc(?:\.json)?|\.c8rc(?:\.json)?)$/;
+export const THRESHOLD_SPELLINGS = [
+    {
+        name: "coverage key",
+        files: RUNNER_CONFIG,
+        pattern: new RegExp(`(?<![\\w.-])["']?${KEYS}["']?\\s*:\\s*${NUMBER}`),
+        example: "lines: 80,",
+    },
+    {
+        name: "coverage flag",
+        files: /(?:^|\/)package\.json$/,
+        pattern: new RegExp(`(?<![\\w-])--${KEYS}(?:\\s+|=)${NUMBER}`),
+        example: '"check": "c8 check-coverage --lines 80",',
+    },
+    {
+        name: "pytest --cov-fail-under",
+        files: /(?:^|\/)(?:pyproject\.toml|setup\.cfg|tox\.ini|pytest\.ini)$/,
+        pattern: new RegExp(`(?<![\\w-])--cov-fail-under(?:\\s+|=)${NUMBER}`),
+        example: "addopts = --cov-fail-under=80",
+    },
+    {
+        name: "coverage.py fail_under",
+        files: /(?:^|\/)(?:pyproject\.toml|setup\.cfg|tox\.ini|\.coveragerc)$/,
+        pattern: new RegExp(`(?<![\\w-])fail_under\\s*=\\s*${NUMBER}`),
+        example: "fail_under = 80",
+    },
+];
+function runGit(cwd, args) {
+    return new Promise((resolve, reject) => {
+        execFile("git", args, { cwd, maxBuffer: 1024 * 1024 * 1024, encoding: "utf8" }, (error, stdout, stderr) => {
+            if (error) {
+                reject(new Error(stderr.trim() || error.message));
+                return;
+            }
+            resolve(stdout);
+        });
+    });
+}
+/** Escape everything outside printable ASCII, so evidence cannot replay a control sequence. */
+function escapeText(text) {
+    let escaped = "";
+    for (const char of text) {
+        const codePoint = char.codePointAt(0) ?? 0;
+        escaped += codePoint >= 0x20 && codePoint <= 0x7e ? char : `\\u{${codePoint.toString(16).padStart(4, "0")}}`;
+    }
+    return escaped;
+}
+function quote(text) {
+    return `"${escapeText(text)}"`;
+}
+async function resolveCommit(cwd, revision) {
+    // A revision that begins with a dash would be read as an option.
+    if (typeof revision !== "string" || revision.length === 0 || revision.startsWith("-")) {
+        throw new Error(`revision ${quote(String(revision))} does not name a commit`);
+    }
+    let hash = "";
+    try {
+        hash = (await runGit(cwd, ["rev-parse", "--verify", "--quiet", `${revision}^{commit}`])).trim();
+    }
+    catch (error) {
+        throw new Error(`revision ${quote(revision)} does not name a commit: ${error.message}`);
+    }
+    if (hash.length === 0) {
+        throw new Error(`revision ${quote(revision)} does not name a commit`);
+    }
+    return hash;
+}
+function toLines(text) {
+    if (text.includes("\0")) {
+        return [];
+    }
+    const lines = text.split("\n");
+    if (lines[lines.length - 1] === "") {
+        lines.pop();
+    }
+    return lines.map((line, index) => ({ number: index + 1, text: line.replace(/\r$/, "") }));
+}
+async function readBlob(cwd, blob) {
+    return blob === null ? [] : toLines(await runGit(cwd, ["cat-file", "blob", blob]));
+}
+async function diffBlobs(cwd, oldBlob, newBlob) {
+    const out = await runGit(cwd, ["diff", "-U0", "--no-color", "--no-ext-diff", "--no-textconv", oldBlob, newBlob]);
+    const removed = [];
+    const added = [];
+    let oldLine = 0;
+    let newLine = 0;
+    let inHunk = false;
+    for (const raw of out.split("\n")) {
+        const hunk = /^@@ -(\d+)(?:,\d+)? \+(\d+)(?:,\d+)? @@/.exec(raw);
+        if (hunk !== null) {
+            oldLine = Number(hunk[1]);
+            newLine = Number(hunk[2]);
+            inHunk = true;
+        }
+        else if (inHunk && raw.startsWith("-")) {
+            removed.push({ number: oldLine, text: raw.slice(1).replace(/\r$/, "") });
+            oldLine += 1;
+        }
+        else if (inHunk && raw.startsWith("+")) {
+            added.push({ number: newLine, text: raw.slice(1).replace(/\r$/, "") });
+            newLine += 1;
+        }
+    }
+    return { removed, added };
+}
+async function readChanges(cwd, from, to) {
+    const out = await runGit(cwd, ["diff", "--raw", "-z", "--no-abbrev", "--find-renames", "--no-relative", from, to, "--"]);
+    const fields = out.split("\0");
+    const changes = [];
+    let i = 0;
+    while (i < fields.length) {
+        const head = fields[i] ?? "";
+        i += 1;
+        if (!head.startsWith(":")) {
+            continue;
+        }
+        const [oldMode = "", newMode = "", oldSha = "", newSha = "", status = ""] = head.slice(1).split(" ");
+        const first = fields[i] ?? "";
+        i += 1;
+        let second = first;
+        if (status.startsWith("R") || status.startsWith("C")) {
+            second = fields[i] ?? "";
+            i += 1;
+        }
+        const regular = (mode, sha) => mode.startsWith("100") && !/^0+$/.test(sha) ? sha : null;
+        const oldBlob = regular(oldMode, oldSha);
+        const newBlob = regular(newMode, newSha);
+        const lines = oldBlob !== null && newBlob !== null
+            ? await diffBlobs(cwd, oldBlob, newBlob)
+            : { removed: await readBlob(cwd, oldBlob), added: await readBlob(cwd, newBlob) };
+        changes.push({
+            oldPath: status.startsWith("A") ? null : first,
+            newPath: status.startsWith("D") ? null : second,
+            ...lines,
+        });
+    }
+    return changes;
+}
+function hitsOf(spelling, path, lines) {
+    if (path === null) {
+        return [];
+    }
+    spelling.files.lastIndex = 0;
+    if (!spelling.files.test(path)) {
+        return [];
+    }
+    const flags = spelling.pattern.flags.includes("g") ? spelling.pattern.flags : `${spelling.pattern.flags}g`;
+    const pattern = new RegExp(spelling.pattern.source, flags);
+    const hits = [];
+    for (const line of lines) {
+        for (const match of line.text.matchAll(pattern)) {
+            const value = match.groups?.["value"];
+            if (value !== undefined && Number.isFinite(Number(value))) {
+                hits.push({ line: line.number, key: match.groups?.["key"] ?? "", value });
+            }
+        }
+    }
+    return hits;
+}
+function draftsOf(changes, spellings) {
+    const drafts = [];
+    for (const change of changes) {
+        for (const spelling of spellings) {
+            const removed = hitsOf(spelling, change.oldPath, change.removed);
+            const added = hitsOf(spelling, change.newPath, change.added);
+            const keys = new Set([...removed, ...added].map((hit) => hit.key));
+            for (const key of keys) {
+                const before = removed.filter((hit) => hit.key === key);
+                const after = added.filter((hit) => hit.key === key);
+                before.forEach((old, index) => {
+                    const now = after[index];
+                    const shared = { name: spelling.name, key: key === "" ? null : key, oldValue: old.value };
+                    if (now === undefined) {
+                        drafts.push({ category: "threshold-removed", file: change.oldPath ?? "", line: old.line, newValue: null, ...shared });
+                    }
+                    else if (Number(now.value) < Number(old.value)) {
+                        drafts.push({ category: "threshold-lowered", file: change.newPath ?? "", line: now.line, newValue: now.value, ...shared });
+                    }
+                });
+            }
+        }
+    }
+    return drafts;
+}
+/** The text after the sanction key on every such line of the range's commit messages. */
+async function readSanctionLines(cwd, from, to) {
+    const out = await runGit(cwd, ["log", "--format=%B%x00", `${from}..${to}`, "--"]);
+    const prefix = `${SANCTION_KEY}:`;
+    return out
+        .split(/[\n\0]/)
+        .map((line) => line.trim())
+        .filter((line) => line.startsWith(prefix))
+        .map((line) => line.slice(prefix.length).trim());
+}
+function sanctionFor(draft, id, lines, given) {
+    for (const key of [id, `${draft.category}:${draft.file}`]) {
+        const reason = Object.hasOwn(given, key) ? given[key] : undefined;
+        if (typeof reason === "string" && reason.trim().length > 0) {
+            return reason.trim();
+        }
+        for (const line of lines) {
+            const rest = line.slice(key.length);
+            if (line.startsWith(key) && /^\s+\S/.test(rest)) {
+                return rest.trim();
+            }
+        }
+    }
+    return null;
+}
+function describeFinding(finding) {
+    const setting = finding.key === null ? finding.name : `${finding.name} ${finding.key}`;
+    const moved = finding.newValue === null
+        ? `removed ${setting}, was ${finding.oldValue}`
+        : `lowered ${setting} from ${finding.oldValue} to ${finding.newValue}`;
+    const tail = finding.sanction === null ? "" : ` - sanctioned: ${finding.sanction}`;
+    return `${escapeText(finding.file)}:${finding.line}: ${escapeText(moved + tail)}`;
+}
+/**
+ * Report the coverage minimums `base..candidate` lowers or removes. Fails while
+ * any finding is unsanctioned, and 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 checkLoweredThresholds(options) {
+    try {
+        const { cwd, base, candidate } = options;
+        const baseCommit = await resolveCommit(cwd, base);
+        const candidateCommit = await resolveCommit(cwd, candidate);
+        let ancestor;
+        try {
+            ancestor = (await runGit(cwd, ["merge-base", baseCommit, candidateCommit])).trim();
+        }
+        catch (error) {
+            throw new Error(`no merge base of ${quote(base)} and ${quote(candidate)}: ${error.message}`);
+        }
+        const changes = await readChanges(cwd, ancestor, candidateCommit);
+        const drafts = draftsOf(changes, THRESHOLD_SPELLINGS);
+        const lines = drafts.length === 0 ? [] : await readSanctionLines(cwd, baseCommit, candidateCommit);
+        const findings = drafts.map((draft) => {
+            const id = `${draft.category}:${draft.file}:${draft.line}`;
+            return { id, ...draft, sanction: sanctionFor(draft, id, lines, options.sanctions ?? {}) };
+        });
+        if (findings.length === 0) {
+            return { name: NAME, status: "pass", evidence: ["no threshold lowered or removed"], findings };
+        }
+        const open = findings.some((finding) => finding.sanction === null);
+        return { name: NAME, status: open ? "fail" : "pass", evidence: findings.map(describeFinding), findings };
+    }
+    catch (error) {
+        return {
+            name: NAME,
+            status: "fail",
+            evidence: [escapeText(error instanceof Error ? error.message : String(error))],
+            findings: [],
+        };
+    }
+}
+//# sourceMappingURL=lowered-thresholds.js.map

package/dist/lowered-thresholds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lowered-thresholds.js","sourceRoot":"","sources":["../src/lowered-thresholds.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAG9C,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,MAAM,IAAI,GAAG,OAAO,CAAC;AAoBrB,MAAM,MAAM,GAAG,4BAA4B,CAAC;AAC5C,MAAM,IAAI,GAAG,6CAA6C,CAAC;AAC3D,MAAM,aAAa,GACjB,mHAAmH,CAAC;AAEtH,MAAM,CAAC,MAAM,mBAAmB,GAAwB;IACtD;QACE,IAAI,EAAE,cAAc;QACpB,KAAK,EAAE,aAAa;QACpB,OAAO,EAAE,IAAI,MAAM,CAAC,oBAAoB,IAAI,iBAAiB,MAAM,EAAE,CAAC;QACtE,OAAO,EAAE,YAAY;KACtB;IACD;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,wBAAwB;QAC/B,OAAO,EAAE,IAAI,MAAM,CAAC,gBAAgB,IAAI,aAAa,MAAM,EAAE,CAAC;QAC9D,OAAO,EAAE,0CAA0C;KACpD;IACD;QACE,IAAI,EAAE,yBAAyB;QAC/B,KAAK,EAAE,8DAA8D;QACrE,OAAO,EAAE,IAAI,MAAM,CAAC,wCAAwC,MAAM,EAAE,CAAC;QACrE,OAAO,EAAE,+BAA+B;KACzC;IACD;QACE,IAAI,EAAE,wBAAwB;QAC9B,KAAK,EAAE,+DAA+D;QACtE,OAAO,EAAE,IAAI,MAAM,CAAC,iCAAiC,MAAM,EAAE,CAAC;QAC9D,OAAO,EAAE,iBAAiB;KAC3B;CACF,CAAC;AAgCF,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,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;gBAClD,OAAO;YACT,CAAC;YACD,OAAO,CAAC,MAAM,CAAC,CAAC;QAClB,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,+FAA+F;AAC/F,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,OAAO,IAAI,SAAS,IAAI,IAAI,IAAI,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC;IAC/G,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,KAAK,CAAC,IAAY;IACzB,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC;AACjC,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,GAAW,EAAE,QAAgB;IACxD,iEAAiE;IACjE,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACtF,MAAM,IAAI,KAAK,CAAC,YAAY,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,yBAAyB,CAAC,CAAC;IAChF,CAAC;IACD,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,IAAI,CAAC;QACH,IAAI,GAAG,CAAC,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,QAAQ,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAClG,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,YAAY,KAAK,CAAC,QAAQ,CAAC,4BAA6B,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,YAAY,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;IACxE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAcD,SAAS,OAAO,CAAC,IAAY;IAC3B,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;QACnC,KAAK,CAAC,GAAG,EAAE,CAAC;IACd,CAAC;IACD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAC5F,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,GAAW,EAAE,IAAmB;IACtD,OAAO,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AACrF,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,GAAW,EAAE,OAAe,EAAE,OAAe;IACpE,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IACjH,MAAM,OAAO,GAAW,EAAE,CAAC;IAC3B,MAAM,KAAK,GAAW,EAAE,CAAC;IACzB,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,KAAK,MAAM,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,yCAAyC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjE,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1B,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1B,MAAM,GAAG,IAAI,CAAC;QAChB,CAAC;aAAM,IAAI,MAAM,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACzC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;YACzE,OAAO,IAAI,CAAC,CAAC;QACf,CAAC;aAAM,IAAI,MAAM,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACzC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;YACvE,OAAO,IAAI,CAAC,CAAC;QACf,CAAC;IACH,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAC5B,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,GAAW,EAAE,IAAY,EAAE,EAAU;IAC9D,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,gBAAgB,EAAE,eAAe,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IACzH,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC7B,CAAC,IAAI,CAAC,CAAC;QACP,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,SAAS;QACX,CAAC;QACD,MAAM,CAAC,OAAO,GAAG,EAAE,EAAE,OAAO,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrG,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC9B,CAAC,IAAI,CAAC,CAAC;QACP,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACrD,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YACzB,CAAC,IAAI,CAAC,CAAC;QACT,CAAC;QACD,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,GAAW,EAAiB,EAAE,CAC3D,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;QAC3D,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACzC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACzC,MAAM,KAAK,GACT,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,IAAI;YAClC,CAAC,CAAC,MAAM,SAAS,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC;YACxC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,CAAC;QACrF,OAAO,CAAC,IAAI,CAAC;YACX,OAAO,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK;YAC9C,OAAO,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM;YAC/C,GAAG,KAAK;SACT,CAAC,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAQD,SAAS,MAAM,CAAC,QAA2B,EAAE,IAAmB,EAAE,KAAsB;IACtF,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,QAAQ,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC;IAC7B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC;IAC3G,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC3D,MAAM,IAAI,GAAU,EAAE,CAAC;IACvB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAChD,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC;YACtC,IAAI,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBAC1D,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAID,SAAS,QAAQ,CAAC,OAA0B,EAAE,SAAuC;IACnF,MAAM,MAAM,GAAY,EAAE,CAAC;IAC3B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;YACjE,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;YAC7D,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;YACnE,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;gBACxD,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;gBACrD,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;oBAC5B,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;oBACzB,MAAM,MAAM,GAAG,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC;oBAC1F,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;wBACtB,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;oBACxH,CAAC;yBAAM,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;wBACjD,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;oBAC7H,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,yFAAyF;AACzF,KAAK,UAAU,iBAAiB,CAAC,GAAW,EAAE,IAAY,EAAE,EAAU;IACpE,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,iBAAiB,EAAE,GAAG,IAAI,KAAK,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IAClF,MAAM,MAAM,GAAG,GAAG,YAAY,GAAG,CAAC;IAClC,OAAO,GAAG;SACP,KAAK,CAAC,QAAQ,CAAC;SACf,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC1B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;SACzC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,WAAW,CAClB,KAAY,EACZ,EAAU,EACV,KAAwB,EACxB,KAAuC;IAEvC,KAAK,MAAM,GAAG,IAAI,CAAC,EAAE,EAAE,GAAG,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAC1D,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAClE,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3D,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;QACvB,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACpC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChD,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,eAAe,CAAC,OAAyB;IAChD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IACvF,MAAM,KAAK,GACT,OAAO,CAAC,QAAQ,KAAK,IAAI;QACvB,CAAC,CAAC,WAAW,OAAO,SAAS,OAAO,CAAC,QAAQ,EAAE;QAC/C,CAAC,CAAC,WAAW,OAAO,SAAS,OAAO,CAAC,QAAQ,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC3E,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,kBAAkB,OAAO,CAAC,QAAQ,EAAE,CAAC;IACnF,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC;AACpF,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,OAAiC;IAC5E,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,IAAI,QAAgB,CAAC;QACrB,IAAI,CAAC;YACH,QAAQ,GAAG,CAAC,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,YAAY,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACrF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,oBAAoB,KAAK,CAAC,IAAI,CAAC,QAAQ,KAAK,CAAC,SAAS,CAAC,KAAM,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1G,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,GAAG,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;QAClE,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;QACtD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,iBAAiB,CAAC,GAAG,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC;QACnG,MAAM,QAAQ,GAAuB,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACxD,MAAM,EAAE,GAAG,GAAG,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YAC3D,OAAO,EAAE,EAAE,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,WAAW,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,CAAC;QAC5F,CAAC,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,iCAAiC,CAAC,EAAE,QAAQ,EAAE,CAAC;QACjG,CAAC;QACD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC;QACnE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC3G,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO;YACL,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,CAAC,UAAU,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC9E,QAAQ,EAAE,EAAE;SACb,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/measurement-rule.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 type { CheckRecord } from "./index.js";
+/** Where to look, and which two revisions bound the range. */
+export interface MeasurementRuleOptions {
+    /** 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 commit bodies in `base..candidate` and the lines the range adds
+ * to `.md` files. Fails closed on any git failure.
+ */
+export declare function checkMeasurementRule(options: MeasurementRuleOptions): Promise<CheckRecord>;