@intentius/sql-yodeler 0.0.0-stage → 0.2.0

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"}

package/dist/lint/silences.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Silences: a line in `migration.sql`, above the statement it is for,
+ *
+ *     -- yodel:allow <rule> <reason>
+ *
+ * silences that statement rule for that one step. The reason is required
+ * and is recorded, with the rule and the step, in every history row the
+ * migration writes when it applies (the `silences` column), so the history
+ * says who accepted what and why. Because `migration.sql` is in the
+ * migration's checksum, a silence is part of what an approval covers.
+ *
+ * Which step a line is "above": `migration.sql` holds each step in the
+ * order `migration.json` lists them, a statement as its SQL followed by
+ * `;`, an Op or manual step as a comment starting `-- <object> (<name>):`
+ * (`renderStatements`). Each step is found in that order; a silence belongs
+ * to the first step found after it. A statement `migration.sql` does not
+ * hold as `migration.json` records it is reported (`migration-sql`): apply
+ * runs `migration.json`'s, so an edit to the SQL alone changes nothing.
+ */
+import type { MigrationStep } from "@intentius/chant-lexicon-sql/migration-statements";
+/** One `-- yodel:allow` line, read. */
+export interface Silence {
+    /** The step it is above, an index into `migration.json`'s `steps`. */
+    step: number;
+    rule: string;
+    reason: string;
+    /** Its line in migration.sql, from 1. */
+    line: number;
+}
+/** What was wrong with a migration.sql. */
+export interface SqlProblem {
+    rule: "migration-sql" | "silence";
+    message: string;
+    step?: number;
+    line?: number;
+}
+export interface SqlMap {
+    silences: Silence[];
+    problems: SqlProblem[];
+}
+/**
+ * Reads the silences in `sql` and assigns each to its step. `known` is the
+ * set of rule ids a silence may name. Problems: a silence that is
+ * malformed, names an unknown rule or one that cannot be silenced, has no
+ * reason, or follows the last step; a step migration.sql does not hold.
+ */
+export declare function mapMigrationSql(sql: string, steps: readonly MigrationStep[], silenceable: ReadonlySet<string>): SqlMap;
+/** The silences as the history's `silences` field holds them: JSON, `[{"step":0,"rule":"...","reason":"..."}]`. */
+export declare const silencesJson: (silences: readonly Silence[]) => string;

package/dist/lint/silences.js

@@ -0,0 +1,91 @@
+/**
+ * Silences: a line in `migration.sql`, above the statement it is for,
+ *
+ *     -- yodel:allow <rule> <reason>
+ *
+ * silences that statement rule for that one step. The reason is required
+ * and is recorded, with the rule and the step, in every history row the
+ * migration writes when it applies (the `silences` column), so the history
+ * says who accepted what and why. Because `migration.sql` is in the
+ * migration's checksum, a silence is part of what an approval covers.
+ *
+ * Which step a line is "above": `migration.sql` holds each step in the
+ * order `migration.json` lists them, a statement as its SQL followed by
+ * `;`, an Op or manual step as a comment starting `-- <object> (<name>):`
+ * (`renderStatements`). Each step is found in that order; a silence belongs
+ * to the first step found after it. A statement `migration.sql` does not
+ * hold as `migration.json` records it is reported (`migration-sql`): apply
+ * runs `migration.json`'s, so an edit to the SQL alone changes nothing.
+ */
+import { normalizeLineEndings } from "../migrations/document.js";
+const DIRECTIVE = /yodel:\s*allow\b/i;
+const SILENCE = /^\s*--\s*yodel:allow(?:\s+(\S+))?(?:\s+(.*?))?\s*$/;
+/** The text that marks a step in migration.sql. */
+function anchorOf(step) {
+    return step.kind === "statement" ? `${step.sql};` : `-- ${step.object} (${step.name}):`;
+}
+const describe = (step, i) => `step ${String(i)} (${step.kind === "statement" ? `${step.rule} ${step.class}` : step.kind}, ${step.name})`;
+/**
+ * Reads the silences in `sql` and assigns each to its step. `known` is the
+ * set of rule ids a silence may name. Problems: a silence that is
+ * malformed, names an unknown rule or one that cannot be silenced, has no
+ * reason, or follows the last step; a step migration.sql does not hold.
+ */
+export function mapMigrationSql(sql, steps, silenceable) {
+    const text = normalizeLineEndings(sql);
+    const lineAt = (offset) => text.slice(0, offset).split("\n").length;
+    const out = { silences: [], problems: [] };
+    const readRegion = (from, to, step) => {
+        const region = text.slice(from, to);
+        let offset = from;
+        for (const raw of region.split("\n")) {
+            const line = lineAt(offset);
+            offset += raw.length + 1;
+            if (!DIRECTIVE.test(raw) || !raw.trimStart().startsWith("--"))
+                continue;
+            const m = SILENCE.exec(raw);
+            const rule = m?.[1];
+            const reason = m?.[2]?.trim() ?? "";
+            if (!m || rule === undefined) {
+                out.problems.push({ rule: "silence", line, message: `migration.sql line ${String(line)}: expected -- yodel:allow <rule> <reason>` });
+                continue;
+            }
+            if (!silenceable.has(rule)) {
+                out.problems.push({ rule: "silence", line, message: `migration.sql line ${String(line)}: ${rule} is not a rule a statement can silence (${[...silenceable].join(", ")})` });
+                continue;
+            }
+            if (reason === "") {
+                out.problems.push({ rule: "silence", line, message: `migration.sql line ${String(line)}: silencing ${rule} needs a reason: -- yodel:allow ${rule} <why this is safe>` });
+                continue;
+            }
+            if (step === undefined) {
+                out.problems.push({ rule: "silence", line, message: `migration.sql line ${String(line)}: yodel:allow ${rule} comes after the last step, so it silences nothing; put it above the statement` });
+                continue;
+            }
+            out.silences.push({ step, rule, reason, line });
+        }
+    };
+    let cursor = 0;
+    steps.forEach((step, i) => {
+        const anchor = anchorOf(step);
+        const at = text.indexOf(anchor, cursor);
+        if (at === -1) {
+            if (step.kind === "statement") {
+                out.problems.push({
+                    rule: "migration-sql",
+                    step: i,
+                    message: `${describe(step, i)}: migration.sql does not hold its statement as migration.json records it (${step.sql.split("\n")[0] ?? ""}); yodel apply runs migration.json's`,
+                });
+            }
+            // An Op or manual step's comment is for people; a missing one moves nothing.
+            return;
+        }
+        readRegion(cursor, at, i);
+        cursor = at + anchor.length;
+    });
+    readRegion(cursor, text.length, undefined);
+    return out;
+}
+/** The silences as the history's `silences` field holds them: JSON, `[{"step":0,"rule":"...","reason":"..."}]`. */
+export const silencesJson = (silences) => JSON.stringify(silences.map((s) => ({ step: s.step, rule: s.rule, reason: s.reason })));
+//# sourceMappingURL=silences.js.map

package/dist/lint/silences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"silences.js","sourceRoot":"","sources":["../../src/lint/silences.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAGH,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAyBjE,MAAM,SAAS,GAAG,mBAAmB,CAAC;AACtC,MAAM,OAAO,GAAG,oDAAoD,CAAC;AAErE,mDAAmD;AACnD,SAAS,QAAQ,CAAC,IAAmB;IACnC,OAAO,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,IAAI,CAAC;AAC1F,CAAC;AAED,MAAM,QAAQ,GAAG,CAAC,IAAmB,EAAE,CAAS,EAAE,EAAE,CAAC,QAAQ,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,GAAG,CAAC;AAEjK;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,GAAW,EAAE,KAA+B,EAAE,WAAgC;IAC5G,MAAM,IAAI,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;IAC5E,MAAM,GAAG,GAAW,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAEnD,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAU,EAAE,IAAwB,EAAE,EAAE;QACxE,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpC,IAAI,MAAM,GAAG,IAAI,CAAC;QAClB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;YAC5B,MAAM,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;YACzB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC;gBAAE,SAAS;YACxE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC5B,MAAM,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACpB,MAAM,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YACpC,IAAI,CAAC,CAAC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC7B,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,sBAAsB,MAAM,CAAC,IAAI,CAAC,2CAA2C,EAAE,CAAC,CAAC;gBACrI,SAAS;YACX,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC3B,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,sBAAsB,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,2CAA2C,CAAC,GAAG,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;gBAC5K,SAAS;YACX,CAAC;YACD,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;gBAClB,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,sBAAsB,MAAM,CAAC,IAAI,CAAC,eAAe,IAAI,mCAAmC,IAAI,qBAAqB,EAAE,CAAC,CAAC;gBACzK,SAAS;YACX,CAAC;YACD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,sBAAsB,MAAM,CAAC,IAAI,CAAC,iBAAiB,IAAI,gFAAgF,EAAE,CAAC,CAAC;gBAC/L,SAAS;YACX,CAAC;YACD,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAClD,CAAC;IACH,CAAC,CAAC;IAEF,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;QACxB,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACxC,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;YACd,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBAC9B,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;oBAChB,IAAI,EAAE,eAAe;oBACrB,IAAI,EAAE,CAAC;oBACP,OAAO,EAAE,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,6EAA6E,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,sCAAsC;iBAC9K,CAAC,CAAC;YACL,CAAC;YACD,6EAA6E;YAC7E,OAAO;QACT,CAAC;QACD,UAAU,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAC1B,MAAM,GAAG,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9B,CAAC,CAAC,CAAC;IACH,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC3C,OAAO,GAAG,CAAC;AACb,CAAC;AAED,mHAAmH;AACnH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,QAA4B,EAAU,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC"}

package/dist/lint/statements.d.ts

@@ -0,0 +1,38 @@
+/**
+ * The statement rules: each step of a migration against the class chant's
+ * classifier gave it (`migration.json` records the rule and class of every
+ * statement, and the changes an Op or manual step makes). Pure.
+ *
+ * - `destructive`: a statement marked destructive (a table or column drop),
+ *   or an Op step one of whose changes is.
+ * - `ch-mutation`: a ClickHouse statement of class `rewrite`, or one that
+ *   waits for its mutation (a column type or TTL change).
+ * - `ch-rebuild`: a `ClickHouseRebuildOp` step.
+ * - `pg-rewrite`: a Postgres statement of class `rewrite` (ACCESS EXCLUSIVE
+ *   for a rewrite or a full scan).
+ * - `pg-lock`: a Postgres statement that blocks writes for a whole build or
+ *   scan: an index created or dropped on an existing table without
+ *   `CONCURRENTLY` (SQLPG240 to SQLPG243), a primary key or unique
+ *   constraint built in place rather than `USING INDEX` (SQLPG221), a
+ *   foreign key or domain constraint validated in place rather than added
+ *   `NOT VALID` (SQLPG219, SQLPG262).
+ *
+ * `COMMENT ON` statements are skipped: chant writes one after a `CREATE`
+ * with the same rule, and a comment is catalog only.
+ *
+ * A statement whose rule is not one of the lexicon's, or a step of a kind
+ * it does not know, is `unreadable-object`: lint cannot tell what it does,
+ * and never passes what it cannot read.
+ */
+import type { MigrationStep } from "@intentius/chant-lexicon-sql/migration-statements";
+export type Dialect = "clickhouse" | "postgres";
+export interface StepFinding {
+    rule: string;
+    message: string;
+}
+/** What lint cannot read in a step, or `undefined`. */
+export declare function unreadableStep(dialect: Dialect, step: MigrationStep): string | undefined;
+/** The statement-rule findings for one step, before levels and silences. */
+export declare function stepFindings(dialect: Dialect, step: MigrationStep): StepFinding[];
+/** Why yodel apply refuses a step, or `undefined` for one it runs. */
+export declare function refusedStep(step: MigrationStep): string | undefined;