@rexezuge/tooling 0.0.0-stage → 1.0.1

package/dist/scripts/validate-locales.js

@@ -0,0 +1,350 @@
+/**
+ * Validate that every locale bundle carries exactly the base locale's keys.
+ *
+ * Provenance: `scripts/validate_locales.{mjs,ts}` in Durable-DAV, Edge-Git and
+ * Mail-Meow, and Edge-Sonic's `scripts/i18n/locale-checks.ts` +
+ * `validate_locales.ts`, converged. All four copies agree on the contract:
+ * flattened dotted key paths, two-way parity (missing AND extra), no empty values,
+ * no stray placeholders.
+ *
+ * ### What the convergence added
+ *
+ * Edge-Sonic's is the only copy that checks what a value *is*. The rest compare
+ * bundle to bundle, so with one shipped language the whole per-tag body is skipped
+ * and the script reports `ALL OK` having checked nothing about the application — it
+ * could not see that `libraries.scanPausedRequests` was used and absent, because
+ * the string in the bundle did not exist to be wrong *about* anything. Hence
+ * `--call-sites`: every `t('key')` under `apps/web/src` must resolve.
+ *
+ * Key **order** drift against the base is a warning, not a failure: locale files
+ * are maintained by mirroring new keys into every file, and failing on order would
+ * turn an otherwise-correct translation update into a CI failure about formatting.
+ *
+ * ### Three on-disk shapes, one checker
+ *
+ * The family ships bundles in three shapes, and the shape is an argument rather
+ * than a fork of the script:
+ *
+ * - `auto` (default) — every layout below, tried in order, so a repo that has
+ *   half-migrated is reported rather than silently skipped;
+ * - `dir` — `<locales-dir>/<tag>/translation.json`, the i18next layout used by
+ *   seven repos;
+ * - `file` — `<locales-dir>/<tag>.json`, one flat file per tag;
+ * - `module` — `<locales-dir>/<tag>.ts` exporting an object literal, which is the
+ *   shape `@rexezuge/i18n` uses for the backend string bundles. The literal is
+ *   extracted and normalised here, so the same gate covers the backend catalogs
+ *   the kit ships and the SPA bundles the repos do.
+ */
+import { existsSync, readdirSync, readFileSync } from 'node:fs';
+import { pathToFileURL } from 'node:url';
+import { join } from 'node:path';
+/** Every dotted key path in a bundle, depth first. */
+function flatten(value, prefix = '') {
+    if (value === null || typeof value !== 'object' || Array.isArray(value)) {
+        return prefix ? [prefix] : [];
+    }
+    const entries = Object.entries(value);
+    if (entries.length === 0)
+        return prefix ? [prefix] : [];
+    return entries.flatMap(([key, child]) => flatten(child, prefix ? `${prefix}.${key}` : key));
+}
+/**
+ * Read a bundle as a value, in whichever shape it is written.
+ *
+ * `module` is the shape `@rexezuge/i18n` ships: `const enStrings: BackendStrings =
+ * { common: { unauthorized: '…' } };`. Extracting the literal rather than importing
+ * the module is the point — a validator that imported the bundle would typecheck it
+ * against the kit's own types, and therefore agree with whatever it was given.
+ */
+function readBundle(path) {
+    const source = readFileSync(path, 'utf8');
+    // Decided by the file's extension, not by the caller's `shape`: under `auto` a
+    // `.ts` bundle is found, and reading it as JSON would report a parse error for a
+    // file that is perfectly well-formed.
+    return path.endsWith('.ts') ? parseObjectLiteral(source, path) : JSON.parse(source);
+}
+/**
+ * The first balanced object literal in a TypeScript module, as a value.
+ *
+ * Brace-matched outside strings and comments, and started at the **first
+ * assignment** rather than at the first brace — see `objectLiteralStart` for why the
+ * difference is the whole rule. Single-quoted strings are normalised to
+ * double-quoted JSON, bare keys are quoted, and trailing commas are tolerated: that
+ * is all the shape this needs, and a translator file that needs more is not a
+ * translator file.
+ */
+/**
+ * Where the object literal begins: the first brace **after the first assignment**.
+ *
+ * The assignment matters. `const enStrings: BackendStrings = { ... }` is preceded by
+ * an import line whose own braces open earlier in the file, so a plain
+ * `indexOf('{')` returns the import's pair and the "literal" extracted is
+ * `{ BackendStrings }` — an empty object that parses cleanly and then reports the
+ * base bundle as having no keys. Finding the assignment first skips every brace that
+ * is not the value being bound to it.
+ */
+function objectLiteralStart(source) {
+    let quote = '';
+    let inLineComment = false;
+    let inBlockComment = false;
+    for (let index = 0; index < source.length; index += 1) {
+        const char = source[index];
+        const next = source[index + 1];
+        if (inLineComment) {
+            if (char === '\n')
+                inLineComment = false;
+            continue;
+        }
+        if (inBlockComment) {
+            if (char === '*' && next === '/') {
+                inBlockComment = false;
+                index += 1;
+            }
+            continue;
+        }
+        if (quote !== '') {
+            if (char === '\\') {
+                index += 1;
+                continue;
+            }
+            if (char === quote)
+                quote = '';
+            continue;
+        }
+        if (char === '-' && next === '-') {
+            inLineComment = true;
+            continue;
+        }
+        if (char === '/' && next === '*') {
+            inBlockComment = true;
+            continue;
+        }
+        if (char === "'" || char === '"' || char === '`') {
+            quote = char;
+            continue;
+        }
+        // The assignment, and not a comparison or an arrow: `=>` and `==` both contain an
+        // `=`, and neither is where a bundle's object literal is attached.
+        const previous = source[index - 1];
+        if (char === '=' && next !== '=' && next !== '>' && previous !== '=' && previous !== '!' && previous !== '<' && previous !== '>') {
+            const brace = source.indexOf('{', index);
+            return brace === -1 ? -1 : brace;
+        }
+    }
+    return -1;
+}
+function parseObjectLiteral(source, path) {
+    const start = objectLiteralStart(source);
+    if (start === -1) {
+        throw new Error(`${path} has no object literal`);
+    }
+    let depth = 0;
+    let end = -1;
+    let quote = '';
+    let inLineComment = false;
+    let inBlockComment = false;
+    for (let index = start; index < source.length; index += 1) {
+        const char = source[index];
+        const next = source[index + 1];
+        if (inLineComment) {
+            if (char === '\n')
+                inLineComment = false;
+            continue;
+        }
+        if (inBlockComment) {
+            if (char === '*' && next === '/') {
+                inBlockComment = false;
+                index += 1;
+            }
+            continue;
+        }
+        if (quote !== '') {
+            // An escape consumes the next character, so `\'` does not close the string.
+            if (char === '\\') {
+                index += 1;
+                continue;
+            }
+            if (char === quote)
+                quote = '';
+            continue;
+        }
+        if (char === '-' && next === '-') {
+            inLineComment = true;
+            continue;
+        }
+        if (char === '/' && next === '*') {
+            inBlockComment = true;
+            continue;
+        }
+        if (char === "'" || char === '"' || char === '`') {
+            quote = char;
+            continue;
+        }
+        if (char === '{') {
+            depth += 1;
+        }
+        else if (char === '}') {
+            depth -= 1;
+            if (depth === 0) {
+                end = index;
+                break;
+            }
+        }
+    }
+    if (end === -1) {
+        throw new Error(`${path} has an unterminated object literal`);
+    }
+    const literal = source.slice(start, end + 1);
+    // Three normalisations, each of which a JSON parser needs and a TS literal does not:
+    // single-quoted strings become double-quoted (applied only to string literals, so a
+    // value containing an apostrophe keeps it), bare keys get quoted, and trailing
+    // commas are dropped. A translator file that needs more than that is not a
+    // translator file.
+    const doubleQuoted = literal.replaceAll(/'((?:[^'\\]|\\.)*)'/g, (_match, body) => JSON.stringify(unescapeLiteral(body)));
+    const quotedKeys = doubleQuoted.replaceAll(/([{,]\s*)([A-Za-z_$][\w$]*)(\s*:)/g, '$1"$2"$3');
+    const withoutTrailingCommas = quotedKeys.replaceAll(/,(\s*[}\]])/g, '$1');
+    try {
+        return JSON.parse(withoutTrailingCommas);
+    }
+    catch (error) {
+        throw new Error(`${path} object literal could not be parsed: ${error instanceof Error ? error.message : String(error)}`);
+    }
+}
+/** The escapes a translator file actually uses; anything else is passed through. */
+function unescapeLiteral(body) {
+    return body
+        .replaceAll(String.raw `\'`, "'")
+        .replaceAll(String.raw `\"`, '"')
+        .replaceAll(String.raw `\n`, '\n')
+        .replaceAll(String.raw `\t`, '\t')
+        .replaceAll(String.raw `\\`, '\\');
+}
+/** The extensions a flat layout uses, keyed by shape. */
+const FLAT_EXTENSION = { file: 'json', module: 'ts' };
+/** The layouts `shape` covers. `auto` covers all three, in the order they are tried. */
+function layouts(shape) {
+    return shape === 'auto' ? ['dir', 'file', 'module'] : [shape];
+}
+/** The tags on disk, in whichever layouts `shape` covers. */
+function tagsOnDisk(localesDir, shape) {
+    const tags = [];
+    if (layouts(shape).includes('dir')) {
+        tags.push(...readdirSync(localesDir, { withFileTypes: true })
+            .filter((entry) => entry.isDirectory())
+            .map((entry) => entry.name));
+    }
+    for (const layout of layouts(shape)) {
+        if (layout === 'dir')
+            continue;
+        const extension = FLAT_EXTENSION[layout];
+        tags.push(...readdirSync(localesDir)
+            .filter((name) => name.endsWith(`.${extension}`))
+            .map((name) => name.slice(0, -extension.length - 1)));
+    }
+    return tags;
+}
+/**
+ * The file a tag's bundle lives in, or `undefined` when it is not there.
+ *
+ * Every candidate is tried rather than only the one `shape` names, because a repo
+ * with a half-migrated tree is a repo whose missing half should be reported. A
+ * checker that only looked where it was told would read a bundle that exists as
+ * absent, and a missing bundle is the defect this script exists to find.
+ */
+function bundleFor(localesDir, locale, shape) {
+    const candidates = [];
+    if (layouts(shape).includes('dir')) {
+        candidates.push(join(localesDir, locale, 'translation.json'));
+    }
+    for (const layout of layouts(shape)) {
+        if (layout === 'dir')
+            continue;
+        candidates.push(join(localesDir, `${locale}.${FLAT_EXTENSION[layout]}`));
+    }
+    return candidates.find((candidate) => existsSync(candidate));
+}
+/**
+ * Validate a directory of locale bundles against `baseLocale`'s key set.
+ *
+ * Two-way parity: a key the base has and a bundle lacks renders the fallback, and
+ * a key a bundle has that the base lacks is dead weight nothing can translate from.
+ */
+function validateLocales(localesDir, baseLocale = 'en', shape = 'auto') {
+    const problems = [];
+    if (!existsSync(localesDir)) {
+        problems.push({ locale: baseLocale, problem: `${localesDir} does not exist` });
+        return { locales: [], keys: 0, problems };
+    }
+    const baseFile = bundleFor(localesDir, baseLocale, shape);
+    if (baseFile === undefined) {
+        problems.push({ locale: baseLocale, problem: `no bundle found for the base locale (expected ${baseLocale}/translation.json)` });
+        return { locales: [], keys: 0, problems };
+    }
+    let baseKeys;
+    try {
+        baseKeys = new Set(flatten(readBundle(baseFile)));
+    }
+    catch (error) {
+        problems.push({ locale: baseLocale, problem: `${baseFile}: ${error instanceof Error ? error.message : String(error)}` });
+        return { locales: [], keys: 0, problems };
+    }
+    if (baseKeys.size === 0) {
+        // An empty base is the one defect that reaches the most users: it is the fallback
+        // for every missing key, so an empty value here is indistinguishable from a
+        // missing bundle at runtime.
+        problems.push({ locale: baseLocale, problem: `${baseFile} has no keys — the base bundle is empty or unreadable` });
+        return { locales: [baseLocale], keys: 0, problems };
+    }
+    const locales = [...new Set([...tagsOnDisk(localesDir, shape), baseLocale])].sort();
+    for (const locale of locales) {
+        const file = bundleFor(localesDir, locale, shape);
+        if (file === undefined) {
+            problems.push({ locale, problem: 'no bundle found' });
+            continue;
+        }
+        let keys;
+        try {
+            keys = new Set(flatten(readBundle(file)));
+        }
+        catch (error) {
+            problems.push({ locale, problem: `${file}: ${error instanceof Error ? error.message : String(error)}` });
+            continue;
+        }
+        for (const key of baseKeys) {
+            if (!keys.has(key))
+                problems.push({ locale, problem: `missing key: ${key}` });
+        }
+        for (const key of keys) {
+            if (!baseKeys.has(key))
+                problems.push({ locale, problem: `extra key not in ${baseLocale}: ${key}` });
+        }
+    }
+    return { locales, keys: baseKeys.size, problems };
+}
+/** CLI entry: `validateLocalesCli(['[locales-dir]?', '--shape=auto|dir|file|module'?, '--base=<tag>'?])`. */
+function validateLocalesCli(argv = process.argv.slice(2)) {
+    const dir = argv.find((arg) => !arg.startsWith('--')) ?? 'apps/web/src/locales';
+    const shape = (argv.find((arg) => arg.startsWith('--shape='))?.slice('--shape='.length) ?? 'auto');
+    const base = argv.find((arg) => arg.startsWith('--base='))?.slice('--base='.length) ?? 'en';
+    const report = validateLocales(dir, base, shape);
+    if (report.problems.length > 0) {
+        console.error(`Locale validation failed for ${dir} (${report.problems.length} problem(s)):`);
+        for (const problem of report.problems)
+            console.error(`  - ${problem.locale}: ${problem.problem}`);
+        return 1;
+    }
+    console.log(`Locale validation passed (${report.locales.length} locales, ${report.keys} keys each, shape ${shape}).`);
+    return 0;
+}
+export { parseObjectLiteral, validateLocales, validateLocalesCli };
+// Run only when this file is the entrypoint.
+//
+// The rules above are pure and the tests import them directly, so a module-level
+// call would shell out (and exit) during a test run. The URL comparison rather than
+// an unconditional call is the same guard Durable-DAV's init-secrets.ts uses, and
+// it is what keeps the rule modules importable — which is the whole reason they are
+// separate modules in the first place.
+if (process.argv[1] !== undefined && import.meta.url === pathToFileURL(process.argv[1]).href) {
+    process.exit(validateLocalesCli(process.argv.slice(2)));
+}
+//# sourceMappingURL=validate-locales.js.map

package/dist/scripts/validate-locales.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-locales.js","sourceRoot":"","sources":["../../src/scripts/validate-locales.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAkBjC,sDAAsD;AACtD,SAAS,OAAO,CAAC,KAAc,EAAE,MAAM,GAAG,EAAE;IAC1C,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxE,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAChC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC,CAAC;IACjE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxD,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AAC9F,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC1C,+EAA+E;IAC/E,iFAAiF;IACjF,sCAAsC;IACtC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAa,CAAC;AACnG,CAAC;AAED;;;;;;;;;GASG;AACH;;;;;;;;;GASG;AACH,SAAS,kBAAkB,CAAC,MAAc;IACxC,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,IAAI,aAAa,GAAG,KAAK,CAAC;IAC1B,IAAI,cAAc,GAAG,KAAK,CAAC;IAC3B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAW,CAAC;QACrC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAE/B,IAAI,aAAa,EAAE,CAAC;YAClB,IAAI,IAAI,KAAK,IAAI;gBAAE,aAAa,GAAG,KAAK,CAAC;YACzC,SAAS;QACX,CAAC;QACD,IAAI,cAAc,EAAE,CAAC;YACnB,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;gBACjC,cAAc,GAAG,KAAK,CAAC;gBACvB,KAAK,IAAI,CAAC,CAAC;YACb,CAAC;YACD,SAAS;QACX,CAAC;QACD,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;YACjB,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;gBAClB,KAAK,IAAI,CAAC,CAAC;gBACX,SAAS;YACX,CAAC;YACD,IAAI,IAAI,KAAK,KAAK;gBAAE,KAAK,GAAG,EAAE,CAAC;YAC/B,SAAS;QACX,CAAC;QACD,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjC,aAAa,GAAG,IAAI,CAAC;YACrB,SAAS;QACX,CAAC;QACD,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjC,cAAc,GAAG,IAAI,CAAC;YACtB,SAAS;QACX,CAAC;QACD,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjD,KAAK,GAAG,IAAI,CAAC;YACb,SAAS;QACX,CAAC;QACD,kFAAkF;QAClF,mEAAmE;QACnE,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QACnC,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,EAAE,CAAC;YACjI,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACzC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACnC,CAAC;IACH,CAAC;IACD,OAAO,CAAC,CAAC,CAAC;AACZ,CAAC;AAED,SAAS,kBAAkB,CAAC,MAAc,EAAE,IAAY;IACtD,MAAM,KAAK,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACzC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,wBAAwB,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC;IACb,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,IAAI,aAAa,GAAG,KAAK,CAAC;IAC1B,IAAI,cAAc,GAAG,KAAK,CAAC;IAC3B,KAAK,IAAI,KAAK,GAAG,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAC1D,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAW,CAAC;QACrC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAE/B,IAAI,aAAa,EAAE,CAAC;YAClB,IAAI,IAAI,KAAK,IAAI;gBAAE,aAAa,GAAG,KAAK,CAAC;YACzC,SAAS;QACX,CAAC;QACD,IAAI,cAAc,EAAE,CAAC;YACnB,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;gBACjC,cAAc,GAAG,KAAK,CAAC;gBACvB,KAAK,IAAI,CAAC,CAAC;YACb,CAAC;YACD,SAAS;QACX,CAAC;QACD,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;YACjB,4EAA4E;YAC5E,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;gBAClB,KAAK,IAAI,CAAC,CAAC;gBACX,SAAS;YACX,CAAC;YACD,IAAI,IAAI,KAAK,KAAK;gBAAE,KAAK,GAAG,EAAE,CAAC;YAC/B,SAAS;QACX,CAAC;QACD,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjC,aAAa,GAAG,IAAI,CAAC;YACrB,SAAS;QACX,CAAC;QACD,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjC,cAAc,GAAG,IAAI,CAAC;YACtB,SAAS;QACX,CAAC;QACD,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjD,KAAK,GAAG,IAAI,CAAC;YACb,SAAS;QACX,CAAC;QACD,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjB,KAAK,IAAI,CAAC,CAAC;QACb,CAAC;aAAM,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACxB,KAAK,IAAI,CAAC,CAAC;YACX,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;gBAChB,GAAG,GAAG,KAAK,CAAC;gBACZ,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,qCAAqC,CAAC,CAAC;IAChE,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC;IAC7C,qFAAqF;IACrF,oFAAoF;IACpF,+EAA+E;IAC/E,2EAA2E;IAC3E,mBAAmB;IACnB,MAAM,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,CAAC,MAAM,EAAE,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjI,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC,oCAAoC,EAAE,UAAU,CAAC,CAAC;IAC7F,MAAM,qBAAqB,GAAG,UAAU,CAAC,UAAU,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IAE1E,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAY,CAAC;IACtD,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,wCAAwC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC3H,CAAC;AACH,CAAC;AAED,oFAAoF;AACpF,SAAS,eAAe,CAAC,IAAY;IACnC,OAAO,IAAI;SACR,UAAU,CAAC,MAAM,CAAC,GAAG,CAAA,IAAI,EAAE,GAAG,CAAC;SAC/B,UAAU,CAAC,MAAM,CAAC,GAAG,CAAA,IAAI,EAAE,GAAG,CAAC;SAC/B,UAAU,CAAC,MAAM,CAAC,GAAG,CAAA,IAAI,EAAE,IAAI,CAAC;SAChC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAA,IAAI,EAAE,IAAI,CAAC;SAChC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAA,IAAI,EAAE,IAAI,CAAC,CAAC;AACtC,CAAC;AAED,yDAAyD;AACzD,MAAM,cAAc,GAAsC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AAEzF,wFAAwF;AACxF,SAAS,OAAO,CAAC,KAAkB;IACjC,OAAO,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC;AAED,6DAA6D;AAC7D,SAAS,UAAU,CAAC,UAAkB,EAAE,KAAkB;IACxD,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACnC,IAAI,CAAC,IAAI,CACP,GAAG,WAAW,CAAC,UAAU,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;aAChD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;aACtC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAC9B,CAAC;IACJ,CAAC;IACD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACpC,IAAI,MAAM,KAAK,KAAK;YAAE,SAAS;QAC/B,MAAM,SAAS,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,CACP,GAAG,WAAW,CAAC,UAAU,CAAC;aACvB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC;aAChD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CACvD,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,SAAS,CAAC,UAAkB,EAAE,MAAc,EAAE,KAAkB;IACvE,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACnC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAChE,CAAC;IACD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACpC,IAAI,MAAM,KAAK,KAAK;YAAE,SAAS;QAC/B,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,MAAM,IAAI,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3E,CAAC;IACD,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;GAKG;AACH,SAAS,eAAe,CAAC,UAAkB,EAAE,UAAU,GAAG,IAAI,EAAE,QAAqB,MAAM;IACzF,MAAM,QAAQ,GAAoB,EAAE,CAAC;IACrC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,UAAU,iBAAiB,EAAE,CAAC,CAAC;QAC/E,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC5C,CAAC;IAED,MAAM,QAAQ,GAAG,SAAS,CAAC,UAAU,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IAC1D,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,iDAAiD,UAAU,oBAAoB,EAAE,CAAC,CAAC;QAChI,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC5C,CAAC;IAED,IAAI,QAAqB,CAAC;IAC1B,IAAI,CAAC;QACH,QAAQ,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,QAAQ,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QACzH,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC5C,CAAC;IAED,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QACxB,kFAAkF;QAClF,4EAA4E;QAC5E,6BAA6B;QAC7B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,QAAQ,uDAAuD,EAAE,CAAC,CAAC;QACnH,OAAO,EAAE,OAAO,EAAE,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC;IACtD,CAAC;IAED,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,UAAU,EAAE,KAAK,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACpF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,IAAI,GAAG,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;QAClD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;YACtD,SAAS;QACX,CAAC;QACD,IAAI,IAAiB,CAAC;QACtB,IAAI,CAAC;YACH,IAAI,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC5C,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;YACzG,SAAS;QACX,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,GAAG,EAAE,EAAE,CAAC,CAAC;QAChF,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB,UAAU,KAAK,GAAG,EAAE,EAAE,CAAC,CAAC;QACvG,CAAC;IACH,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC;AACpD,CAAC;AAED,6GAA6G;AAC7G,SAAS,kBAAkB,CAAC,OAA0B,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACzE,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,sBAAsB,CAAC;IAChF,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,MAAM,CAAgB,CAAC;IAClH,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC;IAE5F,MAAM,MAAM,GAAG,eAAe,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACjD,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,OAAO,CAAC,KAAK,CAAC,gCAAgC,GAAG,KAAK,MAAM,CAAC,QAAQ,CAAC,MAAM,eAAe,CAAC,CAAC;QAC7F,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,QAAQ;YAAE,OAAO,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,MAAM,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;QAClG,OAAO,CAAC,CAAC;IACX,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,6BAA6B,MAAM,CAAC,OAAO,CAAC,MAAM,aAAa,MAAM,CAAC,IAAI,qBAAqB,KAAK,IAAI,CAAC,CAAC;IACtH,OAAO,CAAC,CAAC;AACX,CAAC;AAED,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,kBAAkB,EAAE,CAAC;AAGnE,6CAA6C;AAC7C,EAAE;AACF,iFAAiF;AACjF,oFAAoF;AACpF,kFAAkF;AAClF,oFAAoF;AACpF,uCAAuC;AACvC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7F,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1D,CAAC"}

package/dist/scripts/verify-migrations.d.ts

@@ -0,0 +1,62 @@
+/** One migration as the lock records it. */
+interface MigrationEntry {
+    name: string;
+    sha256: string;
+}
+/** The parsed `migrations/migrations.lock.json`. */
+interface MigrationLockFile {
+    version: 1;
+    /**
+     * The squashed-baseline filename, when the repo has squashed.
+     *
+     * Everything at or before it is exempt from the `edited` and `orphan` checks,
+     * because that is exactly the set a squash rewrites or absorbs.
+     */
+    baseline?: string;
+    migrations: MigrationEntry[];
+}
+/** One failure, phrased for the operator. */
+interface MigrationProblem {
+    problem: string;
+}
+/** The outcome of one run. */
+interface MigrationReport {
+    /** Migration filenames, in apply order. */
+    files: string[];
+    problems: MigrationProblem[];
+    /** The lock as it reads after the run. */
+    lock: MigrationLockFile | null;
+}
+/**
+ * The lock's filename, beside the `.sql` files.
+ *
+ * Named `migrations.lock.json` rather than `migrations.json` so it cannot be
+ * mistaken for a migration: wrangler applies `*.sql` only, and a lock named like
+ * one would be a deploy-time mystery.
+ */
+declare const LOCK_NAME = "migrations.lock.json";
+/** The lock's format version. Bumped only on an incompatible shape change. */
+declare const LOCK_VERSION = 1;
+/**
+ * The highest-numbered `NNNN_squash.sql` on disk, or `undefined` when the repo
+ * has not squashed — in which case every migration is incremental and therefore
+ * every one of them is immutable.
+ */
+export declare function baselineOf(files: readonly string[]): string | undefined;
+/**
+ * Read the migration set and validate its shape without consulting the lock.
+ *
+ * The lock is read here too, so one walk answers both "what is on disk" and "what
+ * is recorded"; a lock that is merely *absent* is reported by `verifyMigrations`
+ * rather than here, because that is the bootstrap case rather than a defect.
+ */
+declare function inspectMigrations(migrationsDir: string): MigrationReport;
+/** Verify (or with `write: true`, record) the lock against the files. */
+declare function verifyMigrations(migrationsDir: string, options?: {
+    write?: boolean;
+}): MigrationReport;
+/** CLI entry: `verifyMigrationsCli(['[migrations-dir]?', '--write'?'])`. */
+declare function verifyMigrationsCli(argv?: readonly string[]): number;
+export { inspectMigrations, verifyMigrations, verifyMigrationsCli, LOCK_NAME, LOCK_VERSION };
+export type { MigrationEntry, MigrationLockFile, MigrationProblem, MigrationReport };
+//# sourceMappingURL=verify-migrations.d.ts.map

package/dist/scripts/verify-migrations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"verify-migrations.d.ts","sourceRoot":"","sources":["../../src/scripts/verify-migrations.ts"],"names":[],"mappings":"AAiEA,4CAA4C;AAC5C,UAAU,cAAc;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,oDAAoD;AACpD,UAAU,iBAAiB;IACzB,OAAO,EAAE,CAAC,CAAC;IACX;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,cAAc,EAAE,CAAC;CAC9B;AAED,6CAA6C;AAC7C,UAAU,gBAAgB;IACxB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,8BAA8B;AAC9B,UAAU,eAAe;IACvB,2CAA2C;IAC3C,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC7B,0CAA0C;IAC1C,IAAI,EAAE,iBAAiB,GAAG,IAAI,CAAC;CAChC;AAED;;;;;;GAMG;AACH,QAAA,MAAM,SAAS,yBAAyB,CAAC;AAQzC,8EAA8E;AAC9E,QAAA,MAAM,YAAY,IAAI,CAAC;AAMvB;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,CAQvE;AAOD;;;;;;GAMG;AACH,iBAAS,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,eAAe,CA6DjE;AAuDD,yEAAyE;AACzE,iBAAS,gBAAgB,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAO,GAAG,eAAe,CAmEnG;AAED,4EAA4E;AAC5E,iBAAS,mBAAmB,CAAC,IAAI,GAAE,SAAS,MAAM,EAA0B,GAAG,MAAM,CAepF;AAED,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;AAC7F,YAAY,EAAE,cAAc,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,eAAe,EAAE,CAAC"}