@intentius/sql-yodeler 0.0.0-stage → 0.1.0

package/dist/lint/check.js

@@ -0,0 +1,208 @@
+/**
+ * `yodel lint` over a migrations directory: every rule in `./rules.ts`,
+ * offline, with no server. Optionally against one environment's history
+ * (`--env`), which turns the checksum rule from "the files changed since
+ * yodel wrote them" into "an applied migration changed since it ran".
+ *
+ * Rules that need more than the directory, such as the replay check (#11),
+ * plug in as {@link ProjectRule}s through {@link LintOptions.rules}.
+ */
+import { diffStatements } from "@intentius/chant-lexicon-sql/migration-statements";
+import { emptyBuild, scanMigrations } from "../migrations/index.js";
+import { levelOf } from "./config.js";
+import { LINT_RULES } from "./rules.js";
+import { mapMigrationSql } from "./silences.js";
+import { refusedStep, stepFindings, unreadableStep } from "./statements.js";
+const message = (e) => (e instanceof Error ? e.message : String(e)).split("\n")[0] ?? "";
+const UPDATE = "if it is not applied in any environment, record its new checksum with yodel lint --update-checksum <id>; if it is, undo the edit, or record it with yodel repair <id> --reason ... <env>";
+function directoryFindings(problems, history) {
+    const out = [];
+    for (const p of problems) {
+        switch (p.kind) {
+            case "fork":
+                out.push({ rule: "fork", message: p.message });
+                break;
+            case "checksum": {
+                if (history) {
+                    const applied = history.status.applied.find((a) => a.id === p.id && a.index !== undefined);
+                    // Applied: the history decides (below). Pending: an edit before it runs is allowed; say so.
+                    if (!applied) {
+                        out.push({
+                            rule: "checksum",
+                            level: "warning",
+                            migration: p.id,
+                            message: `${p.message}. It is not applied in ${history.environment}, so the edit is allowed there; record the new checksum with yodel lint --update-checksum ${p.id}`,
+                        });
+                    }
+                    break;
+                }
+                out.push({ rule: "checksum", migration: p.id, message: `${p.message}; ${UPDATE.replaceAll("<id>", p.id)}` });
+                break;
+            }
+            case "missing-parent":
+            case "id-mismatch":
+                out.push({ rule: "directory", migration: p.id, message: p.message });
+                break;
+            case "unreachable":
+                out.push({ rule: "directory", message: p.message });
+                break;
+            case "unreadable":
+                out.push({ rule: "directory", message: p.message });
+                break;
+        }
+    }
+    if (history) {
+        for (const mm of history.status.mismatches) {
+            out.push({ rule: "checksum", migration: mm.id, ...(mm.kind === "part-way" ? { step: mm.statement } : {}), message: `${history.environment}: ${mm.message}` });
+        }
+    }
+    return out;
+}
+/** The objects of a build that the lexicon cannot read, each alone; `[]` when it reads them all. */
+function unreadableObjects(schema, options) {
+    const empty = emptyBuild(schema);
+    const out = [];
+    for (const o of schema.objects) {
+        try {
+            diffStatements(empty, { ...schema, objects: [{ ...o, dependsOn: [] }] }, options);
+        }
+        catch (e) {
+            out.push({ export: o.export, type: o.type ?? "", ddl: o.ddl, error: message(e) });
+        }
+    }
+    return out;
+}
+/**
+ * The lexicon reads every migration's recorded schema: the diff from its
+ * parent's schema to its own is made again, as `yodel new` made it. An
+ * object it cannot read is reported once, in the first migration that
+ * records it; a failure no single object explains is reported whole.
+ */
+function schemaFindings(migrations, dialect) {
+    const out = [];
+    const byId = new Map(migrations.map((m) => [m.id, m]));
+    const reported = new Set();
+    for (const m of migrations) {
+        const doc = m.document;
+        const schema = doc.schema;
+        const recorded = doc.dialect;
+        if (recorded !== "clickhouse" && recorded !== "postgres") {
+            out.push({ rule: "directory", migration: m.id, message: `${m.id}/migration.json: dialect ${JSON.stringify(recorded)} is neither clickhouse nor postgres` });
+            continue;
+        }
+        if (dialect !== undefined && recorded !== dialect) {
+            out.push({ rule: "directory", migration: m.id, message: `${m.id} is a ${recorded} migration, but the project's dialect is ${dialect}` });
+            continue;
+        }
+        if (!Array.isArray(schema.objects) || schema.dialect !== recorded) {
+            out.push({ rule: "unreadable-object", migration: m.id, message: `${m.id}: its recorded schema is not a ${recorded} build output (a dialect and a list of objects)` });
+            continue;
+        }
+        const parent = m.parent === null ? undefined : byId.get(m.parent)?.document.schema;
+        const before = parent && Array.isArray(parent.objects) && parent.dialect === schema.dialect ? parent : emptyBuild(schema);
+        const options = {
+            ...(doc.defaultDatabase !== undefined ? { defaultDatabase: doc.defaultDatabase } : {}),
+            ...(doc.defaultSchema !== undefined ? { defaultSchema: doc.defaultSchema } : {}),
+        };
+        try {
+            diffStatements(before, schema, options);
+            continue;
+        }
+        catch (e) {
+            const bad = unreadableObjects(schema, options);
+            for (const o of bad) {
+                const key = `${o.export}\u0000${o.type}\u0000${o.ddl}`;
+                if (reported.has(key))
+                    continue;
+                reported.add(key);
+                out.push({ rule: "unreadable-object", migration: m.id, object: o.export, message: `${o.export} (${o.type || "no type"}) in ${m.id}'s recorded schema: the sql lexicon cannot read it: ${o.error}` });
+            }
+            if (bad.length === 0)
+                out.push({ rule: "unreadable-object", migration: m.id, message: `${m.id}: the sql lexicon cannot read its recorded schema against its parent's: ${message(e)}` });
+        }
+    }
+    return out;
+}
+const stepName = (s) => (typeof s.name === "string" ? s.name : undefined);
+/** Lints the migrations in `dir`. Never throws on what it finds; a finding is a result. */
+export async function lintMigrations(dir, options = {}) {
+    const scan = scanMigrations(dir);
+    const extra = options.rules ?? [];
+    const rules = { ...LINT_RULES, ...Object.fromEntries(extra.map((r) => [r.rule.id, r.rule])) };
+    const dialect = options.dialect;
+    const raw = [...directoryFindings(scan.problems, options.history), ...schemaFindings(scan.migrations, dialect)];
+    const silenceable = new Set(Object.values(rules).filter((r) => r.silenceable).map((r) => r.id));
+    const silences = {};
+    const used = new Set();
+    const statementRaw = [];
+    for (const m of scan.migrations) {
+        const d = m.document.dialect;
+        if (d !== "clickhouse" && d !== "postgres")
+            continue; // reported above
+        const steps = m.document.steps;
+        const map = mapMigrationSql(m.files.sql, steps, silenceable);
+        silences[m.id] = map.silences;
+        for (const p of map.problems)
+            raw.push({ rule: p.rule, migration: m.id, message: p.message, ...(p.step !== undefined ? { step: p.step } : {}), ...(p.line !== undefined ? { line: p.line } : {}) });
+        steps.forEach((step, i) => {
+            const name = stepName(step);
+            const where = { migration: m.id, step: i, ...(name !== undefined ? { object: name } : {}) };
+            const unreadable = unreadableStep(d, step);
+            if (unreadable) {
+                raw.push({ rule: "unreadable-object", ...where, message: `step ${String(i)}: ${unreadable}` });
+                return;
+            }
+            const refused = refusedStep(step);
+            if (refused)
+                raw.push({ rule: "refused-step", ...where, message: `step ${String(i)}: yodel apply refuses ${refused}` });
+            for (const f of stepFindings(d, step)) {
+                const rule = rules[f.rule];
+                if (rule?.dialect !== undefined && rule.dialect !== d)
+                    continue;
+                const silence = map.silences.find((s) => s.step === i && s.rule === f.rule);
+                if (silence)
+                    used.add(silence);
+                statementRaw.push({ rule: f.rule, ...where, message: `step ${String(i)}: ${f.message}`, ...(silence ? { silence } : {}) });
+            }
+        });
+        for (const s of map.silences) {
+            if (used.has(s))
+                continue;
+            raw.push({ rule: "silence", level: "warning", migration: m.id, step: s.step, line: s.line, message: `migration.sql line ${String(s.line)}: yodel:allow ${s.rule} silences nothing: step ${String(s.step)} breaks no ${s.rule} rule` });
+        }
+    }
+    for (const r of extra) {
+        try {
+            raw.push(...(await r.check({ dir: scan.dir, scan, dialect, project: options.project })));
+        }
+        catch (e) {
+            raw.push({ rule: r.rule.id, message: `${r.rule.id} could not run: ${message(e)}` });
+        }
+    }
+    const findings = [];
+    for (const f of [...raw, ...statementRaw]) {
+        const rule = rules[f.rule];
+        const setting = rule ? levelOf(rule, options.settings) : "error";
+        if (setting === "off")
+            continue;
+        const { silence, level, ...rest } = f;
+        findings.push({ ...rest, level: level ?? setting, ...(silence ? { silenced: silence.reason } : {}) });
+    }
+    findings.sort((a, b) => (a.migration ?? "").localeCompare(b.migration ?? "") ||
+        (a.step ?? -1) - (b.step ?? -1) ||
+        (a.line ?? 0) - (b.line ?? 0) ||
+        a.rule.localeCompare(b.rule));
+    const live = findings.filter((f) => f.silenced === undefined);
+    return {
+        dir: scan.dir,
+        dialect,
+        environment: options.history?.environment,
+        migrations: scan.migrations.map((m) => m.id),
+        findings,
+        silences,
+        errors: live.filter((f) => f.level === "error").length,
+        warnings: live.filter((f) => f.level === "warning").length,
+        silenced: findings.length - live.length,
+    };
+}
+//# sourceMappingURL=check.js.map

package/dist/lint/check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check.js","sourceRoot":"","sources":["../../src/lint/check.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,cAAc,EAAsB,MAAM,mDAAmD,CAAC;AAGvG,OAAO,EAAE,UAAU,EAAE,cAAc,EAA6D,MAAM,wBAAwB,CAAC;AAE/H,OAAO,EAAE,OAAO,EAAqB,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,UAAU,EAAiC,MAAM,YAAY,CAAC;AACvE,OAAO,EAAE,eAAe,EAAgB,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,cAAc,EAAgB,MAAM,iBAAiB,CAAC;AAoE1F,MAAM,OAAO,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAElG,MAAM,MAAM,GAAG,0LAA0L,CAAC;AAE1M,SAAS,iBAAiB,CAAC,QAAqC,EAAE,OAA+B;IAC/F,MAAM,GAAG,GAAiB,EAAE,CAAC;IAC7B,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;QACzB,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;YACf,KAAK,MAAM;gBACT,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC/C,MAAM;YACR,KAAK,UAAU,CAAC,CAAC,CAAC;gBAChB,IAAI,OAAO,EAAE,CAAC;oBACZ,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;oBAC3F,4FAA4F;oBAC5F,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,GAAG,CAAC,IAAI,CAAC;4BACP,IAAI,EAAE,UAAU;4BAChB,KAAK,EAAE,SAAS;4BAChB,SAAS,EAAE,CAAC,CAAC,EAAE;4BACf,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,0BAA0B,OAAO,CAAC,WAAW,6FAA6F,CAAC,CAAC,EAAE,EAAE;yBACtK,CAAC,CAAC;oBACL,CAAC;oBACD,MAAM;gBACR,CAAC;gBACD,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,KAAK,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC7G,MAAM;YACR,CAAC;YACD,KAAK,gBAAgB,CAAC;YACtB,KAAK,aAAa;gBAChB,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;gBACrE,MAAM;YACR,KAAK,aAAa;gBAChB,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;gBACpD,MAAM;YACR,KAAK,YAAY;gBACf,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;gBACpD,MAAM;QACV,CAAC;IACH,CAAC;IACD,IAAI,OAAO,EAAE,CAAC;QACZ,KAAK,MAAM,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC3C,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,WAAW,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAChK,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,oGAAoG;AACpG,SAAS,iBAAiB,CAAC,MAAmB,EAAE,OAA6D;IAC3G,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACjC,MAAM,GAAG,GAAwE,EAAE,CAAC;IACpF,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QAC/B,IAAI,CAAC;YACH,cAAc,CAAC,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QACpF,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACpF,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;GAKG;AACH,SAAS,cAAc,CAAC,UAAgC,EAAE,OAA4B;IACpF,MAAM,GAAG,GAAiB,EAAE,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IACnC,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,CAAC,CAAC,QAAQ,CAAC;QACvB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAC1B,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAkB,CAAC;QACxC,IAAI,QAAQ,KAAK,YAAY,IAAI,QAAQ,KAAK,UAAU,EAAE,CAAC;YACzD,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC,EAAE,4BAA4B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,qCAAqC,EAAE,CAAC,CAAC;YAC5J,SAAS;QACX,CAAC;QACD,IAAI,OAAO,KAAK,SAAS,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;YAClD,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC,EAAE,SAAS,QAAQ,4CAA4C,OAAO,EAAE,EAAE,CAAC,CAAC;YACzI,SAAS;QACX,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YAClE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC,EAAE,kCAAkC,QAAQ,iDAAiD,EAAE,CAAC,CAAC;YACtK,SAAS;QACX,CAAC;QACD,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC;QACnF,MAAM,MAAM,GAAG,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,KAAK,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC1H,MAAM,OAAO,GAAG;YACd,GAAG,CAAC,GAAG,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,GAAG,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACtF,GAAG,CAAC,GAAG,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACjF,CAAC;QACF,IAAI,CAAC;YACH,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YACxC,SAAS;QACX,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,GAAG,GAAG,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC/C,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC;gBACpB,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,MAAM,SAAS,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,GAAG,EAAE,CAAC;gBACvD,IAAI,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;oBAAE,SAAS;gBAChC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAClB,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,IAAI,IAAI,SAAS,QAAQ,CAAC,CAAC,EAAE,uDAAuD,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACvM,CAAC;YACD,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;gBAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC,EAAE,2EAA2E,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1L,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,QAAQ,GAAG,CAAC,CAAgB,EAAsB,EAAE,CAAC,CAAC,OAAQ,CAAwB,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAErI,2FAA2F;AAC3F,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,GAAW,EAAE,UAAuB,EAAE;IACzE,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;IAClC,MAAM,KAAK,GAA6B,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IACxH,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAChC,MAAM,GAAG,GAAiB,CAAC,GAAG,iBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAE9H,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAChG,MAAM,QAAQ,GAA8B,EAAE,CAAC;IAC/C,MAAM,IAAI,GAAG,IAAI,GAAG,EAAW,CAAC;IAChC,MAAM,YAAY,GAA8C,EAAE,CAAC;IAEnE,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;QAChC,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAkB,CAAC;QACxC,IAAI,CAAC,KAAK,YAAY,IAAI,CAAC,KAAK,UAAU;YAAE,SAAS,CAAC,iBAAiB;QACvE,MAAM,KAAK,GAAG,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC/B,MAAM,GAAG,GAAG,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;QAC7D,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC;QAC9B,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,QAAQ;YAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QAEpM,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;YACxB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC5B,MAAM,KAAK,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;YAC5F,MAAM,UAAU,GAAG,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAC3C,IAAI,UAAU,EAAE,CAAC;gBACf,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,QAAQ,MAAM,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,EAAE,CAAC,CAAC;gBAC/F,OAAO;YACT,CAAC;YACD,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;YAClC,IAAI,OAAO;gBAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,QAAQ,MAAM,CAAC,CAAC,CAAC,yBAAyB,OAAO,EAAE,EAAE,CAAC,CAAC;YACxH,KAAK,MAAM,CAAC,IAAI,YAAY,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;gBACtC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBAC3B,IAAI,IAAI,EAAE,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC;oBAAE,SAAS;gBAChE,MAAM,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;gBAC5E,IAAI,OAAO;oBAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAC/B,YAAY,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,QAAQ,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YAC7H,CAAC;QACH,CAAC,CAAC,CAAC;QACH,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;YAC7B,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBAAE,SAAS;YAC1B,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,sBAAsB,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,2BAA2B,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,OAAO,EAAE,CAAC,CAAC;QACzO,CAAC;IACH,CAAC;IAED,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC;YACH,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3F,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,mBAAmB,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QACjE,IAAI,OAAO,KAAK,KAAK;YAAE,SAAS;QAChC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,CAAuC,CAAC;QAC5E,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,IAAI,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACxG,CAAC;IACD,QAAQ,CAAC,IAAI,CACX,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACP,CAAC,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC;QACpD,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC;QAC7B,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAC/B,CAAC;IACF,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC;IAC9D,OAAO;QACL,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,OAAO;QACP,WAAW,EAAE,OAAO,CAAC,OAAO,EAAE,WAAW;QACzC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5C,QAAQ;QACR,QAAQ;QACR,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC,MAAM;QACtD,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,MAAM;QAC1D,QAAQ,EAAE,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM;KACxC,CAAC;AACJ,CAAC"}

package/dist/lint/config.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Rule levels from `yodel.config.ts`:
+ *
+ * ```ts
+ * export default defineConfig({
+ *   lint: { rules: { "ch-mutation": "warning", "pg-lock": "off" } },
+ * });
+ * ```
+ *
+ * A level is `error` (fails the run), `warning` (reported, does not fail)
+ * or `off`. The integrity rules (`fork`, `directory`, `checksum`,
+ * `unreadable-object`) are always errors and cannot be set.
+ */
+import type { LevelSetting, LintRule } from "./rules.js";
+export interface LintSettings {
+    levels: Record<string, LevelSetting>;
+}
+/** Checks `lint` from `yodel.config.ts` against the rules there are. `where` names the file in errors. */
+export declare function lintSettings(raw: Record<string, unknown> | undefined, rules: Readonly<Record<string, LintRule>>, where?: string): LintSettings;
+/** The level a rule runs at. */
+export declare const levelOf: (rule: LintRule, settings: LintSettings | undefined) => LevelSetting;

package/dist/lint/config.js

@@ -0,0 +1,43 @@
+/**
+ * Rule levels from `yodel.config.ts`:
+ *
+ * ```ts
+ * export default defineConfig({
+ *   lint: { rules: { "ch-mutation": "warning", "pg-lock": "off" } },
+ * });
+ * ```
+ *
+ * A level is `error` (fails the run), `warning` (reported, does not fail)
+ * or `off`. The integrity rules (`fork`, `directory`, `checksum`,
+ * `unreadable-object`) are always errors and cannot be set.
+ */
+import { YodelError } from "../project.js";
+const isRecord = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
+const LEVELS = ["error", "warning", "off"];
+/** Checks `lint` from `yodel.config.ts` against the rules there are. `where` names the file in errors. */
+export function lintSettings(raw, rules, where = "yodel.config.ts") {
+    const levels = {};
+    if (raw === undefined)
+        return { levels };
+    for (const k of Object.keys(raw))
+        if (k !== "rules")
+            throw new YodelError(`${where}: lint.${k}: unknown setting (expected rules)`);
+    if (raw.rules === undefined)
+        return { levels };
+    if (!isRecord(raw.rules))
+        throw new YodelError(`${where}: lint.rules: expected an object of rule: "error" | "warning" | "off"`);
+    for (const [id, level] of Object.entries(raw.rules)) {
+        const rule = rules[id];
+        if (!rule)
+            throw new YodelError(`${where}: lint.rules.${id}: no such rule (the rules: ${Object.keys(rules).join(", ")})`);
+        if (typeof level !== "string" || !LEVELS.includes(level))
+            throw new YodelError(`${where}: lint.rules.${id}: expected "error", "warning" or "off"`);
+        if (!rule.configurable && level !== "error")
+            throw new YodelError(`${where}: lint.rules.${id}: ${id} is an integrity rule and is always an error`);
+        levels[id] = level;
+    }
+    return { levels };
+}
+/** The level a rule runs at. */
+export const levelOf = (rule, settings) => settings?.levels[rule.id] ?? rule.level;
+//# sourceMappingURL=config.js.map

package/dist/lint/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/lint/config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAO3C,MAAM,QAAQ,GAAG,CAAC,CAAU,EAAgC,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACxH,MAAM,MAAM,GAAsB,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;AAE9D,0GAA0G;AAC1G,MAAM,UAAU,YAAY,CAAC,GAAwC,EAAE,KAAyC,EAAE,KAAK,GAAG,iBAAiB;IACzI,MAAM,MAAM,GAAiC,EAAE,CAAC;IAChD,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IACzC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,IAAI,CAAC,KAAK,OAAO;YAAE,MAAM,IAAI,UAAU,CAAC,GAAG,KAAK,UAAU,CAAC,oCAAoC,CAAC,CAAC;IACnI,IAAI,GAAG,CAAC,KAAK,KAAK,SAAS;QAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAC/C,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,UAAU,CAAC,GAAG,KAAK,uEAAuE,CAAC,CAAC;IAChI,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;QACvB,IAAI,CAAC,IAAI;YAAE,MAAM,IAAI,UAAU,CAAC,GAAG,KAAK,gBAAgB,EAAE,8BAA8B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1H,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,UAAU,CAAC,GAAG,KAAK,gBAAgB,EAAE,wCAAwC,CAAC,CAAC;QACnJ,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,KAAK,KAAK,OAAO;YAAE,MAAM,IAAI,UAAU,CAAC,GAAG,KAAK,gBAAgB,EAAE,KAAK,EAAE,8CAA8C,CAAC,CAAC;QACnJ,MAAM,CAAC,EAAE,CAAC,GAAG,KAAqB,CAAC;IACrC,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,CAAC;AACpB,CAAC;AAED,gCAAgC;AAChC,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAc,EAAE,QAAkC,EAAgB,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC"}

package/dist/lint/index.d.ts

@@ -0,0 +1,31 @@
+/**
+ * `yodel lint` (#14): rules over a migrations directory, free, for CI.
+ *
+ *   lintMigrations(dir, options)   every finding, with levels and silences applied
+ *   migrationSilences(m)           a migration's `-- yodel:allow` lines, as the history records them
+ *   updateChecksum(m)              writes migration.json's checksum to match its files
+ *   renderLint / lintJson          the output; lintExitCode the exit code
+ *
+ * The rules are in `./rules.ts`, how a silence is read in `./silences.ts`.
+ */
+import { type Migration } from "../migrations/index.js";
+import { type Silence } from "./silences.js";
+export * from "./check.js";
+export * from "./config.js";
+export * from "./report.js";
+export * from "./rules.js";
+export * from "./silences.js";
+export * from "./statements.js";
+/** The well-formed `-- yodel:allow` lines of a migration, each with the step it is above. */
+export declare function silencesOf(m: Pick<Migration, "files" | "document">): Silence[];
+/** {@link silencesOf} as the history's `silences` field holds it: a JSON array of `{ step, rule, reason }`. */
+export declare const migrationSilences: (m: Pick<Migration, "files" | "document">) => string;
+/**
+ * Writes `migration.json` again with its `checksum` matching the files, for
+ * a migration edited before it was applied anywhere (a silence added, say).
+ * Returns the old and new checksum, or `undefined` when they already match.
+ */
+export declare function updateChecksum(m: Migration): {
+    from: string;
+    to: string;
+} | undefined;

package/dist/lint/index.js

@@ -0,0 +1,43 @@
+/**
+ * `yodel lint` (#14): rules over a migrations directory, free, for CI.
+ *
+ *   lintMigrations(dir, options)   every finding, with levels and silences applied
+ *   migrationSilences(m)           a migration's `-- yodel:allow` lines, as the history records them
+ *   updateChecksum(m)              writes migration.json's checksum to match its files
+ *   renderLint / lintJson          the output; lintExitCode the exit code
+ *
+ * The rules are in `./rules.ts`, how a silence is read in `./silences.ts`.
+ */
+import { renameSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import { MIGRATION_JSON, serializeDocument, verifyChecksum } from "../migrations/index.js";
+import { silenceableRules } from "./rules.js";
+import { mapMigrationSql, silencesJson } from "./silences.js";
+export * from "./check.js";
+export * from "./config.js";
+export * from "./report.js";
+export * from "./rules.js";
+export * from "./silences.js";
+export * from "./statements.js";
+/** The well-formed `-- yodel:allow` lines of a migration, each with the step it is above. */
+export function silencesOf(m) {
+    return mapMigrationSql(m.files.sql, m.document.steps, new Set(silenceableRules())).silences;
+}
+/** {@link silencesOf} as the history's `silences` field holds it: a JSON array of `{ step, rule, reason }`. */
+export const migrationSilences = (m) => silencesJson(silencesOf(m));
+/**
+ * Writes `migration.json` again with its `checksum` matching the files, for
+ * a migration edited before it was applied anywhere (a silence added, say).
+ * Returns the old and new checksum, or `undefined` when they already match.
+ */
+export function updateChecksum(m) {
+    const check = verifyChecksum(m);
+    if (check.ok)
+        return undefined;
+    const path = join(m.dir, MIGRATION_JSON);
+    const tmp = join(m.dir, `.${MIGRATION_JSON}.updating`);
+    writeFileSync(tmp, serializeDocument({ ...JSON.parse(m.files.json), checksum: check.actual }));
+    renameSync(tmp, path);
+    return { from: check.recorded, to: check.actual };
+}
+//# sourceMappingURL=index.js.map

package/dist/lint/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lint/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,cAAc,EAAkB,MAAM,wBAAwB,CAAC;AAC3G,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,YAAY,EAAgB,MAAM,eAAe,CAAC;AAE5E,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAEhC,6FAA6F;AAC7F,MAAM,UAAU,UAAU,CAAC,CAAwC;IACjE,OAAO,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,GAAG,CAAS,gBAAgB,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;AACtG,CAAC;AAED,+GAA+G;AAC/G,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAwC,EAAU,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAEnH;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,CAAY;IACzC,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;IAChC,IAAI,KAAK,CAAC,EAAE;QAAE,OAAO,SAAS,CAAC;IAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IACzC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,cAAc,WAAW,CAAC,CAAC;IACvD,aAAa,CAAC,GAAG,EAAE,iBAAiB,CAAC,EAAE,GAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAA6B,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5H,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACtB,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;AACpD,CAAC"}

package/dist/lint/project-rules.d.ts

@@ -0,0 +1,19 @@
+/**
+ * The project-wide rules `yodel lint` runs after its own: rules that need
+ * more than the migrations directory, such as a server or the emulator.
+ *
+ * {@link projectRules} run on every lint. The replay check (#11,
+ * `../replay/`) runs only with `yodel lint --replay <env>`, because it needs
+ * a throwaway server: the command replays the history first (so a target
+ * that is not fresh refuses with the replay's own exit code, 4) and hands
+ * the result to {@link replayRule}, which turns a failure into a finding of
+ * rule `replay`. Its level comes from `yodel.config.ts` (`lint.rules.replay`)
+ * like a built-in rule's.
+ */
+import { type ReplayResult } from "../replay/index.js";
+import type { ProjectRule } from "./check.js";
+import type { LintRule } from "./rules.js";
+export declare const projectRules: readonly ProjectRule[];
+export declare const REPLAY_RULE: LintRule;
+/** The replay's result as a rule: one finding naming the first migration that fails, or none. */
+export declare function replayRule(result: ReplayResult): ProjectRule;

package/dist/lint/project-rules.js

@@ -0,0 +1,32 @@
+/**
+ * The project-wide rules `yodel lint` runs after its own: rules that need
+ * more than the migrations directory, such as a server or the emulator.
+ *
+ * {@link projectRules} run on every lint. The replay check (#11,
+ * `../replay/`) runs only with `yodel lint --replay <env>`, because it needs
+ * a throwaway server: the command replays the history first (so a target
+ * that is not fresh refuses with the replay's own exit code, 4) and hands
+ * the result to {@link replayRule}, which turns a failure into a finding of
+ * rule `replay`. Its level comes from `yodel.config.ts` (`lint.rules.replay`)
+ * like a built-in rule's.
+ */
+import { replayFailure } from "../replay/index.js";
+export const projectRules = [];
+export const REPLAY_RULE = {
+    id: "replay",
+    summary: "with --replay <env>: the history, replayed into a fresh database, does not give each migration's recorded schema",
+    level: "error",
+    silenceable: false,
+    configurable: true,
+};
+/** The replay's result as a rule: one finding naming the first migration that fails, or none. */
+export function replayRule(result) {
+    return {
+        rule: REPLAY_RULE,
+        check: () => {
+            const failure = replayFailure(result);
+            return Promise.resolve(failure ? [{ rule: REPLAY_RULE.id, migration: failure.migration, message: failure.message }] : []);
+        },
+    };
+}
+//# sourceMappingURL=project-rules.js.map

package/dist/lint/project-rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-rules.js","sourceRoot":"","sources":["../../src/lint/project-rules.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,aAAa,EAAqB,MAAM,oBAAoB,CAAC;AAItE,MAAM,CAAC,MAAM,YAAY,GAA2B,EAAE,CAAC;AAEvD,MAAM,CAAC,MAAM,WAAW,GAAa;IACnC,EAAE,EAAE,QAAQ;IACZ,OAAO,EAAE,kHAAkH;IAC3H,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,KAAK;IAClB,YAAY,EAAE,IAAI;CACnB,CAAC;AAEF,iGAAiG;AACjG,MAAM,UAAU,UAAU,CAAC,MAAoB;IAC7C,OAAO;QACL,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,GAAG,EAAE;YACV,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;YACtC,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC5H,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/lint/report.d.ts

@@ -0,0 +1,7 @@
+/** `yodel lint`'s output: text for people, JSON for a CI job, and the exit code. */
+import type { LintReport } from "./check.js";
+/** Exit code: at least one finding at level error that no silence covers. */
+export declare const LINT_FAILED = 3;
+export declare const lintExitCode: (report: LintReport) => number;
+export declare function renderLint(report: LintReport): string;
+export declare function lintJson(report: LintReport): Record<string, unknown>;

package/dist/lint/report.js

@@ -0,0 +1,48 @@
+/** `yodel lint`'s output: text for people, JSON for a CI job, and the exit code. */
+/** Exit code: at least one finding at level error that no silence covers. */
+export const LINT_FAILED = 3;
+export const lintExitCode = (report) => (report.errors > 0 ? LINT_FAILED : 0);
+const plural = (n, one, many = `${one}s`) => `${String(n)} ${n === 1 ? one : many}`;
+function line(f) {
+    const head = f.silenced !== undefined ? "silenced" : f.level;
+    const out = [`  ${head.padEnd(8)} ${f.rule}: ${f.message}`];
+    if (f.silenced !== undefined)
+        out.push(`           reason: ${f.silenced}`);
+    return out;
+}
+export function renderLint(report) {
+    const where = report.environment ? `, against ${report.environment}'s history` : "";
+    const out = [];
+    const groups = new Map();
+    for (const f of report.findings) {
+        const key = f.migration ?? "";
+        groups.set(key, [...(groups.get(key) ?? []), f]);
+    }
+    for (const [id, list] of groups) {
+        out.push(id === "" ? "migrations/" : id);
+        for (const f of list)
+            out.push(...line(f));
+        out.push("");
+    }
+    const silenceHint = report.findings.some((f) => f.silenced === undefined && f.level === "error" && ["destructive", "pg-rewrite", "pg-lock", "ch-mutation", "ch-rebuild"].includes(f.rule));
+    if (silenceHint) {
+        out.push("A statement rule can be silenced for one statement, with a reason the history records when it applies:", "  a line `-- yodel:allow <rule> <reason>` above the statement in migration.sql", "");
+    }
+    const counts = [plural(report.errors, "error"), plural(report.warnings, "warning"), `${String(report.silenced)} silenced`].join(", ");
+    out.push(`${plural(report.migrations.length, "migration")}${where}: ${counts}.`);
+    return `${out.join("\n")}\n`;
+}
+export function lintJson(report) {
+    return {
+        status: report.errors > 0 ? "failed" : "passed",
+        ...(report.environment ? { environment: report.environment } : {}),
+        dialect: report.dialect ?? null,
+        migrations: report.migrations,
+        errors: report.errors,
+        warnings: report.warnings,
+        silenced: report.silenced,
+        findings: report.findings,
+        silences: report.silences,
+    };
+}
+//# sourceMappingURL=report.js.map

package/dist/lint/report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../../src/lint/report.ts"],"names":[],"mappings":"AAAA,oFAAoF;AAIpF,6EAA6E;AAC7E,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC;AAE7B,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAkB,EAAU,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAElG,MAAM,MAAM,GAAG,CAAC,CAAS,EAAE,GAAW,EAAE,IAAI,GAAG,GAAG,GAAG,GAAG,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAEpG,SAAS,IAAI,CAAC,CAAU;IACtB,MAAM,IAAI,GAAG,CAAC,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC7D,MAAM,GAAG,GAAG,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5D,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS;QAAE,GAAG,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3E,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAkB;IAC3C,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,MAAM,CAAC,WAAW,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;IACpF,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,MAAM,MAAM,GAAG,IAAI,GAAG,EAAqB,CAAC;IAC5C,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QAChC,MAAM,GAAG,GAAG,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC;QAC9B,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACnD,CAAC;IACD,KAAK,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,MAAM,EAAE,CAAC;QAChC,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACzC,KAAK,MAAM,CAAC,IAAI,IAAI;YAAE,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,CAAC;IACD,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,KAAK,OAAO,IAAI,CAAC,aAAa,EAAE,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3L,IAAI,WAAW,EAAE,CAAC;QAChB,GAAG,CAAC,IAAI,CAAC,wGAAwG,EAAE,gFAAgF,EAAE,EAAE,CAAC,CAAC;IAC3M,CAAC;IACD,MAAM,MAAM,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtI,GAAG,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,KAAK,KAAK,MAAM,GAAG,CAAC,CAAC;IACjF,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAkB;IACzC,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ;QAC/C,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClE,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,IAAI;QAC/B,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;KAC1B,CAAC;AACJ,CAAC"}

package/dist/lint/rules.d.ts

@@ -0,0 +1,53 @@
+/**
+ * `yodel lint`'s rules: what each checks, its level unless `yodel.config.ts`
+ * sets another, and whether a statement can silence it.
+ *
+ * Two kinds:
+ *
+ * - Integrity rules, over the directory and each migration as a whole:
+ *   `fork`, `directory`, `checksum`, `unreadable-object`. Always errors; no
+ *   config lowers them and nothing silences them, because a migration that
+ *   breaks one cannot be applied safely or cannot be checked at all.
+ * - Statement rules, from the classes chant's classifier gives each step:
+ *   `destructive`, `pg-rewrite`, `pg-lock`, `ch-mutation`, `ch-rebuild`.
+ *   Errors by default; a line `-- yodel:allow <rule> <reason>` above the
+ *   statement in `migration.sql` silences one for that statement, and the
+ *   reason is recorded in the history when the migration applies.
+ *
+ * The rest (`refused-step`, `migration-sql`, `silence`) say a migration
+ * will not apply as written or a silence is wrong. Their level can be
+ * changed in `yodel.config.ts`, but they cannot be silenced.
+ */
+export type LintLevel = "error" | "warning";
+export type LevelSetting = LintLevel | "off";
+export interface LintRule {
+    id: string;
+    /** One line, for `yodel lint --rules` and the docs. */
+    summary: string;
+    level: LintLevel;
+    /** A `-- yodel:allow <id> <reason>` line can silence it for one statement. */
+    silenceable: boolean;
+    /** `yodel.config.ts` `lint.rules` may change its level. */
+    configurable: boolean;
+    /** The dialect it applies to; both when absent. */
+    dialect?: "clickhouse" | "postgres";
+}
+export declare const LINT_RULES: {
+    readonly fork: LintRule;
+    readonly directory: LintRule;
+    readonly checksum: LintRule;
+    readonly "unreadable-object": LintRule;
+    readonly destructive: LintRule;
+    readonly "pg-rewrite": LintRule;
+    readonly "pg-lock": LintRule;
+    readonly "ch-mutation": LintRule;
+    readonly "ch-rebuild": LintRule;
+    readonly "refused-step": LintRule;
+    readonly "migration-sql": LintRule;
+    readonly silence: LintRule;
+};
+export type LintRuleId = keyof typeof LINT_RULES;
+export declare const ruleIds: LintRuleId[];
+export declare const isRuleId: (id: string) => id is LintRuleId;
+/** The rules a `-- yodel:allow` line can name. */
+export declare const silenceableRules: () => LintRuleId[];

package/dist/lint/rules.js

@@ -0,0 +1,42 @@
+/**
+ * `yodel lint`'s rules: what each checks, its level unless `yodel.config.ts`
+ * sets another, and whether a statement can silence it.
+ *
+ * Two kinds:
+ *
+ * - Integrity rules, over the directory and each migration as a whole:
+ *   `fork`, `directory`, `checksum`, `unreadable-object`. Always errors; no
+ *   config lowers them and nothing silences them, because a migration that
+ *   breaks one cannot be applied safely or cannot be checked at all.
+ * - Statement rules, from the classes chant's classifier gives each step:
+ *   `destructive`, `pg-rewrite`, `pg-lock`, `ch-mutation`, `ch-rebuild`.
+ *   Errors by default; a line `-- yodel:allow <rule> <reason>` above the
+ *   statement in `migration.sql` silences one for that statement, and the
+ *   reason is recorded in the history when the migration applies.
+ *
+ * The rest (`refused-step`, `migration-sql`, `silence`) say a migration
+ * will not apply as written or a silence is wrong. Their level can be
+ * changed in `yodel.config.ts`, but they cannot be silenced.
+ */
+const integrity = (id, summary) => ({ id, summary, level: "error", silenceable: false, configurable: false });
+const statement = (id, summary, dialect) => ({ id, summary, level: "error", silenceable: true, configurable: true, ...(dialect ? { dialect } : {}) });
+const shape = (id, summary, level = "error") => ({ id, summary, level, silenceable: false, configurable: true });
+export const LINT_RULES = {
+    fork: integrity("fork", "two migrations follow the same parent; rebase one onto the other (yodel rebase)"),
+    directory: integrity("directory", "the migrations directory is not one readable chain: a bad name or file, a missing parent, a cycle, another dialect"),
+    checksum: integrity("checksum", "a migration's files no longer hash to its checksum: an edit after it was written, or (with --env) after it was applied"),
+    "unreadable-object": integrity("unreadable-object", "an object in a recorded schema, or a step, the sql lexicon cannot read or classify; never skipped"),
+    destructive: statement("destructive", "a statement or Op step removes data that cannot be recovered (a table or column drop)"),
+    "pg-rewrite": statement("pg-rewrite", "Postgres: rewrites or scans the whole table under ACCESS EXCLUSIVE, blocking reads and writes while it runs", "postgres"),
+    "pg-lock": statement("pg-lock", "Postgres: holds a lock that blocks writes for a whole scan or index build (an index without CONCURRENTLY, a constraint validated in place)", "postgres"),
+    "ch-mutation": statement("ch-mutation", "ClickHouse: starts a mutation that rewrites existing parts in the background, with no rollback", "clickhouse"),
+    "ch-rebuild": statement("ch-rebuild", "ClickHouse: a rebuild, every row copied into a new table and swapped in (ClickHouseRebuildOp)", "clickhouse"),
+    "refused-step": shape("refused-step", "a step yodel apply refuses to run: a manual step, or an Op step it does not run"),
+    "migration-sql": shape("migration-sql", "migration.sql does not hold a statement as migration.json records it; apply runs migration.json's"),
+    silence: shape("silence", "a yodel:allow line that is malformed, names a rule no statement can silence, has no reason, or silences nothing"),
+};
+export const ruleIds = Object.keys(LINT_RULES);
+export const isRuleId = (id) => Object.hasOwn(LINT_RULES, id);
+/** The rules a `-- yodel:allow` line can name. */
+export const silenceableRules = () => ruleIds.filter((id) => LINT_RULES[id].silenceable);
+//# sourceMappingURL=rules.js.map

package/dist/lint/rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rules.js","sourceRoot":"","sources":["../../src/lint/rules.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAkBH,MAAM,SAAS,GAAG,CAAC,EAAU,EAAE,OAAe,EAAY,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;AACxI,MAAM,SAAS,GAAG,CAAC,EAAU,EAAE,OAAe,EAAE,OAA6B,EAAY,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;AACtM,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,OAAe,EAAE,QAAmB,OAAO,EAAY,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;AAEtJ,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,iFAAiF,CAAC;IAC1G,SAAS,EAAE,SAAS,CAAC,WAAW,EAAE,oHAAoH,CAAC;IACvJ,QAAQ,EAAE,SAAS,CAAC,UAAU,EAAE,wHAAwH,CAAC;IACzJ,mBAAmB,EAAE,SAAS,CAAC,mBAAmB,EAAE,mGAAmG,CAAC;IACxJ,WAAW,EAAE,SAAS,CAAC,aAAa,EAAE,uFAAuF,CAAC;IAC9H,YAAY,EAAE,SAAS,CAAC,YAAY,EAAE,6GAA6G,EAAE,UAAU,CAAC;IAChK,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,4IAA4I,EAAE,UAAU,CAAC;IACzL,aAAa,EAAE,SAAS,CAAC,aAAa,EAAE,gGAAgG,EAAE,YAAY,CAAC;IACvJ,YAAY,EAAE,SAAS,CAAC,YAAY,EAAE,+FAA+F,EAAE,YAAY,CAAC;IACpJ,cAAc,EAAE,KAAK,CAAC,cAAc,EAAE,iFAAiF,CAAC;IACxH,eAAe,EAAE,KAAK,CAAC,eAAe,EAAE,mGAAmG,CAAC;IAC5I,OAAO,EAAE,KAAK,CAAC,SAAS,EAAE,iHAAiH,CAAC;CACjG,CAAC;AAI9C,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAiB,CAAC;AAE/D,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAoB,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;AAExF,kDAAkD;AAClD,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAiB,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC"}