@mark1russell7/ste-lint 0.0.0-stage → 0.1.2

package/dist/rules/word-list-matcher.d.ts

@@ -0,0 +1,25 @@
+import { type Token } from "../text/tokens.js";
+import type { WordListEntry } from "../word-list.js";
+export type WordListMatch = {
+    readonly entry: WordListEntry;
+    readonly from: number;
+    readonly to: number;
+};
+/** True when "see" at `index` tells the reader to look at other text, not to see with the eyes. */
+export declare function isReferenceSee(tokens: readonly Token[], index: number): boolean;
+/** This class finds the entries of the word list in a sentence. */
+export declare class WordListMatcher {
+    private readonly phrases;
+    /** The single words of the list. Other rules skip these words, so that a word gets one finding. */
+    readonly words: ReadonlySet<string>;
+    constructor(entries: readonly WordListEntry[]);
+    /**
+     * The matches in `tokens`. The longest phrase wins. `skipWord` tells the
+     * matcher to ignore a single word, for example a glossary term.
+     */
+    find(tokens: readonly Token[], options: {
+        readonly verbs: ReadonlySet<string>;
+        readonly skipWord: (word: string) => boolean;
+    }): WordListMatch[];
+}
+//# sourceMappingURL=word-list-matcher.d.ts.map

package/dist/rules/word-list-matcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"word-list-matcher.d.ts","sourceRoot":"","sources":["../../src/rules/word-list-matcher.ts"],"names":[],"mappings":"AAEA,OAAO,EAAU,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,aAAa,GAAG;IACxB,QAAQ,CAAC,KAAK,EAAG,aAAa,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,EAAG,MAAM,CAAC;CACxB,CAAC;AAMF,mGAAmG;AACnG,wBAAgB,cAAc,CAAC,MAAM,EAAG,SAAS,KAAK,EAAE,EAAE,KAAK,EAAG,MAAM,GAAI,OAAO,CAKlF;AAED,mEAAmE;AACnE,qBAAa,eAAe;IACxB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsC;IAC9D,mGAAmG;IACnG,QAAQ,CAAC,KAAK,EAAG,WAAW,CAAC,MAAM,CAAC,CAAC;gBAEzB,OAAO,EAAG,SAAS,aAAa,EAAE;IAY9C;;;OAGG;IACH,IAAI,CAAC,MAAM,EAAG,SAAS,KAAK,EAAE,EAAE,OAAO,EAAG;QAAE,QAAQ,CAAC,KAAK,EAAG,WAAW,CAAC,MAAM,CAAC,CAAC;QAAC,QAAQ,CAAC,QAAQ,EAAG,CAAC,IAAI,EAAG,MAAM,KAAK,OAAO,CAAA;KAAE,GAAI,aAAa,EAAE;CAsBxJ"}

package/dist/rules/word-list-matcher.js

@@ -0,0 +1,60 @@
+import { isClauseStart, isVerbUse } from "../text/grammar.js";
+import { PhraseMatcher, splitPhrase } from "../text/phrases.js";
+import { isWord } from "../text/tokens.js";
+/** Words before "see" that show the meaning "refer to": "(see X)", "For details, see X", "See also X". */
+const REFERENCE_BEFORE = new Set(["also", "please", "and", "or", "then"]);
+const REFERENCE_PUNCTUATION = new Set(["(", ",", ":", ";", "—", "–", "-"]);
+/** True when "see" at `index` tells the reader to look at other text, not to see with the eyes. */
+export function isReferenceSee(tokens, index) {
+    const previous = tokens[index - 1];
+    if (previous === undefined || isClauseStart(tokens, index))
+        return true;
+    if (previous.kind === "punct")
+        return REFERENCE_PUNCTUATION.has(previous.text);
+    return isWord(previous) && REFERENCE_BEFORE.has(previous.lower);
+}
+/** This class finds the entries of the word list in a sentence. */
+export class WordListMatcher {
+    phrases = new PhraseMatcher();
+    /** The single words of the list. Other rules skip these words, so that a word gets one finding. */
+    words;
+    constructor(entries) {
+        const words = new Set();
+        for (const entry of entries) {
+            for (const match of entry.match) {
+                this.phrases.add(match, entry);
+                const parts = splitPhrase(match);
+                if (parts.length === 1)
+                    words.add(parts[0]);
+            }
+        }
+        this.words = words;
+    }
+    /**
+     * The matches in `tokens`. The longest phrase wins. `skipWord` tells the
+     * matcher to ignore a single word, for example a glossary term.
+     */
+    find(tokens, options) {
+        const matches = [];
+        let i = 0;
+        while (i < tokens.length) {
+            const match = this.phrases.match(tokens, i);
+            if (match === null) {
+                i++;
+                continue;
+            }
+            const entry = match.value;
+            const skip = (match.length === 1 && options.skipWord(tokens[i].lower))
+                || (entry.verbOnly && !isVerbUse(tokens, i, { verbs: options.verbs }))
+                || (entry.context === "reference" && !isReferenceSee(tokens, i));
+            if (skip) {
+                i++;
+                continue;
+            }
+            matches.push({ entry, from: i, to: i + match.length });
+            i += match.length;
+        }
+        return matches;
+    }
+}
+//# sourceMappingURL=word-list-matcher.js.map

package/dist/rules/word-list-matcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"word-list-matcher.js","sourceRoot":"","sources":["../../src/rules/word-list-matcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,MAAM,EAAc,MAAM,mBAAmB,CAAC;AASvD,0GAA0G;AAC1G,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AAC1E,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAE3E,mGAAmG;AACnG,MAAM,UAAU,cAAc,CAAC,MAAyB,EAAE,KAAc;IACpE,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IACnC,IAAI,QAAQ,KAAK,SAAS,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACxE,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO;QAAE,OAAO,qBAAqB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC/E,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACpE,CAAC;AAED,mEAAmE;AACnE,MAAM,OAAO,eAAe;IACP,OAAO,GAAG,IAAI,aAAa,EAAiB,CAAC;IAC9D,mGAAmG;IAC1F,KAAK,CAAuB;IAErC,YAAY,OAAkC;QAC1C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;QAChC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC1B,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;gBAC9B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAC/B,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;gBACjC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;oBAAE,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC;YACjD,CAAC;QACL,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,MAAyB,EAAE,OAAkG;QAC9H,MAAM,OAAO,GAAqB,EAAE,CAAC;QACrC,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;YACvB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC5C,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBACjB,CAAC,EAAE,CAAC;gBACJ,SAAS;YACb,CAAC;YACD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;YAC1B,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,CAAC;mBAChE,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,KAAK,EAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;mBACpE,CAAC,KAAK,CAAC,OAAO,KAAK,WAAW,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;YACrE,IAAI,IAAI,EAAE,CAAC;gBACP,CAAC,EAAE,CAAC;gBACJ,SAAS;YACb,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,EAAG,CAAC,EAAE,EAAE,EAAG,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;YACzD,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC;QACtB,CAAC;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ"}

package/dist/rules/word-list.d.ts

@@ -0,0 +1,3 @@
+import { type Rule } from "./rule.js";
+export declare const wordList: Rule;
+//# sourceMappingURL=word-list.d.ts.map

package/dist/rules/word-list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"word-list.d.ts","sourceRoot":"","sources":["../../src/rules/word-list.ts"],"names":[],"mappings":"AACA,OAAO,EAAuB,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAE3D,eAAO,MAAM,QAAQ,EAAG,IAqBvB,CAAC"}

package/dist/rules/word-list.js

@@ -0,0 +1,26 @@
+import { isGlossaryWord } from "../lexicon.js";
+import { surface, tokenRange } from "./rule.js";
+export const wordList = {
+    id: "word-list",
+    description: "Find the words and phrases of the project word list, and give the plain-language words to use instead.",
+    ste: "1.1, 9.1",
+    defaultSeverity: "error",
+    scope: "word",
+    check(unit, context) {
+        for (const sentence of unit.sentences) {
+            const matches = context.wordList.find(sentence.tokens, {
+                verbs: context.lexicon.verbs,
+                skipWord: (word) => isGlossaryWord(word, context.lexicon),
+            });
+            for (const match of matches) {
+                const found = surface(sentence.tokens, match.from, match.to);
+                const { entry } = match;
+                let message = entry.suggest === null ? `Remove "${found}".` : `Write ${entry.suggest}, not "${found}".`;
+                if (entry.note !== null)
+                    message += ` ${entry.note}`;
+                context.report({ ...tokenRange(sentence.tokens, match.from, match.to), message, severity: entry.severity });
+            }
+        }
+    },
+};
+//# sourceMappingURL=word-list.js.map

package/dist/rules/word-list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"word-list.js","sourceRoot":"","sources":["../../src/rules/word-list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,UAAU,EAAa,MAAM,WAAW,CAAC;AAE3D,MAAM,CAAC,MAAM,QAAQ,GAAU;IAC3B,EAAE,EAAG,WAAW;IAChB,WAAW,EAAG,wGAAwG;IACtH,GAAG,EAAG,UAAU;IAChB,eAAe,EAAG,OAAO;IACzB,KAAK,EAAG,MAAM;IACd,KAAK,CAAC,IAAI,EAAE,OAAO;QACf,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;gBACnD,KAAK,EAAG,OAAO,CAAC,OAAO,CAAC,KAAK;gBAC7B,QAAQ,EAAG,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC;aAC7D,CAAC,CAAC;YACH,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;gBAC1B,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;gBAC7D,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;gBACxB,IAAI,OAAO,GAAG,KAAK,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,OAAO,UAAU,KAAK,IAAI,CAAC;gBACxG,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI;oBAAE,OAAO,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;gBACrD,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YACjH,CAAC;QACL,CAAC;IACL,CAAC;CACJ,CAAC"}

package/dist/run-cli.d.ts

@@ -0,0 +1,27 @@
+/**
+ * The command-line interface. `runCli` does not use `process` directly, so
+ * the tests can give it arguments, an environment and output functions.
+ */
+export type CliIo = {
+    readonly cwd: string;
+    readonly env: Readonly<Record<string, string | undefined>>;
+    readonly stdout: (text: string) => void;
+    readonly stderr: (text: string) => void;
+};
+export type CliOptions = {
+    readonly patterns: readonly string[];
+    readonly format: "text" | "json";
+    readonly maxWarnings: number | null;
+    readonly configPath: string | null;
+    readonly help: boolean;
+};
+/** An incorrect command line. */
+export declare class UsageError extends Error {
+    readonly name: string;
+}
+export declare const USAGE: string;
+/** This function reads the command-line arguments. */
+export declare function parseArgs(argv: readonly string[]): CliOptions;
+/** This function starts the linter with command-line arguments. The result is the exit code. */
+export declare function runCli(argv: readonly string[], io: CliIo): number;
+//# sourceMappingURL=run-cli.d.ts.map

package/dist/run-cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-cli.d.ts","sourceRoot":"","sources":["../src/run-cli.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAYH,MAAM,MAAM,KAAK,GAAG;IAChB,QAAQ,CAAC,GAAG,EAAG,MAAM,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;IAC5D,QAAQ,CAAC,MAAM,EAAG,CAAC,IAAI,EAAG,MAAM,KAAK,IAAI,CAAC;IAC1C,QAAQ,CAAC,MAAM,EAAG,CAAC,IAAI,EAAG,MAAM,KAAK,IAAI,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACrB,QAAQ,CAAC,QAAQ,EAAG,SAAS,MAAM,EAAE,CAAC;IACtC,QAAQ,CAAC,MAAM,EAAG,MAAM,GAAG,MAAM,CAAC;IAClC,QAAQ,CAAC,WAAW,EAAG,MAAM,GAAG,IAAI,CAAC;IACrC,QAAQ,CAAC,UAAU,EAAG,MAAM,GAAG,IAAI,CAAC;IACpC,QAAQ,CAAC,IAAI,EAAG,OAAO,CAAC;CAC3B,CAAC;AAEF,iCAAiC;AACjC,qBAAa,UAAW,SAAQ,KAAK;IACjC,SAAkB,IAAI,EAAG,MAAM,CAAgB;CAClD;AAED,eAAO,MAAM,KAAK,EAAG,MAwBpB,CAAC;AAQF,sDAAsD;AACtD,wBAAgB,SAAS,CAAC,IAAI,EAAG,SAAS,MAAM,EAAE,GAAI,UAAU,CA0C/D;AAiBD,gGAAgG;AAChG,wBAAgB,MAAM,CAAC,IAAI,EAAG,SAAS,MAAM,EAAE,EAAE,EAAE,EAAG,KAAK,GAAI,MAAM,CAgEpE"}

package/dist/run-cli.js

@@ -0,0 +1,176 @@
+/**
+ * The command-line interface. `runCli` does not use `process` directly, so
+ * the tests can give it arguments, an environment and output functions.
+ */
+import { existsSync } from "node:fs";
+import { relative, resolve, sep } from "node:path";
+import { ConfigError, DICTIONARY_ENV, loadConfig } from "./config.js";
+import { DictionaryError, loadDictionary } from "./dictionary.js";
+import { findFiles } from "./files.js";
+import { formatJson, formatText, summarize } from "./format.js";
+import { buildLexicon } from "./lexicon.js";
+import { fileKind, Linter } from "./lint.js";
+/** An incorrect command line. */
+export class UsageError extends Error {
+    name = "UsageError";
+}
+export const USAGE = `Usage: ste-lint [options] [patterns...]
+
+ste-lint examines the prose in Markdown files, MDX files and TypeScript doc
+comments. It finds text that does not obey the writing rules of ASD-STE100
+Simplified Technical English. The tool is an automated approximation of
+these rules. It does not certify that a text obeys the standard.
+
+Without patterns, ste-lint uses the "include" patterns of ste.config.json,
+or the default patterns. Patterns are relative to the working directory.
+
+Options:
+  --format <text|json>  The output format. The default is "text".
+  --max-warnings <n>    Exit with code 1 when there are more than n warnings.
+  --config <path>       Use this configuration file.
+  -h, --help            Show this help.
+
+Exit codes:
+  0  No errors, and not more warnings than the maximum.
+  1  One or more errors, or more warnings than the maximum.
+  2  An incorrect command line or configuration, or no files.
+
+Environment:
+  ${DICTIONARY_ENV}  The path of a local dictionary file. This path has
+                  priority over "dictionaryPath" in ste.config.json.
+`;
+function optionValue(argv, index, name) {
+    const value = argv[index + 1];
+    if (value === undefined || value.startsWith("--"))
+        throw new UsageError(`The option ${name} needs a value.`);
+    return value;
+}
+/** This function reads the command-line arguments. */
+export function parseArgs(argv) {
+    const patterns = [];
+    let format = "text";
+    let maxWarnings = null;
+    let configPath = null;
+    let help = false;
+    for (let i = 0; i < argv.length; i++) {
+        const argument = argv[i];
+        const [name, inline] = argument.startsWith("--") && argument.includes("=") ? [argument.slice(0, argument.indexOf("=")), argument.slice(argument.indexOf("=") + 1)] : [argument, undefined];
+        const value = () => {
+            if (inline !== undefined)
+                return inline;
+            const next = optionValue(argv, i, name);
+            i++;
+            return next;
+        };
+        switch (name) {
+            case "-h":
+            case "--help":
+                help = true;
+                break;
+            case "--format": {
+                const text = value();
+                if (text !== "text" && text !== "json")
+                    throw new UsageError(`The format must be "text" or "json", not "${text}".`);
+                format = text;
+                break;
+            }
+            case "--max-warnings": {
+                const text = value();
+                const count = Number(text);
+                if (!/^\d+$/.test(text) || !Number.isSafeInteger(count))
+                    throw new UsageError(`--max-warnings must be an integer of 0 or more, not "${text}".`);
+                maxWarnings = count;
+                break;
+            }
+            case "--config":
+                configPath = value();
+                break;
+            default:
+                if (argument.startsWith("-") && argument !== "-")
+                    throw new UsageError(`"${argument}" is not a known option. Use --help to show the options.`);
+                patterns.push(argument);
+        }
+    }
+    return { patterns, format, maxWarnings, configPath, help };
+}
+function displayPath(path, cwd) {
+    const shown = relative(cwd, path);
+    return (shown.length > 0 && !shown.startsWith("..") ? shown : path).split(sep).join("/");
+}
+function loadOptionalDictionary(config, io) {
+    if (config.dictionaryPath === null)
+        return null;
+    if (!existsSync(config.dictionaryPath)) {
+        const from = config.dictionarySource === "env" ? DICTIONARY_ENV : "dictionaryPath";
+        io.stderr(`ste-lint: the dictionary file ${config.dictionaryPath} (from ${from}) does not exist. The unknown-word rule is off.\n`);
+        return null;
+    }
+    return loadDictionary(config.dictionaryPath);
+}
+/** This function starts the linter with command-line arguments. The result is the exit code. */
+export function runCli(argv, io) {
+    let options;
+    try {
+        options = parseArgs(argv);
+    }
+    catch (error) {
+        io.stderr(`ste-lint: ${error.message}\n`);
+        return 2;
+    }
+    if (options.help) {
+        io.stdout(USAGE);
+        return 0;
+    }
+    let config;
+    let dictionary;
+    try {
+        config = loadConfig({ cwd: io.cwd, env: io.env, ...(options.configPath === null ? {} : { configPath: options.configPath }) });
+        dictionary = loadOptionalDictionary(config, io);
+    }
+    catch (error) {
+        if (error instanceof ConfigError || error instanceof DictionaryError) {
+            io.stderr(`ste-lint: ${error.message}\n`);
+            return 2;
+        }
+        throw error;
+    }
+    const explicit = options.patterns.length > 0;
+    let files;
+    try {
+        // The patterns of the command line are relative to the working directory. The ignore patterns are relative to the configuration.
+        files = (explicit
+            ? findFiles({ root: io.cwd, include: options.patterns, ignore: config.ignore, ignoreRoot: config.root })
+            : findFiles({ root: config.root, include: config.include, ignore: config.ignore })).filter((file) => fileKind(file) !== null);
+    }
+    catch (error) {
+        // For example, a directory that the user cannot read (EACCES)
+        io.stderr(`ste-lint: cannot read the files: ${error.message}\n`);
+        return 2;
+    }
+    if (files.length === 0) {
+        io.stderr(explicit ? "ste-lint: no files match the patterns.\n" : "ste-lint: no files to examine.\n");
+        return explicit ? 2 : 0;
+    }
+    const linter = new Linter(config, buildLexicon(config, dictionary));
+    const findings = [];
+    let failed = false;
+    for (const file of files) {
+        try {
+            findings.push(...linter.lintFile(file, displayPath(file, resolve(io.cwd))));
+        }
+        catch (error) {
+            io.stderr(`ste-lint: cannot examine ${file}: ${error.message}\n`);
+            failed = true;
+        }
+    }
+    const summary = summarize(findings, files.length);
+    io.stdout(options.format === "json" ? formatJson(findings, summary) : formatText(findings, summary));
+    const tooManyWarnings = options.maxWarnings !== null && summary.warnings > options.maxWarnings;
+    if (tooManyWarnings && options.format === "text") {
+        io.stderr(`ste-lint: ${summary.warnings} warnings. The maximum is ${options.maxWarnings}.\n`);
+    }
+    if (failed)
+        return 2;
+    return summary.errors > 0 || tooManyWarnings ? 1 : 0;
+}
+//# sourceMappingURL=run-cli.js.map

package/dist/run-cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-cli.js","sourceRoot":"","sources":["../src/run-cli.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,UAAU,EAAuB,MAAM,aAAa,CAAC;AAC3F,OAAO,EAAE,eAAe,EAAE,cAAc,EAAmB,MAAM,iBAAiB,CAAC;AACnF,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAkB7C,iCAAiC;AACjC,MAAM,OAAO,UAAW,SAAQ,KAAK;IACf,IAAI,GAAY,YAAY,CAAC;CAClD;AAED,MAAM,CAAC,MAAM,KAAK,GAAY;;;;;;;;;;;;;;;;;;;;;;IAsB1B,cAAc;;CAEjB,CAAC;AAEF,SAAS,WAAW,CAAC,IAAwB,EAAE,KAAc,EAAE,IAAa;IACxE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IAC9B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,MAAM,IAAI,UAAU,CAAC,cAAc,IAAI,iBAAiB,CAAC,CAAC;IAC7G,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,sDAAsD;AACtD,MAAM,UAAU,SAAS,CAAC,IAAwB;IAC9C,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,IAAI,MAAM,GAA0B,MAAM,CAAC;IAC3C,IAAI,WAAW,GAAmB,IAAI,CAAC;IACvC,IAAI,UAAU,GAAmB,IAAI,CAAC;IACtC,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAE,CAAC;QAC1B,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC3L,MAAM,KAAK,GAAG,GAAY,EAAE;YACxB,IAAI,MAAM,KAAK,SAAS;gBAAE,OAAO,MAAM,CAAC;YACxC,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACxC,CAAC,EAAE,CAAC;YACJ,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC;QACF,QAAQ,IAAI,EAAE,CAAC;YACX,KAAK,IAAI,CAAC;YACV,KAAK,QAAQ;gBACT,IAAI,GAAG,IAAI,CAAC;gBACZ,MAAM;YACV,KAAK,UAAU,CAAC,CAAC,CAAC;gBACd,MAAM,IAAI,GAAG,KAAK,EAAE,CAAC;gBACrB,IAAI,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,MAAM;oBAAE,MAAM,IAAI,UAAU,CAAC,6CAA6C,IAAI,IAAI,CAAC,CAAC;gBACpH,MAAM,GAAG,IAAI,CAAC;gBACd,MAAM;YACV,CAAC;YACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACpB,MAAM,IAAI,GAAG,KAAK,EAAE,CAAC;gBACrB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC3B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC;oBAAE,MAAM,IAAI,UAAU,CAAC,wDAAwD,IAAI,IAAI,CAAC,CAAC;gBAChJ,WAAW,GAAG,KAAK,CAAC;gBACpB,MAAM;YACV,CAAC;YACD,KAAK,UAAU;gBACX,UAAU,GAAG,KAAK,EAAE,CAAC;gBACrB,MAAM;YACV;gBACI,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,QAAQ,KAAK,GAAG;oBAAE,MAAM,IAAI,UAAU,CAAC,IAAI,QAAQ,0DAA0D,CAAC,CAAC;gBAC/I,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;IACD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;AAC/D,CAAC;AAED,SAAS,WAAW,CAAC,IAAa,EAAE,GAAY;IAC5C,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAClC,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7F,CAAC;AAED,SAAS,sBAAsB,CAAC,MAAuB,EAAE,EAAU;IAC/D,IAAI,MAAM,CAAC,cAAc,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAChD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,MAAM,CAAC,gBAAgB,KAAK,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,gBAAgB,CAAC;QACnF,EAAE,CAAC,MAAM,CAAC,iCAAiC,MAAM,CAAC,cAAc,UAAU,IAAI,mDAAmD,CAAC,CAAC;QACnI,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO,cAAc,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;AACjD,CAAC;AAED,gGAAgG;AAChG,MAAM,UAAU,MAAM,CAAC,IAAwB,EAAE,EAAU;IACvD,IAAI,OAAoB,CAAC;IACzB,IAAI,CAAC;QACD,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,EAAE,CAAC,MAAM,CAAC,aAAc,KAAe,CAAC,OAAO,IAAI,CAAC,CAAC;QACrD,OAAO,CAAC,CAAC;IACb,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACf,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACjB,OAAO,CAAC,CAAC;IACb,CAAC;IAED,IAAI,MAAuB,CAAC;IAC5B,IAAI,UAA8B,CAAC;IACnC,IAAI,CAAC;QACD,MAAM,GAAG,UAAU,CAAC,EAAE,GAAG,EAAG,EAAE,CAAC,GAAG,EAAE,GAAG,EAAG,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAG,OAAO,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;QACjI,UAAU,GAAG,sBAAsB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,IAAI,KAAK,YAAY,WAAW,IAAI,KAAK,YAAY,eAAe,EAAE,CAAC;YACnE,EAAE,CAAC,MAAM,CAAC,aAAa,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;YAC1C,OAAO,CAAC,CAAC;QACb,CAAC;QACD,MAAM,KAAK,CAAC;IAChB,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;IAC7C,IAAI,KAAgB,CAAC;IACrB,IAAI,CAAC;QACD,iIAAiI;QACjI,KAAK,GAAG,CAAC,QAAQ;YACb,CAAC,CAAC,SAAS,CAAC,EAAE,IAAI,EAAG,EAAE,CAAC,GAAG,EAAE,OAAO,EAAG,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAG,MAAM,CAAC,MAAM,EAAE,UAAU,EAAG,MAAM,CAAC,IAAI,EAAE,CAAC;YAC5G,CAAC,CAAC,SAAS,CAAC,EAAE,IAAI,EAAG,MAAM,CAAC,IAAI,EAAE,OAAO,EAAG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CACxF,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC;IAChD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,8DAA8D;QAC9D,EAAE,CAAC,MAAM,CAAC,oCAAqC,KAAe,CAAC,OAAO,IAAI,CAAC,CAAC;QAC5E,OAAO,CAAC,CAAC;IACb,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,0CAA0C,CAAC,CAAC,CAAC,kCAAkC,CAAC,CAAC;QACtG,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;IACpE,MAAM,QAAQ,GAAe,EAAE,CAAC;IAChC,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC;YACD,QAAQ,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAChF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,EAAE,CAAC,MAAM,CAAC,4BAA4B,IAAI,KAAM,KAAe,CAAC,OAAO,IAAI,CAAC,CAAC;YAC7E,MAAM,GAAG,IAAI,CAAC;QAClB,CAAC;IACL,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAClD,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACrG,MAAM,eAAe,GAAG,OAAO,CAAC,WAAW,KAAK,IAAI,IAAI,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC;IAC/F,IAAI,eAAe,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;QAC/C,EAAE,CAAC,MAAM,CAAC,aAAa,OAAO,CAAC,QAAQ,6BAA6B,OAAO,CAAC,WAAW,KAAK,CAAC,CAAC;IAClG,CAAC;IACD,IAAI,MAAM;QAAE,OAAO,CAAC,CAAC;IACrB,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC"}

package/dist/source/blocks.d.ts

@@ -0,0 +1,55 @@
+/**
+ * A block parser for the part of Markdown, GFM and MDX that has prose in it.
+ *
+ * The parser keeps paragraphs, headings, list items, block quotes and table
+ * cells. It removes fenced and indented code, HTML blocks, JSX tags, MDX
+ * import and export lines, MDX expressions, link reference definitions and
+ * thematic breaks. The TSDoc extractor uses the same parser for the text in
+ * a doc comment.
+ *
+ * The parser does not build a full CommonMark tree. It knows only the
+ * structure that the lint rules use. That is where a block starts and
+ * stops, and if the block is a heading, a table cell or text in a list item.
+ */
+import { type Line } from "./lines.js";
+export type ListContext = {
+    readonly ordered: boolean;
+};
+/** A block of prose that the lint rules examine. */
+export type ProseBlock = {
+    readonly kind: "paragraph" | "heading" | "table-cell";
+    /** The text lines of the block, without Markdown block syntax. */
+    readonly lines: readonly Line[];
+    /** The innermost list that contains the block, or null. */
+    readonly list: ListContext | null;
+    readonly quote: boolean;
+    /** 1 to 6 for a heading, 0 for other blocks. */
+    readonly headingDepth: number;
+    /** True for the cells of a table header row. */
+    readonly tableHeader: boolean;
+};
+export type DirectiveCommand = "disable" | "enable" | "disable-next";
+/** A `ste-disable`, `ste-enable` or `ste-disable-next` comment. */
+export type Directive = {
+    readonly kind: "directive";
+    readonly command: DirectiveCommand;
+    /** The rule IDs. An empty list means all rules. */
+    readonly rules: readonly string[];
+    readonly offset: number;
+};
+export type Block = ProseBlock | Directive;
+export type BlockOptions = {
+    /** Parse JSX tags, ESM lines and `{...}` expressions as MDX does. */
+    readonly mdx: boolean;
+};
+/** This function parses `lines` into prose blocks and directive comments. */
+export declare function parseBlocks(lines: readonly Line[], options: BlockOptions): Block[];
+/** The directive in the text of a comment, or null. */
+export declare function parseDirective(commentText: string, offset: number): Directive | null;
+/** True for a GFM table delimiter row, for example `| --- | :-: |`. */
+export declare function isDelimiterRow(text: string): boolean;
+/** This function divides a table row into cells. A `|` in a code span or after `\` does not divide cells. */
+export declare function splitCells(row: Line): Line[];
+/** The index of the next run of exactly `length` backticks at or after `from`, or -1. */
+export declare function findBacktickRun(text: string, from: number, length: number): number;
+//# sourceMappingURL=blocks.d.ts.map

package/dist/source/blocks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../../src/source/blocks.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAgD,KAAK,IAAI,EAAE,MAAM,YAAY,CAAC;AAErF,MAAM,MAAM,WAAW,GAAG;IACtB,QAAQ,CAAC,OAAO,EAAG,OAAO,CAAC;CAC9B,CAAC;AAEF,oDAAoD;AACpD,MAAM,MAAM,UAAU,GAAG;IACrB,QAAQ,CAAC,IAAI,EAAG,WAAW,GAAG,SAAS,GAAG,YAAY,CAAC;IACvD,kEAAkE;IAClE,QAAQ,CAAC,KAAK,EAAG,SAAS,IAAI,EAAE,CAAC;IACjC,2DAA2D;IAC3D,QAAQ,CAAC,IAAI,EAAG,WAAW,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAG,OAAO,CAAC;IACzB,gDAAgD;IAChD,QAAQ,CAAC,YAAY,EAAG,MAAM,CAAC;IAC/B,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAG,OAAO,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,QAAQ,GAAG,cAAc,CAAC;AAErE,mEAAmE;AACnE,MAAM,MAAM,SAAS,GAAG;IACpB,QAAQ,CAAC,IAAI,EAAG,WAAW,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAG,gBAAgB,CAAC;IACpC,mDAAmD;IACnD,QAAQ,CAAC,KAAK,EAAG,SAAS,MAAM,EAAE,CAAC;IACnC,QAAQ,CAAC,MAAM,EAAG,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG,UAAU,GAAG,SAAS,CAAC;AAE3C,MAAM,MAAM,YAAY,GAAG;IACvB,qEAAqE;IACrE,QAAQ,CAAC,GAAG,EAAG,OAAO,CAAC;CAC1B,CAAC;AAsBF,6EAA6E;AAC7E,wBAAgB,WAAW,CAAC,KAAK,EAAG,SAAS,IAAI,EAAE,EAAE,OAAO,EAAG,YAAY,GAAI,KAAK,EAAE,CAIrF;AAED,uDAAuD;AACvD,wBAAgB,cAAc,CAAC,WAAW,EAAG,MAAM,EAAE,MAAM,EAAG,MAAM,GAAI,SAAS,GAAG,IAAI,CAMvF;AAsXD,uEAAuE;AACvE,wBAAgB,cAAc,CAAC,IAAI,EAAG,MAAM,GAAI,OAAO,CAEtD;AAED,6GAA6G;AAC7G,wBAAgB,UAAU,CAAC,GAAG,EAAG,IAAI,GAAI,IAAI,EAAE,CAkC9C;AAED,yFAAyF;AACzF,wBAAgB,eAAe,CAAC,IAAI,EAAG,MAAM,EAAE,IAAI,EAAG,MAAM,EAAE,MAAM,EAAG,MAAM,GAAI,MAAM,CAatF"}