indexwright 0.1.0

package/dist/cli.js

@@ -0,0 +1,96 @@
+#!/usr/bin/env node
+import { appendFileSync, realpathSync } from 'node:fs';
+import process from 'node:process';
+import { pathToFileURL } from 'node:url';
+import { parseArgs, usage, UsageError } from './args.js';
+import { formatGithub } from './format/github.js';
+import { formatJson } from './format/json.js';
+import { formatText } from './format/text.js';
+import { lintFiles } from './lint.js';
+import { VERSION } from './version.js';
+/**
+ * Exit codes (SPEC §4): 0 completed, 1 warnings over the budget, 2 usage error or unusable input.
+ * A file that could not be analysed is a 2 regardless of `--max-warnings`, because the run did not
+ * cover what it was asked to cover.
+ */
+export function run(argv, streams) {
+    let command;
+    try {
+        command = parseArgs(argv);
+    }
+    catch (error) {
+        if (!(error instanceof UsageError))
+            throw error;
+        streams.err(`indexwright: ${error.message}\n\n${usage()}\n`);
+        return 2;
+    }
+    if (command.kind === 'help') {
+        streams.out(`${usage()}\n`);
+        return 0;
+    }
+    if (command.kind === 'version') {
+        streams.out(`${VERSION}\n`);
+        return 0;
+    }
+    const result = lintFiles(command.files, {
+        rules: command.rules,
+        quota: command.quota,
+        quotaThreshold: command.quotaThreshold,
+    });
+    switch (command.format) {
+        case 'json':
+            streams.out(formatJson(result));
+            break;
+        case 'github': {
+            const { commands, summary } = formatGithub(result);
+            streams.out(commands);
+            writeStepSummary(summary, streams);
+            break;
+        }
+        case 'text':
+            streams.out(formatText(result));
+            break;
+    }
+    if (result.summary.errors > 0)
+        return 2;
+    if (result.summary.warnings > command.maxWarnings)
+        return 1;
+    return 0;
+}
+function writeStepSummary(summary, streams) {
+    const target = process.env['GITHUB_STEP_SUMMARY'];
+    if (!target) {
+        streams.out(summary);
+        return;
+    }
+    try {
+        appendFileSync(target, summary);
+    }
+    catch (error) {
+        // A summary that cannot be written must not change the verdict of the lint.
+        streams.err(`indexwright: could not write GITHUB_STEP_SUMMARY: ${error.message}\n`);
+        streams.out(summary);
+    }
+}
+/**
+ * npm installs the bin as a symlink, so `process.argv[1]` is the link while `import.meta.url` is
+ * the real path. Comparing without resolving the link would leave the installed CLI doing nothing.
+ */
+function invokedDirectly() {
+    const entry = process.argv[1];
+    if (entry === undefined)
+        return false;
+    try {
+        return import.meta.url === pathToFileURL(realpathSync(entry)).href;
+    }
+    catch {
+        return false;
+    }
+}
+if (invokedDirectly()) {
+    process.exitCode = run(process.argv.slice(2), {
+        out: (text) => process.stdout.write(text),
+        err: (text) => process.stderr.write(text),
+    });
+}
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvD,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAOvC;;;;GAIG;AACH,MAAM,UAAU,GAAG,CAAC,IAAuB,EAAE,OAAgB;IAC3D,IAAI,OAAO,CAAC;IACZ,IAAI,CAAC;QACH,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,CAAC,KAAK,YAAY,UAAU,CAAC;YAAE,MAAM,KAAK,CAAC;QAChD,OAAO,CAAC,GAAG,CAAC,gBAAgB,KAAK,CAAC,OAAO,OAAO,KAAK,EAAE,IAAI,CAAC,CAAC;QAC7D,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC5B,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC,CAAC;QAC5B,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC;QAC5B,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE;QACtC,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,cAAc,EAAE,OAAO,CAAC,cAAc;KACvC,CAAC,CAAC;IAEH,QAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;QACvB,KAAK,MAAM;YACT,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YAChC,MAAM;QACR,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;YACnD,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACtB,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACnC,MAAM;QACR,CAAC;QACD,KAAK,MAAM;YACT,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YAChC,MAAM;IACV,CAAC;IAED,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,CAAC,CAAC;IACxC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,WAAW;QAAE,OAAO,CAAC,CAAC;IAC5D,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAe,EAAE,OAAgB;IACzD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACrB,OAAO;IACT,CAAC;IACD,IAAI,CAAC;QACH,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,4EAA4E;QAC5E,OAAO,CAAC,GAAG,CAAC,qDAAsD,KAAe,CAAC,OAAO,IAAI,CAAC,CAAC;QAC/F,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe;IACtB,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9B,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACtC,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,aAAa,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IACrE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,IAAI,eAAe,EAAE,EAAE,CAAC;IACtB,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;QAC5C,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;QACzC,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;KAC1C,CAAC,CAAC;AACL,CAAC"}

package/dist/collections.d.ts

@@ -0,0 +1,6 @@
+/** Small ordering and grouping helpers. Determinism is a stated requirement (SPEC §7). */
+export declare function compareStrings(a: string, b: string): number;
+/** Group while remembering first-seen order, so callers can sort explicitly rather than by luck. */
+export declare function groupBy<T>(items: Iterable<T>, keyOf: (item: T) => string): Map<string, T[]>;
+export declare function uniqueSorted(values: Iterable<string>): string[];
+//# sourceMappingURL=collections.d.ts.map

package/dist/collections.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collections.d.ts","sourceRoot":"","sources":["../src/collections.ts"],"names":[],"mappings":"AAAA,0FAA0F;AAE1F,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAI3D;AAED,oGAAoG;AACpG,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAS3F;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,CAE/D"}

package/dist/collections.js

@@ -0,0 +1,25 @@
+/** Small ordering and grouping helpers. Determinism is a stated requirement (SPEC §7). */
+export function compareStrings(a, b) {
+    if (a < b)
+        return -1;
+    if (a > b)
+        return 1;
+    return 0;
+}
+/** Group while remembering first-seen order, so callers can sort explicitly rather than by luck. */
+export function groupBy(items, keyOf) {
+    const groups = new Map();
+    for (const item of items) {
+        const key = keyOf(item);
+        const bucket = groups.get(key);
+        if (bucket)
+            bucket.push(item);
+        else
+            groups.set(key, [item]);
+    }
+    return groups;
+}
+export function uniqueSorted(values) {
+    return [...new Set(values)].sort(compareStrings);
+}
+//# sourceMappingURL=collections.js.map

package/dist/collections.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collections.js","sourceRoot":"","sources":["../src/collections.ts"],"names":[],"mappings":"AAAA,0FAA0F;AAE1F,MAAM,UAAU,cAAc,CAAC,CAAS,EAAE,CAAS;IACjD,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,CAAC,CAAC,CAAC;IACrB,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,CAAC,CAAC;IACpB,OAAO,CAAC,CAAC;AACX,CAAC;AAED,oGAAoG;AACpG,MAAM,UAAU,OAAO,CAAI,KAAkB,EAAE,KAA0B;IACvE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAe,CAAC;IACtC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QACxB,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,MAAM;YAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;YACzB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/B,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAwB;IACnD,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AACnD,CAAC"}

package/dist/format/github.d.ts

@@ -0,0 +1,13 @@
+import type { LintResult } from '../types.js';
+export interface GithubOutput {
+    /** Workflow commands, for stdout: GitHub reads them from the job log. */
+    commands: string;
+    /** Markdown, for `$GITHUB_STEP_SUMMARY`. */
+    summary: string;
+}
+/**
+ * Findings are annotations without a line number: locating a finding inside the JSON would need a
+ * position-tracking parser, which v0.1.0 does not carry (SPEC §4).
+ */
+export declare function formatGithub(result: LintResult): GithubOutput;
+//# sourceMappingURL=github.d.ts.map

package/dist/format/github.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"github.d.ts","sourceRoot":"","sources":["../../src/format/github.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAW,UAAU,EAAE,MAAM,aAAa,CAAC;AAGvD,MAAM,WAAW,YAAY;IAC3B,yEAAyE;IACzE,QAAQ,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,UAAU,GAAG,YAAY,CAc7D"}

package/dist/format/github.js

@@ -0,0 +1,63 @@
+import { oneLine } from './inline.js';
+/**
+ * Findings are annotations without a line number: locating a finding inside the JSON would need a
+ * position-tracking parser, which v0.1.0 does not carry (SPEC §4).
+ */
+export function formatGithub(result) {
+    const commands = [
+        ...result.findings.map((finding) => `::warning file=${escapeProperty(finding.file)}::${escapeData(annotation(finding))}`),
+        ...result.errors.map((error) => `::error file=${escapeProperty(error.file)}::${escapeData(error.message)}`),
+    ];
+    return {
+        commands: commands.length > 0 ? `${commands.join('\n')}\n` : '',
+        summary: markdown(result),
+    };
+}
+function annotation(finding) {
+    const keys = [finding.key, ...finding.related].filter((key) => key !== null);
+    const suffix = keys.length > 0 ? ` [${keys.join(', ')}]` : '';
+    return `${finding.rule}: ${finding.message}${suffix}`;
+}
+function markdown(result) {
+    const lines = ['## indexwright', ''];
+    const { warnings, errors } = result.summary;
+    if (warnings === 0 && errors === 0) {
+        lines.push(`No findings across ${result.files.length} file(s).`, '');
+        return `${lines.join('\n')}\n`;
+    }
+    lines.push(`${warnings} warning(s)${errors > 0 ? ` and ${errors} error(s)` : ''} across ` +
+        `${result.files.length} file(s).`, '', '> Advisory only: no finding indicates that an index is unused or safe to delete.', '');
+    if (warnings > 0) {
+        lines.push('| Rule | File | Index | Detail |', '| --- | --- | --- | --- |');
+        for (const finding of result.findings) {
+            const keys = [finding.key, ...finding.related].filter((key) => key !== null);
+            const indexCell = keys.length === 0
+                ? '_whole file_'
+                : keys.map((key) => `\`${escapeCell(key)}\``).join('<br>');
+            lines.push(`| \`${finding.rule}\` | \`${escapeCell(finding.file)}\` | ${indexCell} | ${escapeCell(finding.message)} |`);
+        }
+        lines.push('');
+    }
+    if (errors > 0) {
+        lines.push('### Files that could not be analysed', '');
+        for (const error of result.errors) {
+            lines.push(`- \`${escapeCell(error.file)}\` — ${escapeCell(error.message)}`);
+        }
+        lines.push('');
+    }
+    return `${lines.join('\n')}\n`;
+}
+/**
+ * Canonical keys contain `|`, which would otherwise start a new table cell, and a value taken from
+ * a linted file may contain a newline, which would end the row entirely (see `oneLine`).
+ */
+function escapeCell(value) {
+    return oneLine(value).replaceAll('|', '\\|');
+}
+function escapeData(value) {
+    return value.replaceAll('%', '%25').replaceAll('\r', '%0D').replaceAll('\n', '%0A');
+}
+function escapeProperty(value) {
+    return escapeData(value).replaceAll(':', '%3A').replaceAll(',', '%2C');
+}
+//# sourceMappingURL=github.js.map

package/dist/format/github.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"github.js","sourceRoot":"","sources":["../../src/format/github.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAStC;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,MAAkB;IAC7C,MAAM,QAAQ,GAAG;QACf,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CACpB,CAAC,OAAO,EAAE,EAAE,CAAC,kBAAkB,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,CAClG;QACD,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAClB,CAAC,KAAK,EAAE,EAAE,CAAC,gBAAgB,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CACtF;KACF,CAAC;IAEF,OAAO;QACL,QAAQ,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;QAC/D,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC;KAC1B,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,OAAgB;IAClC,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAiB,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC;IAC5F,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9D,OAAO,GAAG,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,OAAO,GAAG,MAAM,EAAE,CAAC;AACxD,CAAC;AAED,SAAS,QAAQ,CAAC,MAAkB;IAClC,MAAM,KAAK,GAAG,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;IACrC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;IAE5C,IAAI,QAAQ,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,sBAAsB,MAAM,CAAC,KAAK,CAAC,MAAM,WAAW,EAAE,EAAE,CAAC,CAAC;QACrE,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,IAAI,CACR,GAAG,QAAQ,cAAc,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,MAAM,WAAW,CAAC,CAAC,CAAC,EAAE,UAAU;QAC5E,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,WAAW,EACnC,EAAE,EACF,kFAAkF,EAClF,EAAE,CACH,CAAC;IAEF,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QACjB,KAAK,CAAC,IAAI,CAAC,kCAAkC,EAAE,2BAA2B,CAAC,CAAC;QAC5E,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACtC,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAiB,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC;YAC5F,MAAM,SAAS,GACb,IAAI,CAAC,MAAM,KAAK,CAAC;gBACf,CAAC,CAAC,cAAc;gBAChB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC/D,KAAK,CAAC,IAAI,CACR,OAAO,OAAO,CAAC,IAAI,UAAU,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,SAAS,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAC5G,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,CAAC,CAAC;QACvD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClC,KAAK,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC/E,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU,CAAC,KAAa;IAC/B,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,UAAU,CAAC,KAAa;IAC/B,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACtF,CAAC;AAED,SAAS,cAAc,CAAC,KAAa;IACnC,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACzE,CAAC"}

package/dist/format/inline.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Values read from a linted file — a `collectionGroup`, a `fieldPath`, a direction — may hold any
+ * character JSON allows, including a newline, because §4 refuses only what cannot be read as an
+ * index declaration at all. `text` renders one finding per line and `github` renders one finding
+ * per table row, so a newline in a linted file would otherwise break out of the row and forge a
+ * heading or a table of its own in a report the reader is meant to trust.
+ *
+ * `json` deliberately does not use this: there the value is the contract, and JSON escapes it.
+ */
+export declare function oneLine(value: string): string;
+//# sourceMappingURL=inline.d.ts.map

package/dist/format/inline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inline.d.ts","sourceRoot":"","sources":["../../src/format/inline.ts"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE7C"}

package/dist/format/inline.js

@@ -0,0 +1,15 @@
+/** Control characters: everything below the space, plus DEL. */
+const CONTROL = /[\u0000-\u001f\u007f]+/gu;
+/**
+ * Values read from a linted file — a `collectionGroup`, a `fieldPath`, a direction — may hold any
+ * character JSON allows, including a newline, because §4 refuses only what cannot be read as an
+ * index declaration at all. `text` renders one finding per line and `github` renders one finding
+ * per table row, so a newline in a linted file would otherwise break out of the row and forge a
+ * heading or a table of its own in a report the reader is meant to trust.
+ *
+ * `json` deliberately does not use this: there the value is the contract, and JSON escapes it.
+ */
+export function oneLine(value) {
+    return value.replaceAll(CONTROL, ' ');
+}
+//# sourceMappingURL=inline.js.map

package/dist/format/inline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inline.js","sourceRoot":"","sources":["../../src/format/inline.ts"],"names":[],"mappings":"AAAA,gEAAgE;AAChE,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAE3C;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO,CAAC,KAAa;IACnC,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACxC,CAAC"}

package/dist/format/json.d.ts

@@ -0,0 +1,7 @@
+import type { LintResult } from '../types.js';
+/**
+ * The stable machine-readable contract (SPEC §6). Field order here is the order in the spec, so a
+ * diff of two runs reads the same way the spec does.
+ */
+export declare function formatJson(result: LintResult): string;
+//# sourceMappingURL=json.d.ts.map

package/dist/format/json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../../src/format/json.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C;;;GAGG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAmBrD"}

package/dist/format/json.js

@@ -0,0 +1,25 @@
+/**
+ * The stable machine-readable contract (SPEC §6). Field order here is the order in the spec, so a
+ * diff of two runs reads the same way the spec does.
+ */
+export function formatJson(result) {
+    const ordered = {
+        version: result.version,
+        files: result.files,
+        summary: {
+            warnings: result.summary.warnings,
+            errors: result.summary.errors,
+            byRule: result.summary.byRule,
+        },
+        findings: result.findings.map((finding) => ({
+            rule: finding.rule,
+            file: finding.file,
+            key: finding.key,
+            message: finding.message,
+            related: finding.related,
+        })),
+        errors: result.errors.map((error) => ({ file: error.file, message: error.message })),
+    };
+    return `${JSON.stringify(ordered, null, 2)}\n`;
+}
+//# sourceMappingURL=json.js.map

package/dist/format/json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.js","sourceRoot":"","sources":["../../src/format/json.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,MAAkB;IAC3C,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,OAAO,EAAE;YACP,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ;YACjC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM;YAC7B,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM;SAC9B;QACD,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAC1C,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAC;QACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;KACrF,CAAC;IACF,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;AACjD,CAAC"}

package/dist/format/text.d.ts

@@ -0,0 +1,3 @@
+import type { LintResult } from '../types.js';
+export declare function formatText(result: LintResult): string;
+//# sourceMappingURL=text.d.ts.map

package/dist/format/text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../src/format/text.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAW,UAAU,EAAU,MAAM,aAAa,CAAC;AAU/D,wBAAgB,UAAU,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CA6BrD"}

package/dist/format/text.js

@@ -0,0 +1,65 @@
+import { getRule } from '../rules/index.js';
+import { RULE_IDS } from '../types.js';
+import { oneLine } from './inline.js';
+/**
+ * No finding may read as authorisation to delete an index (SPEC §2), so the summary says so
+ * outright rather than leaving the reader to infer it.
+ */
+const DISCLAIMER = 'Advisory only: no finding indicates that an index is unused or safe to delete.';
+export function formatText(result) {
+    const lines = [];
+    for (const [rule, findings] of groupByRule(result.findings)) {
+        lines.push(`${rule}  ${getRule(rule).description}`);
+        let currentFile = '';
+        for (const finding of findings) {
+            if (finding.file !== currentFile) {
+                currentFile = finding.file;
+                lines.push(`  ${oneLine(currentFile)}`);
+            }
+            lines.push(`    ${oneLine(finding.message)}`);
+            for (const key of [finding.key, ...finding.related]) {
+                if (key !== null)
+                    lines.push(`      ${oneLine(key)}`);
+            }
+        }
+        lines.push('');
+    }
+    if (result.errors.length > 0) {
+        lines.push('could not be analysed');
+        for (const error of result.errors) {
+            lines.push(`  ${oneLine(error.file)}: ${oneLine(error.message)}`);
+        }
+        lines.push('');
+    }
+    lines.push(summarise(result));
+    return `${lines.join('\n')}\n`;
+}
+function summarise(result) {
+    const { warnings, errors } = result.summary;
+    const scope = `${count(result.files.length, 'file')}, ${count(Object.keys(result.summary.byRule).length, 'rule')}`;
+    if (warnings === 0 && errors === 0)
+        return `No findings (${scope}).`;
+    const parts = [count(warnings, 'warning')];
+    if (errors > 0)
+        parts.push(count(errors, 'error'));
+    return `${parts.join(', ')} (${scope}). ${DISCLAIMER}`;
+}
+function count(n, noun) {
+    return `${n} ${noun}${n === 1 ? '' : 's'}`;
+}
+function groupByRule(findings) {
+    const groups = new Map();
+    for (const finding of findings) {
+        const bucket = groups.get(finding.rule);
+        if (bucket)
+            bucket.push(finding);
+        else
+            groups.set(finding.rule, [finding]);
+    }
+    // Findings arrive sorted by file first, so first-seen order is not the rule order.
+    return RULE_IDS.flatMap((id) => {
+        const bucket = groups.get(id);
+        return bucket ? [[id, bucket]] : [];
+    });
+}
+//# sourceMappingURL=text.js.map

package/dist/format/text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.js","sourceRoot":"","sources":["../../src/format/text.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEtC;;;GAGG;AACH,MAAM,UAAU,GACd,gFAAgF,CAAC;AAEnF,MAAM,UAAU,UAAU,CAAC,MAAkB;IAC3C,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5D,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QACpD,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBACjC,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;gBAC3B,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;YAC1C,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAC9C,KAAK,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBACpD,IAAI,GAAG,KAAK,IAAI;oBAAE,KAAK,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QACpC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClC,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACpE,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9B,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED,SAAS,SAAS,CAAC,MAAkB;IACnC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;IAC5C,MAAM,KAAK,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IAEnH,IAAI,QAAQ,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC;QAAE,OAAO,gBAAgB,KAAK,IAAI,CAAC;IAErE,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;IAC3C,IAAI,MAAM,GAAG,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACnD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,MAAM,UAAU,EAAE,CAAC;AACzD,CAAC;AAED,SAAS,KAAK,CAAC,CAAS,EAAE,IAAY;IACpC,OAAO,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;AAC7C,CAAC;AAED,SAAS,WAAW,CAAC,QAA4B;IAC/C,MAAM,MAAM,GAAG,IAAI,GAAG,EAAqB,CAAC;IAC5C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,MAAM;YAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;;YAC5B,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3C,CAAC;IACD,mFAAmF;IACnF,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;QAC7B,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC9B,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAwB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7D,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The JavaScript API.
+ *
+ * Provisional before 1.0 (SPEC §9): only the `json` output shape carries the compatibility promise.
+ * This exists so the rules can be run without spawning a process — from a test, a codemod, or a
+ * bespoke reporter.
+ */
+export { formatGithub, type GithubOutput } from './format/github.js';
+export { formatJson } from './format/json.js';
+export { formatText } from './format/text.js';
+export { analyse, canonicalFields, fieldDirection, implicitNameDirection, indexKey, NAME_FIELD, } from './key.js';
+export { DEFAULT_QUOTA, DEFAULT_QUOTA_THRESHOLD, lintDocuments, lintFiles, lintTexts, type DocumentInput, type LintOptions, type TextInput, } from './lint.js';
+export { MalformedInputError, parseDocument, validateDocument } from './parse.js';
+export { getRule, isRuleId, rules } from './rules/index.js';
+export { RULE_IDS } from './types.js';
+export type { AnalysedIndex, CanonicalField, CompositeIndex, Finding, IndexDocument, IndexField, LintError, LintResult, LintSummary, OutputFormat, Rule, RuleContext, RuleId, RuleOptions, } from './types.js';
+export { VERSION } from './version.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,YAAY,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EACL,OAAO,EACP,eAAe,EACf,cAAc,EACd,qBAAqB,EACrB,QAAQ,EACR,UAAU,GACX,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,aAAa,EACb,uBAAuB,EACvB,aAAa,EACb,SAAS,EACT,SAAS,EACT,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,SAAS,GACf,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAClF,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,YAAY,EACV,aAAa,EACb,cAAc,EACd,cAAc,EACd,OAAO,EACP,aAAa,EACb,UAAU,EACV,SAAS,EACT,UAAU,EACV,WAAW,EACX,YAAY,EACZ,IAAI,EACJ,WAAW,EACX,MAAM,EACN,WAAW,GACZ,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -0,0 +1,17 @@
+/**
+ * The JavaScript API.
+ *
+ * Provisional before 1.0 (SPEC §9): only the `json` output shape carries the compatibility promise.
+ * This exists so the rules can be run without spawning a process — from a test, a codemod, or a
+ * bespoke reporter.
+ */
+export { formatGithub } from './format/github.js';
+export { formatJson } from './format/json.js';
+export { formatText } from './format/text.js';
+export { analyse, canonicalFields, fieldDirection, implicitNameDirection, indexKey, NAME_FIELD, } from './key.js';
+export { DEFAULT_QUOTA, DEFAULT_QUOTA_THRESHOLD, lintDocuments, lintFiles, lintTexts, } from './lint.js';
+export { MalformedInputError, parseDocument, validateDocument } from './parse.js';
+export { getRule, isRuleId, rules } from './rules/index.js';
+export { RULE_IDS } from './types.js';
+export { VERSION } from './version.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,YAAY,EAAqB,MAAM,oBAAoB,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EACL,OAAO,EACP,eAAe,EACf,cAAc,EACd,qBAAqB,EACrB,QAAQ,EACR,UAAU,GACX,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,aAAa,EACb,uBAAuB,EACvB,aAAa,EACb,SAAS,EACT,SAAS,GAIV,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAClF,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAiBtC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}

package/dist/key.d.ts

@@ -0,0 +1,35 @@
+import type { AnalysedIndex, CanonicalField, IndexDocument, IndexField } from './types.js';
+export declare const NAME_FIELD = "__name__";
+/**
+ * The direction a field contributes to the canonical key.
+ *
+ * `parse.ts` guarantees exactly one of `order`, `arrayConfig`, and `vectorConfig` is present, so
+ * the fallback is unreachable for validated input.
+ */
+export declare function fieldDirection(field: IndexField): string;
+/**
+ * The direction Firestore would give the document key it appends to this field list.
+ *
+ * See SPEC §5, *The implicit `__name__` direction*: the last preceding `order`, or `ASCENDING` when
+ * no preceding field carries one. `fields` must already exclude the trailing `__name__` entry.
+ */
+export declare function implicitNameDirection(fields: readonly IndexField[]): string;
+export interface CanonicalFields {
+    fields: CanonicalField[];
+    /** Direction of the trailing `__name__` that was removed, or `null` if nothing was removed. */
+    redundantNameDirection: string | null;
+}
+/**
+ * Reduce a declaration's fields to canonical form, dropping a trailing `__name__` that merely
+ * restates what Firestore appends anyway.
+ *
+ * The drop is one-sided by design: a `__name__` whose direction differs from the implicit default
+ * is meaningful and is kept, so this can fail to merge two spellings of one index but can never
+ * merge two distinct indexes.
+ */
+export declare function canonicalFields(fields: readonly IndexField[]): CanonicalFields;
+export declare function formatField(field: CanonicalField): string;
+export declare function indexKey(collectionGroup: string, queryScope: string, fields: readonly CanonicalField[]): string;
+/** Precompute the canonical form once so every rule shares one interpretation of the document. */
+export declare function analyse(document: IndexDocument): AnalysedIndex[];
+//# sourceMappingURL=key.d.ts.map

package/dist/key.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"key.d.ts","sourceRoot":"","sources":["../src/key.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAkB,aAAa,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE3G,eAAO,MAAM,UAAU,aAAa,CAAC;AAErC;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAQxD;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,SAAS,UAAU,EAAE,GAAG,MAAM,CAM3E;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,+FAA+F;IAC/F,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;CACvC;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,SAAS,UAAU,EAAE,GAAG,eAAe,CAS9E;AAMD,wBAAgB,WAAW,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM,CAEzD;AAED,wBAAgB,QAAQ,CACtB,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,SAAS,cAAc,EAAE,GAChC,MAAM,CAER;AAED,kGAAkG;AAClG,wBAAgB,OAAO,CAAC,QAAQ,EAAE,aAAa,GAAG,aAAa,EAAE,CAEhE"}

package/dist/key.js

@@ -0,0 +1,76 @@
+export const NAME_FIELD = '__name__';
+/**
+ * The direction a field contributes to the canonical key.
+ *
+ * `parse.ts` guarantees exactly one of `order`, `arrayConfig`, and `vectorConfig` is present, so
+ * the fallback is unreachable for validated input.
+ */
+export function fieldDirection(field) {
+    if (typeof field.order === 'string')
+        return field.order;
+    if (typeof field.arrayConfig === 'string')
+        return field.arrayConfig;
+    if (field.vectorConfig) {
+        const dimension = field.vectorConfig['dimension'];
+        return `VECTOR(${typeof dimension === 'number' ? dimension : '?'})`;
+    }
+    return 'UNKNOWN';
+}
+/**
+ * The direction Firestore would give the document key it appends to this field list.
+ *
+ * See SPEC §5, *The implicit `__name__` direction*: the last preceding `order`, or `ASCENDING` when
+ * no preceding field carries one. `fields` must already exclude the trailing `__name__` entry.
+ */
+export function implicitNameDirection(fields) {
+    for (let i = fields.length - 1; i >= 0; i -= 1) {
+        const order = fields[i]?.order;
+        if (typeof order === 'string')
+            return order;
+    }
+    return 'ASCENDING';
+}
+/**
+ * Reduce a declaration's fields to canonical form, dropping a trailing `__name__` that merely
+ * restates what Firestore appends anyway.
+ *
+ * The drop is one-sided by design: a `__name__` whose direction differs from the implicit default
+ * is meaningful and is kept, so this can fail to merge two spellings of one index but can never
+ * merge two distinct indexes.
+ */
+export function canonicalFields(fields) {
+    const last = fields[fields.length - 1];
+    if (last && last.fieldPath === NAME_FIELD && typeof last.order === 'string') {
+        const head = fields.slice(0, -1);
+        if (last.order === implicitNameDirection(head)) {
+            return { fields: head.map(toCanonicalField), redundantNameDirection: last.order };
+        }
+    }
+    return { fields: fields.map(toCanonicalField), redundantNameDirection: null };
+}
+function toCanonicalField(field) {
+    return { fieldPath: field.fieldPath, direction: fieldDirection(field) };
+}
+export function formatField(field) {
+    return `${field.fieldPath}:${field.direction}`;
+}
+export function indexKey(collectionGroup, queryScope, fields) {
+    return `${collectionGroup}::${queryScope}::${fields.map(formatField).join('|')}`;
+}
+/** Precompute the canonical form once so every rule shares one interpretation of the document. */
+export function analyse(document) {
+    return document.indexes.map((source, position) => analyseIndex(source, position));
+}
+function analyseIndex(source, position) {
+    const { fields, redundantNameDirection } = canonicalFields(source.fields);
+    return {
+        source,
+        position,
+        collectionGroup: source.collectionGroup,
+        queryScope: source.queryScope,
+        fields,
+        key: indexKey(source.collectionGroup, source.queryScope, fields),
+        redundantNameDirection,
+    };
+}
+//# sourceMappingURL=key.js.map

package/dist/key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"key.js","sourceRoot":"","sources":["../src/key.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,UAAU,GAAG,UAAU,CAAC;AAErC;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,KAAiB;IAC9C,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC,KAAK,CAAC;IACxD,IAAI,OAAO,KAAK,CAAC,WAAW,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC,WAAW,CAAC;IACpE,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;QACvB,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAClD,OAAO,UAAU,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;IACtE,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAA6B;IACjE,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;QAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;IAC9C,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAQD;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAAC,MAA6B;IAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACvC,IAAI,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,UAAU,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5E,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACjC,IAAI,IAAI,CAAC,KAAK,KAAK,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/C,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,sBAAsB,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;QACpF,CAAC;IACH,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,sBAAsB,EAAE,IAAI,EAAE,CAAC;AAChF,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAiB;IACzC,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;AAC1E,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,KAAqB;IAC/C,OAAO,GAAG,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;AACjD,CAAC;AAED,MAAM,UAAU,QAAQ,CACtB,eAAuB,EACvB,UAAkB,EAClB,MAAiC;IAEjC,OAAO,GAAG,eAAe,KAAK,UAAU,KAAK,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;AACnF,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,OAAO,CAAC,QAAuB;IAC7C,OAAO,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;AACpF,CAAC;AAED,SAAS,YAAY,CAAC,MAAsB,EAAE,QAAgB;IAC5D,MAAM,EAAE,MAAM,EAAE,sBAAsB,EAAE,GAAG,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC1E,OAAO;QACL,MAAM;QACN,QAAQ;QACR,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,MAAM;QACN,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC;QAChE,sBAAsB;KACvB,CAAC;AACJ,CAAC"}

package/dist/lint.d.ts

@@ -0,0 +1,22 @@
+import type { IndexDocument, LintResult, RuleId, RuleOptions } from './types.js';
+export declare const DEFAULT_QUOTA = 1000;
+export declare const DEFAULT_QUOTA_THRESHOLD = 0.8;
+export interface LintOptions extends Partial<RuleOptions> {
+    /** Rules to run, in any order. Defaults to all of them. */
+    rules?: readonly RuleId[];
+}
+export interface DocumentInput {
+    file: string;
+    document: IndexDocument;
+}
+export interface TextInput {
+    file: string;
+    text: string;
+}
+/** Lint documents that are already parsed. The lowest layer; does no I/O. */
+export declare function lintDocuments(inputs: readonly DocumentInput[], options?: LintOptions): LintResult;
+/** Lint raw file contents. A file that does not parse becomes an error, not a thrown exception. */
+export declare function lintTexts(inputs: readonly TextInput[], options?: LintOptions): LintResult;
+/** Lint files on disk. Unreadable files are reported the same way malformed ones are. */
+export declare function lintFiles(paths: readonly string[], options?: LintOptions): LintResult;
+//# sourceMappingURL=lint.d.ts.map

package/dist/lint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lint.d.ts","sourceRoot":"","sources":["../src/lint.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAEV,aAAa,EAEb,UAAU,EACV,MAAM,EACN,WAAW,EACZ,MAAM,YAAY,CAAC;AAGpB,eAAO,MAAM,aAAa,OAAO,CAAC;AAClC,eAAO,MAAM,uBAAuB,MAAM,CAAC;AAE3C,MAAM,WAAW,WAAY,SAAQ,OAAO,CAAC,WAAW,CAAC;IACvD,2DAA2D;IAC3D,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,6EAA6E;AAC7E,wBAAgB,aAAa,CAAC,MAAM,EAAE,SAAS,aAAa,EAAE,EAAE,OAAO,GAAE,WAAgB,GAAG,UAAU,CAKrG;AAED,mGAAmG;AACnG,wBAAgB,SAAS,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,EAAE,OAAO,GAAE,WAAgB,GAAG,UAAU,CAW7F;AAED,yFAAyF;AACzF,wBAAgB,SAAS,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,EAAE,OAAO,GAAE,WAAgB,GAAG,UAAU,CAWzF"}