@mark1russell7/ste-lint 0.1.1 → 0.1.2

package/dist/dictionary-core.d.ts

@@ -0,0 +1,72 @@
+/**
+ * The optional local dictionary of approved words.
+ *
+ * The ASD-STE100 dictionary is copyrighted. This package does not contain
+ * it, and the repository must not contain it. Each user makes a local file
+ * from their own copy of the standard. Keep that file outside the
+ * repository, or in a git-ignored folder, for example `.ste/`.
+ *
+ * File format (JSON). The short form is an array of approved words:
+ *
+ * ```json
+ * ["a", "about", "make", "makes", "made"]
+ * ```
+ *
+ * The full form is an object with entries:
+ *
+ * ```json
+ * {
+ *   "format": "ste-lint-dictionary",
+ *   "version": 1,
+ *   "entries": [
+ *     { "word": "make", "pos": "verb", "forms": ["makes", "made"] },
+ *     { "word": "valve", "pos": "noun" },
+ *     { "word": "utilize", "pos": "verb", "approved": false, "alternatives": ["use"] }
+ *   ]
+ * }
+ * ```
+ *
+ * - `word` (necessary): the headword. A phrase, for example "make sure", approves each of its words.
+ * - `pos`: the part of speech. A noun also permits its regular plural.
+ * - `approved`: `false` for a word that is not approved. The default is `true`.
+ * - `forms`: other approved forms, for example the past tense of a verb.
+ * - `alternatives`: approved words to use instead of a word that is not approved.
+ */
+export type DictionaryEntry = {
+    readonly word: string;
+    readonly pos?: string;
+    readonly approved?: boolean;
+    readonly forms?: readonly string[];
+    readonly alternatives?: readonly string[];
+};
+export type DictionaryLookup = {
+    readonly status: "approved";
+} | {
+    readonly status: "not-approved";
+    readonly alternatives: readonly string[];
+} | {
+    readonly status: "unknown";
+};
+export declare const DICTIONARY_FORMAT = "ste-lint-dictionary";
+/** An error in a dictionary file. */
+export declare class DictionaryError extends Error {
+    readonly name: string;
+}
+/** The approved words of a local dictionary. */
+export declare class Dictionary {
+    private readonly approved;
+    private readonly approvedNouns;
+    private readonly notApproved;
+    /** The approved nouns. The noun-cluster rule uses them. */
+    readonly nouns: Set<string>;
+    /** The approved verbs. The imperative and missing-subject heuristics use them. */
+    readonly verbs: Set<string>;
+    constructor(entries: readonly DictionaryEntry[]);
+    /** The number of approved words and forms. */
+    get size(): number;
+    /** The status of `word` in the dictionary. */
+    lookup(word: string): DictionaryLookup;
+}
+/** This function makes a dictionary from parsed JSON. `source` is the file name for error messages. */
+export declare function parseDictionary(value: unknown, source: string): Dictionary;
+//# sourceMappingURL=dictionary-core.d.ts.map

package/dist/dictionary-core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dictionary-core.d.ts","sourceRoot":"","sources":["../src/dictionary-core.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH,MAAM,MAAM,eAAe,GAAG;IAC1B,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAC;IACvB,QAAQ,CAAC,GAAG,CAAC,EAAG,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,CAAC,EAAG,OAAO,CAAC;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAG,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,YAAY,CAAC,EAAG,SAAS,MAAM,EAAE,CAAC;CAC9C,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACtB;IAAE,QAAQ,CAAC,MAAM,EAAG,UAAU,CAAA;CAAE,GAChC;IAAE,QAAQ,CAAC,MAAM,EAAG,cAAc,CAAC;IAAC,QAAQ,CAAC,YAAY,EAAG,SAAS,MAAM,EAAE,CAAA;CAAE,GAC/E;IAAE,QAAQ,CAAC,MAAM,EAAG,SAAS,CAAA;CAAE,CAAC;AAEtC,eAAO,MAAM,iBAAiB,wBAAwB,CAAC;AAEvD,qCAAqC;AACrC,qBAAa,eAAgB,SAAQ,KAAK;IACtC,SAAkB,IAAI,EAAG,MAAM,CAAqB;CACvD;AAID,gDAAgD;AAChD,qBAAa,UAAU;IACnB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IAC9C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IACnD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAwC;IACpE,2DAA2D;IAC3D,QAAQ,CAAC,KAAK,EAAG,GAAG,CAAC,MAAM,CAAC,CAAqB;IACjD,kFAAkF;IAClF,QAAQ,CAAC,KAAK,EAAG,GAAG,CAAC,MAAM,CAAC,CAAqB;gBAErC,OAAO,EAAG,SAAS,eAAe,EAAE;IAkBhD,8CAA8C;IAC9C,IAAI,IAAI,IAAK,MAAM,CAElB;IAED,8CAA8C;IAC9C,MAAM,CAAC,IAAI,EAAG,MAAM,GAAI,gBAAgB;CAe3C;AAED,uGAAuG;AACvG,wBAAgB,eAAe,CAAC,KAAK,EAAG,OAAO,EAAE,MAAM,EAAG,MAAM,GAAI,UAAU,CAmB7E"}

package/dist/dictionary-core.js

@@ -0,0 +1,150 @@
+/**
+ * The optional local dictionary of approved words.
+ *
+ * The ASD-STE100 dictionary is copyrighted. This package does not contain
+ * it, and the repository must not contain it. Each user makes a local file
+ * from their own copy of the standard. Keep that file outside the
+ * repository, or in a git-ignored folder, for example `.ste/`.
+ *
+ * File format (JSON). The short form is an array of approved words:
+ *
+ * ```json
+ * ["a", "about", "make", "makes", "made"]
+ * ```
+ *
+ * The full form is an object with entries:
+ *
+ * ```json
+ * {
+ *   "format": "ste-lint-dictionary",
+ *   "version": 1,
+ *   "entries": [
+ *     { "word": "make", "pos": "verb", "forms": ["makes", "made"] },
+ *     { "word": "valve", "pos": "noun" },
+ *     { "word": "utilize", "pos": "verb", "approved": false, "alternatives": ["use"] }
+ *   ]
+ * }
+ * ```
+ *
+ * - `word` (necessary): the headword. A phrase, for example "make sure", approves each of its words.
+ * - `pos`: the part of speech. A noun also permits its regular plural.
+ * - `approved`: `false` for a word that is not approved. The default is `true`.
+ * - `forms`: other approved forms, for example the past tense of a verb.
+ * - `alternatives`: approved words to use instead of a word that is not approved.
+ */
+export const DICTIONARY_FORMAT = "ste-lint-dictionary";
+/** An error in a dictionary file. */
+export class DictionaryError extends Error {
+    name = "DictionaryError";
+}
+const normalize = (word) => word.trim().toLowerCase().replace(/[’‘]/g, "'");
+/** The approved words of a local dictionary. */
+export class Dictionary {
+    approved = new Set();
+    approvedNouns = new Set();
+    notApproved = new Map();
+    /** The approved nouns. The noun-cluster rule uses them. */
+    nouns = new Set();
+    /** The approved verbs. The imperative and missing-subject heuristics use them. */
+    verbs = new Set();
+    constructor(entries) {
+        for (const entry of entries) {
+            const words = [entry.word, ...(entry.forms ?? [])].flatMap((form) => normalize(form).split(/\s+/)).filter((form) => form.length > 0);
+            if (entry.approved === false) {
+                for (const word of words)
+                    this.notApproved.set(word, entry.alternatives ?? []);
+                continue;
+            }
+            for (const word of words)
+                this.approved.add(word);
+            const pos = (entry.pos ?? "").toLowerCase();
+            const base = normalize(entry.word);
+            if (pos === "n" || pos === "noun") {
+                this.approvedNouns.add(base);
+                this.nouns.add(base);
+            }
+            if (pos === "v" || pos === "verb")
+                this.verbs.add(base);
+        }
+    }
+    /** The number of approved words and forms. */
+    get size() {
+        return this.approved.size;
+    }
+    /** The status of `word` in the dictionary. */
+    lookup(word) {
+        const lower = normalize(word);
+        const candidates = [lower];
+        if (lower.endsWith("'s"))
+            candidates.push(lower.slice(0, -2));
+        for (const candidate of candidates) {
+            if (this.approved.has(candidate))
+                return { status: "approved" };
+            const plurals = [candidate.slice(0, -1), candidate.slice(0, -2), candidate.slice(0, -3) + "y"];
+            if (candidate.endsWith("s") && plurals.some((singular) => this.approvedNouns.has(singular)))
+                return { status: "approved" };
+        }
+        for (const candidate of candidates) {
+            const alternatives = this.notApproved.get(candidate);
+            if (alternatives !== undefined)
+                return { status: "not-approved", alternatives };
+        }
+        return { status: "unknown" };
+    }
+}
+/** This function makes a dictionary from parsed JSON. `source` is the file name for error messages. */
+export function parseDictionary(value, source) {
+    if (Array.isArray(value)) {
+        if (!value.every((word) => typeof word === "string")) {
+            throw new DictionaryError(`${source}: the array form must contain only strings.`);
+        }
+        return new Dictionary(value.map((word) => ({ word })));
+    }
+    if (typeof value !== "object" || value === null) {
+        throw new DictionaryError(`${source}: the file must contain an array of words or an object with "entries".`);
+    }
+    const record = value;
+    const format = record["format"];
+    if (format !== undefined && format !== DICTIONARY_FORMAT) {
+        throw new DictionaryError(`${source}: "format" must be "${DICTIONARY_FORMAT}".`);
+    }
+    const entries = record["entries"];
+    if (!Array.isArray(entries))
+        throw new DictionaryError(`${source}: "entries" must be an array.`);
+    const parsed = entries.map((entry, index) => parseEntry(entry, `${source}: entries[${index}]`));
+    return new Dictionary(parsed);
+}
+function stringArray(value, where) {
+    if (value === undefined)
+        return undefined;
+    if (!Array.isArray(value) || !value.every((item) => typeof item === "string")) {
+        throw new DictionaryError(`${where} must be an array of strings.`);
+    }
+    return value;
+}
+function parseEntry(entry, where) {
+    if (typeof entry === "string")
+        return { word: entry };
+    if (typeof entry !== "object" || entry === null)
+        throw new DictionaryError(`${where} must be a string or an object.`);
+    const record = entry;
+    const word = record["word"];
+    if (typeof word !== "string" || word.trim().length === 0)
+        throw new DictionaryError(`${where}.word must be a string that is not empty.`);
+    const pos = record["pos"];
+    if (pos !== undefined && typeof pos !== "string")
+        throw new DictionaryError(`${where}.pos must be a string.`);
+    const approved = record["approved"];
+    if (approved !== undefined && typeof approved !== "boolean")
+        throw new DictionaryError(`${where}.approved must be true or false.`);
+    const forms = stringArray(record["forms"], `${where}.forms`);
+    const alternatives = stringArray(record["alternatives"], `${where}.alternatives`);
+    return {
+        word,
+        ...(pos === undefined ? {} : { pos }),
+        ...(approved === undefined ? {} : { approved }),
+        ...(forms === undefined ? {} : { forms }),
+        ...(alternatives === undefined ? {} : { alternatives }),
+    };
+}
+//# sourceMappingURL=dictionary-core.js.map

package/dist/dictionary-core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dictionary-core.js","sourceRoot":"","sources":["../src/dictionary-core.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAeH,MAAM,CAAC,MAAM,iBAAiB,GAAG,qBAAqB,CAAC;AAEvD,qCAAqC;AACrC,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACpB,IAAI,GAAY,iBAAiB,CAAC;CACvD;AAED,MAAM,SAAS,GAAG,CAAC,IAAa,EAAW,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AAE9F,gDAAgD;AAChD,MAAM,OAAO,UAAU;IACF,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IAC7B,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,WAAW,GAAG,IAAI,GAAG,EAA6B,CAAC;IACpE,2DAA2D;IAClD,KAAK,GAAiB,IAAI,GAAG,EAAU,CAAC;IACjD,kFAAkF;IACzE,KAAK,GAAiB,IAAI,GAAG,EAAU,CAAC;IAEjD,YAAY,OAAoC;QAC5C,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC1B,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACrI,IAAI,KAAK,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;gBAC3B,KAAK,MAAM,IAAI,IAAI,KAAK;oBAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;gBAC/E,SAAS;YACb,CAAC;YACD,KAAK,MAAM,IAAI,IAAI,KAAK;gBAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;YAC5C,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACnC,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;gBAChC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC7B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACzB,CAAC;YACD,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,MAAM;gBAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5D,CAAC;IACL,CAAC;IAED,8CAA8C;IAC9C,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC9B,CAAC;IAED,8CAA8C;IAC9C,MAAM,CAAC,IAAa;QAChB,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3B,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9D,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACjC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC;gBAAE,OAAO,EAAE,MAAM,EAAG,UAAU,EAAE,CAAC;YACjE,MAAM,OAAO,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;YAC/F,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAAE,OAAO,EAAE,MAAM,EAAG,UAAU,EAAE,CAAC;QAChI,CAAC;QACD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACjC,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACrD,IAAI,YAAY,KAAK,SAAS;gBAAE,OAAO,EAAE,MAAM,EAAG,cAAc,EAAE,YAAY,EAAE,CAAC;QACrF,CAAC;QACD,OAAO,EAAE,MAAM,EAAG,SAAS,EAAE,CAAC;IAClC,CAAC;CACJ;AAED,uGAAuG;AACvG,MAAM,UAAU,eAAe,CAAC,KAAe,EAAE,MAAe;IAC5D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,eAAe,CAAC,GAAG,MAAM,6CAA6C,CAAC,CAAC;QACtF,CAAC;QACD,OAAO,IAAI,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAa,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAC9C,MAAM,IAAI,eAAe,CAAC,GAAG,MAAM,wEAAwE,CAAC,CAAC;IACjH,CAAC;IACD,MAAM,MAAM,GAAG,KAAgC,CAAC;IAChD,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;IAChC,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,iBAAiB,EAAE,CAAC;QACvD,MAAM,IAAI,eAAe,CAAC,GAAG,MAAM,uBAAuB,iBAAiB,IAAI,CAAC,CAAC;IACrF,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;QAAE,MAAM,IAAI,eAAe,CAAC,GAAG,MAAM,+BAA+B,CAAC,CAAC;IACjG,MAAM,MAAM,GAAuB,OAAO,CAAC,GAAG,CAAC,CAAC,KAAe,EAAE,KAAc,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,MAAM,aAAa,KAAK,GAAG,CAAC,CAAC,CAAC;IACvI,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,WAAW,CAAC,KAAe,EAAE,KAAc;IAChD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,EAAE,CAAC;QAC5E,MAAM,IAAI,eAAe,CAAC,GAAG,KAAK,+BAA+B,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,KAAiB,CAAC;AAC7B,CAAC;AAED,SAAS,UAAU,CAAC,KAAe,EAAE,KAAc;IAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,EAAE,IAAI,EAAG,KAAK,EAAE,CAAC;IACvD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,MAAM,IAAI,eAAe,CAAC,GAAG,KAAK,iCAAiC,CAAC,CAAC;IACtH,MAAM,MAAM,GAAG,KAAgC,CAAC;IAChD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,eAAe,CAAC,GAAG,KAAK,2CAA2C,CAAC,CAAC;IACzI,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1B,IAAI,GAAG,KAAK,SAAS,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,MAAM,IAAI,eAAe,CAAC,GAAG,KAAK,wBAAwB,CAAC,CAAC;IAC9G,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;IACpC,IAAI,QAAQ,KAAK,SAAS,IAAI,OAAO,QAAQ,KAAK,SAAS;QAAE,MAAM,IAAI,eAAe,CAAC,GAAG,KAAK,kCAAkC,CAAC,CAAC;IACnI,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,KAAK,QAAQ,CAAC,CAAC;IAC7D,MAAM,YAAY,GAAG,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,GAAG,KAAK,eAAe,CAAC,CAAC;IAClF,OAAO;QACH,IAAI;QACJ,GAAG,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC;QACrC,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;QAC/C,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;QACzC,GAAG,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC;KAC1D,CAAC;AACN,CAAC"}

package/dist/dictionary.d.ts

@@ -1,74 +1,9 @@
 /**
- * The optional local dictionary of approved words.
- *
- * The ASD-STE100 dictionary is copyrighted. This package does not contain
- * it, and the repository must not contain it. Each user makes a local file
- * from their own copy of the standard. Keep that file outside the
- * repository, or in a git-ignored folder, for example `.ste/`.
- *
- * File format (JSON). The short form is an array of approved words:
- *
- * ```json
- * ["a", "about", "make", "makes", "made"]
- * ```
- *
- * The full form is an object with entries:
- *
- * ```json
- * {
- *   "format": "ste-lint-dictionary",
- *   "version": 1,
- *   "entries": [
- *     { "word": "make", "pos": "verb", "forms": ["makes", "made"] },
- *     { "word": "valve", "pos": "noun" },
- *     { "word": "utilize", "pos": "verb", "approved": false, "alternatives": ["use"] }
- *   ]
- * }
- * ```
- *
- * - `word` (necessary): the headword. A phrase, for example "make sure", approves each of its words.
- * - `pos`: the part of speech. A noun also permits its regular plural.
- * - `approved`: `false` for a word that is not approved. The default is `true`.
- * - `forms`: other approved forms, for example the past tense of a verb.
- * - `alternatives`: approved words to use instead of a word that is not approved.
+ * The local dictionary file. The format and the lookup are in
+ * `dictionary-core.ts`, which a browser can use. This module reads the file.
  */
-export type DictionaryEntry = {
-    readonly word: string;
-    readonly pos?: string;
-    readonly approved?: boolean;
-    readonly forms?: readonly string[];
-    readonly alternatives?: readonly string[];
-};
-export type DictionaryLookup = {
-    readonly status: "approved";
-} | {
-    readonly status: "not-approved";
-    readonly alternatives: readonly string[];
-} | {
-    readonly status: "unknown";
-};
-export declare const DICTIONARY_FORMAT = "ste-lint-dictionary";
-/** An error in a dictionary file. */
-export declare class DictionaryError extends Error {
-    readonly name: string;
-}
-/** The approved words of a local dictionary. */
-export declare class Dictionary {
-    private readonly approved;
-    private readonly approvedNouns;
-    private readonly notApproved;
-    /** The approved nouns. The noun-cluster rule uses them. */
-    readonly nouns: Set<string>;
-    /** The approved verbs. The imperative and missing-subject heuristics use them. */
-    readonly verbs: Set<string>;
-    constructor(entries: readonly DictionaryEntry[]);
-    /** The number of approved words and forms. */
-    get size(): number;
-    /** The status of `word` in the dictionary. */
-    lookup(word: string): DictionaryLookup;
-}
-/** This function makes a dictionary from parsed JSON. `source` is the file name for error messages. */
-export declare function parseDictionary(value: unknown, source: string): Dictionary;
+import { type Dictionary } from "./dictionary-core.js";
+export * from "./dictionary-core.js";
 /** This function reads a dictionary file. */
 export declare function loadDictionary(path: string): Dictionary;
 //# sourceMappingURL=dictionary.d.ts.map

package/dist/dictionary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dictionary.d.ts","sourceRoot":"","sources":["../src/dictionary.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAIH,MAAM,MAAM,eAAe,GAAG;IAC1B,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAC;IACvB,QAAQ,CAAC,GAAG,CAAC,EAAG,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,CAAC,EAAG,OAAO,CAAC;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAG,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,YAAY,CAAC,EAAG,SAAS,MAAM,EAAE,CAAC;CAC9C,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACtB;IAAE,QAAQ,CAAC,MAAM,EAAG,UAAU,CAAA;CAAE,GAChC;IAAE,QAAQ,CAAC,MAAM,EAAG,cAAc,CAAC;IAAC,QAAQ,CAAC,YAAY,EAAG,SAAS,MAAM,EAAE,CAAA;CAAE,GAC/E;IAAE,QAAQ,CAAC,MAAM,EAAG,SAAS,CAAA;CAAE,CAAC;AAEtC,eAAO,MAAM,iBAAiB,wBAAwB,CAAC;AAEvD,qCAAqC;AACrC,qBAAa,eAAgB,SAAQ,KAAK;IACtC,SAAkB,IAAI,EAAG,MAAM,CAAqB;CACvD;AAID,gDAAgD;AAChD,qBAAa,UAAU;IACnB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IAC9C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IACnD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAwC;IACpE,2DAA2D;IAC3D,QAAQ,CAAC,KAAK,EAAG,GAAG,CAAC,MAAM,CAAC,CAAqB;IACjD,kFAAkF;IAClF,QAAQ,CAAC,KAAK,EAAG,GAAG,CAAC,MAAM,CAAC,CAAqB;gBAErC,OAAO,EAAG,SAAS,eAAe,EAAE;IAkBhD,8CAA8C;IAC9C,IAAI,IAAI,IAAK,MAAM,CAElB;IAED,8CAA8C;IAC9C,MAAM,CAAC,IAAI,EAAG,MAAM,GAAI,gBAAgB;CAe3C;AAED,uGAAuG;AACvG,wBAAgB,eAAe,CAAC,KAAK,EAAG,OAAO,EAAE,MAAM,EAAG,MAAM,GAAI,UAAU,CAmB7E;AA+BD,6CAA6C;AAC7C,wBAAgB,cAAc,CAAC,IAAI,EAAG,MAAM,GAAI,UAAU,CAczD"}
+{"version":3,"file":"dictionary.d.ts","sourceRoot":"","sources":["../src/dictionary.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAoC,KAAK,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAEzF,cAAc,sBAAsB,CAAC;AAErC,6CAA6C;AAC7C,wBAAgB,cAAc,CAAC,IAAI,EAAG,MAAM,GAAI,UAAU,CAczD"}

package/dist/dictionary.js

@@ -1,153 +1,10 @@
 /**
- * The optional local dictionary of approved words.
- *
- * The ASD-STE100 dictionary is copyrighted. This package does not contain
- * it, and the repository must not contain it. Each user makes a local file
- * from their own copy of the standard. Keep that file outside the
- * repository, or in a git-ignored folder, for example `.ste/`.
- *
- * File format (JSON). The short form is an array of approved words:
- *
- * ```json
- * ["a", "about", "make", "makes", "made"]
- * ```
- *
- * The full form is an object with entries:
- *
- * ```json
- * {
- *   "format": "ste-lint-dictionary",
- *   "version": 1,
- *   "entries": [
- *     { "word": "make", "pos": "verb", "forms": ["makes", "made"] },
- *     { "word": "valve", "pos": "noun" },
- *     { "word": "utilize", "pos": "verb", "approved": false, "alternatives": ["use"] }
- *   ]
- * }
- * ```
- *
- * - `word` (necessary): the headword. A phrase, for example "make sure", approves each of its words.
- * - `pos`: the part of speech. A noun also permits its regular plural.
- * - `approved`: `false` for a word that is not approved. The default is `true`.
- * - `forms`: other approved forms, for example the past tense of a verb.
- * - `alternatives`: approved words to use instead of a word that is not approved.
+ * The local dictionary file. The format and the lookup are in
+ * `dictionary-core.ts`, which a browser can use. This module reads the file.
  */
 import { readFileSync } from "node:fs";
-export const DICTIONARY_FORMAT = "ste-lint-dictionary";
-/** An error in a dictionary file. */
-export class DictionaryError extends Error {
-    name = "DictionaryError";
-}
-const normalize = (word) => word.trim().toLowerCase().replace(/[’‘]/g, "'");
-/** The approved words of a local dictionary. */
-export class Dictionary {
-    approved = new Set();
-    approvedNouns = new Set();
-    notApproved = new Map();
-    /** The approved nouns. The noun-cluster rule uses them. */
-    nouns = new Set();
-    /** The approved verbs. The imperative and missing-subject heuristics use them. */
-    verbs = new Set();
-    constructor(entries) {
-        for (const entry of entries) {
-            const words = [entry.word, ...(entry.forms ?? [])].flatMap((form) => normalize(form).split(/\s+/)).filter((form) => form.length > 0);
-            if (entry.approved === false) {
-                for (const word of words)
-                    this.notApproved.set(word, entry.alternatives ?? []);
-                continue;
-            }
-            for (const word of words)
-                this.approved.add(word);
-            const pos = (entry.pos ?? "").toLowerCase();
-            const base = normalize(entry.word);
-            if (pos === "n" || pos === "noun") {
-                this.approvedNouns.add(base);
-                this.nouns.add(base);
-            }
-            if (pos === "v" || pos === "verb")
-                this.verbs.add(base);
-        }
-    }
-    /** The number of approved words and forms. */
-    get size() {
-        return this.approved.size;
-    }
-    /** The status of `word` in the dictionary. */
-    lookup(word) {
-        const lower = normalize(word);
-        const candidates = [lower];
-        if (lower.endsWith("'s"))
-            candidates.push(lower.slice(0, -2));
-        for (const candidate of candidates) {
-            if (this.approved.has(candidate))
-                return { status: "approved" };
-            const plurals = [candidate.slice(0, -1), candidate.slice(0, -2), candidate.slice(0, -3) + "y"];
-            if (candidate.endsWith("s") && plurals.some((singular) => this.approvedNouns.has(singular)))
-                return { status: "approved" };
-        }
-        for (const candidate of candidates) {
-            const alternatives = this.notApproved.get(candidate);
-            if (alternatives !== undefined)
-                return { status: "not-approved", alternatives };
-        }
-        return { status: "unknown" };
-    }
-}
-/** This function makes a dictionary from parsed JSON. `source` is the file name for error messages. */
-export function parseDictionary(value, source) {
-    if (Array.isArray(value)) {
-        if (!value.every((word) => typeof word === "string")) {
-            throw new DictionaryError(`${source}: the array form must contain only strings.`);
-        }
-        return new Dictionary(value.map((word) => ({ word })));
-    }
-    if (typeof value !== "object" || value === null) {
-        throw new DictionaryError(`${source}: the file must contain an array of words or an object with "entries".`);
-    }
-    const record = value;
-    const format = record["format"];
-    if (format !== undefined && format !== DICTIONARY_FORMAT) {
-        throw new DictionaryError(`${source}: "format" must be "${DICTIONARY_FORMAT}".`);
-    }
-    const entries = record["entries"];
-    if (!Array.isArray(entries))
-        throw new DictionaryError(`${source}: "entries" must be an array.`);
-    const parsed = entries.map((entry, index) => parseEntry(entry, `${source}: entries[${index}]`));
-    return new Dictionary(parsed);
-}
-function stringArray(value, where) {
-    if (value === undefined)
-        return undefined;
-    if (!Array.isArray(value) || !value.every((item) => typeof item === "string")) {
-        throw new DictionaryError(`${where} must be an array of strings.`);
-    }
-    return value;
-}
-function parseEntry(entry, where) {
-    if (typeof entry === "string")
-        return { word: entry };
-    if (typeof entry !== "object" || entry === null)
-        throw new DictionaryError(`${where} must be a string or an object.`);
-    const record = entry;
-    const word = record["word"];
-    if (typeof word !== "string" || word.trim().length === 0)
-        throw new DictionaryError(`${where}.word must be a string that is not empty.`);
-    const pos = record["pos"];
-    if (pos !== undefined && typeof pos !== "string")
-        throw new DictionaryError(`${where}.pos must be a string.`);
-    const approved = record["approved"];
-    if (approved !== undefined && typeof approved !== "boolean")
-        throw new DictionaryError(`${where}.approved must be true or false.`);
-    const forms = stringArray(record["forms"], `${where}.forms`);
-    const alternatives = stringArray(record["alternatives"], `${where}.alternatives`);
-    return {
-        word,
-        ...(pos === undefined ? {} : { pos }),
-        ...(approved === undefined ? {} : { approved }),
-        ...(forms === undefined ? {} : { forms }),
-        ...(alternatives === undefined ? {} : { alternatives }),
-    };
-}
+import { DictionaryError, parseDictionary } from "./dictionary-core.js";
+export * from "./dictionary-core.js";
 /** This function reads a dictionary file. */
 export function loadDictionary(path) {
     let text;

package/dist/dictionary.js.map

@@ -1 +1 @@
-{"version":3,"file":"dictionary.js","sourceRoot":"","sources":["../src/dictionary.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAevC,MAAM,CAAC,MAAM,iBAAiB,GAAG,qBAAqB,CAAC;AAEvD,qCAAqC;AACrC,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACpB,IAAI,GAAY,iBAAiB,CAAC;CACvD;AAED,MAAM,SAAS,GAAG,CAAC,IAAa,EAAW,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AAE9F,gDAAgD;AAChD,MAAM,OAAO,UAAU;IACF,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IAC7B,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,WAAW,GAAG,IAAI,GAAG,EAA6B,CAAC;IACpE,2DAA2D;IAClD,KAAK,GAAiB,IAAI,GAAG,EAAU,CAAC;IACjD,kFAAkF;IACzE,KAAK,GAAiB,IAAI,GAAG,EAAU,CAAC;IAEjD,YAAY,OAAoC;QAC5C,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC1B,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACrI,IAAI,KAAK,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;gBAC3B,KAAK,MAAM,IAAI,IAAI,KAAK;oBAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;gBAC/E,SAAS;YACb,CAAC;YACD,KAAK,MAAM,IAAI,IAAI,KAAK;gBAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;YAC5C,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACnC,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;gBAChC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC7B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACzB,CAAC;YACD,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,MAAM;gBAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5D,CAAC;IACL,CAAC;IAED,8CAA8C;IAC9C,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC9B,CAAC;IAED,8CAA8C;IAC9C,MAAM,CAAC,IAAa;QAChB,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3B,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9D,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACjC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC;gBAAE,OAAO,EAAE,MAAM,EAAG,UAAU,EAAE,CAAC;YACjE,MAAM,OAAO,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;YAC/F,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAAE,OAAO,EAAE,MAAM,EAAG,UAAU,EAAE,CAAC;QAChI,CAAC;QACD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACjC,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACrD,IAAI,YAAY,KAAK,SAAS;gBAAE,OAAO,EAAE,MAAM,EAAG,cAAc,EAAE,YAAY,EAAE,CAAC;QACrF,CAAC;QACD,OAAO,EAAE,MAAM,EAAG,SAAS,EAAE,CAAC;IAClC,CAAC;CACJ;AAED,uGAAuG;AACvG,MAAM,UAAU,eAAe,CAAC,KAAe,EAAE,MAAe;IAC5D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,eAAe,CAAC,GAAG,MAAM,6CAA6C,CAAC,CAAC;QACtF,CAAC;QACD,OAAO,IAAI,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAa,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAC9C,MAAM,IAAI,eAAe,CAAC,GAAG,MAAM,wEAAwE,CAAC,CAAC;IACjH,CAAC;IACD,MAAM,MAAM,GAAG,KAAgC,CAAC;IAChD,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;IAChC,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,iBAAiB,EAAE,CAAC;QACvD,MAAM,IAAI,eAAe,CAAC,GAAG,MAAM,uBAAuB,iBAAiB,IAAI,CAAC,CAAC;IACrF,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;QAAE,MAAM,IAAI,eAAe,CAAC,GAAG,MAAM,+BAA+B,CAAC,CAAC;IACjG,MAAM,MAAM,GAAuB,OAAO,CAAC,GAAG,CAAC,CAAC,KAAe,EAAE,KAAc,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,MAAM,aAAa,KAAK,GAAG,CAAC,CAAC,CAAC;IACvI,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,WAAW,CAAC,KAAe,EAAE,KAAc;IAChD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,EAAE,CAAC;QAC5E,MAAM,IAAI,eAAe,CAAC,GAAG,KAAK,+BAA+B,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,KAAiB,CAAC;AAC7B,CAAC;AAED,SAAS,UAAU,CAAC,KAAe,EAAE,KAAc;IAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,EAAE,IAAI,EAAG,KAAK,EAAE,CAAC;IACvD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,MAAM,IAAI,eAAe,CAAC,GAAG,KAAK,iCAAiC,CAAC,CAAC;IACtH,MAAM,MAAM,GAAG,KAAgC,CAAC;IAChD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,eAAe,CAAC,GAAG,KAAK,2CAA2C,CAAC,CAAC;IACzI,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1B,IAAI,GAAG,KAAK,SAAS,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,MAAM,IAAI,eAAe,CAAC,GAAG,KAAK,wBAAwB,CAAC,CAAC;IAC9G,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;IACpC,IAAI,QAAQ,KAAK,SAAS,IAAI,OAAO,QAAQ,KAAK,SAAS;QAAE,MAAM,IAAI,eAAe,CAAC,GAAG,KAAK,kCAAkC,CAAC,CAAC;IACnI,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,KAAK,QAAQ,CAAC,CAAC;IAC7D,MAAM,YAAY,GAAG,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,GAAG,KAAK,eAAe,CAAC,CAAC;IAClF,OAAO;QACH,IAAI;QACJ,GAAG,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC;QACrC,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;QAC/C,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;QACzC,GAAG,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC;KAC1D,CAAC;AACN,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,cAAc,CAAC,IAAa;IACxC,IAAI,IAAa,CAAC;IAClB,IAAI,CAAC;QACD,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,eAAe,CAAC,mCAAmC,IAAI,KAAM,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IACD,IAAI,KAAe,CAAC;IACpB,IAAI,CAAC;QACD,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,eAAe,CAAC,GAAG,IAAI,iCAAkC,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IACD,OAAO,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACxC,CAAC"}
+{"version":3,"file":"dictionary.js","sourceRoot":"","sources":["../src/dictionary.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,eAAe,EAAmB,MAAM,sBAAsB,CAAC;AAEzF,cAAc,sBAAsB,CAAC;AAErC,6CAA6C;AAC7C,MAAM,UAAU,cAAc,CAAC,IAAa;IACxC,IAAI,IAAa,CAAC;IAClB,IAAI,CAAC;QACD,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,eAAe,CAAC,mCAAmC,IAAI,KAAM,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IACD,IAAI,KAAe,CAAC;IACpB,IAAI,CAAC;QACD,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,eAAe,CAAC,GAAG,IAAI,iCAAkC,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IACD,OAAO,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACxC,CAAC"}

package/dist/engine.d.ts

@@ -0,0 +1,44 @@
+/**
+ * The lint engine without a file system. It extracts the prose of a text,
+ * runs the rules on each prose unit, and gives the findings with their lines
+ * and columns. A browser can use this module.
+ */
+import type { ResolvedConfig } from "./config-core.js";
+import { type Lexicon } from "./lexicon.js";
+import { type Extraction } from "./source/markdown.js";
+import type { Finding } from "./types.js";
+import { type ProseUnit } from "./units.js";
+export type FileKind = "markdown" | "mdx" | "typescript";
+/** The kind of a file, from its extension, or null when the linter cannot read it. */
+export declare function fileKind(path: string): FileKind | null;
+/**
+ * A function that extracts the prose of a TypeScript or JavaScript file:
+ * the doc comments, and the JSX text of a TSX or JSX file.
+ */
+export type CodeExtractor = (text: string, path: string) => Extraction;
+export type ProseLinterOptions = {
+    /**
+     * The extractor for TypeScript and JavaScript files. Without it, the
+     * linter gives no findings for these files. The extractor of this
+     * package (`extractCode`) needs the `typescript` package.
+     */
+    readonly extractCode?: CodeExtractor;
+};
+/**
+ * A linter for one configuration, for text in memory. It makes the lexicon
+ * and the word list matcher one time. It reads no file.
+ */
+export declare class ProseLinter {
+    readonly config: ResolvedConfig;
+    readonly lexicon: Lexicon;
+    private readonly wordList;
+    private readonly rules;
+    private readonly extractCode;
+    constructor(config: ResolvedConfig, lexicon?: Lexicon, options?: ProseLinterOptions);
+    /** The prose units of a file. */
+    units(text: string, path: string): ProseUnit[];
+    /** The findings in `text`. `path` gives the kind of file, and it is the file name in the findings. */
+    lintText(text: string, path: string): Finding[];
+    private extract;
+}
+//# sourceMappingURL=engine.d.ts.map

package/dist/engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../src/engine.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAgB,KAAK,OAAO,EAAE,MAAM,cAAc,CAAC;AAI1D,OAAO,EAAmB,KAAK,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAExE,OAAO,KAAK,EAAE,OAAO,EAAoB,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAa,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvD,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,KAAK,GAAG,YAAY,CAAC;AAEzD,sFAAsF;AACtF,wBAAgB,QAAQ,CAAC,IAAI,EAAG,MAAM,GAAI,QAAQ,GAAG,IAAI,CAMxD;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,IAAI,EAAG,MAAM,EAAE,IAAI,EAAG,MAAM,KAAK,UAAU,CAAC;AAEzE,MAAM,MAAM,kBAAkB,GAAG;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAG,aAAa,CAAC;CACzC,CAAC;AAEF;;;GAGG;AACH,qBAAa,WAAW;IAMR,QAAQ,CAAC,MAAM,EAAG,cAAc;IAL5C,QAAQ,CAAC,OAAO,EAAG,OAAO,CAAC;IAC3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgF;IACtG,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAwB;gBAE/B,MAAM,EAAG,cAAc,EAAE,OAAO,CAAC,EAAG,OAAO,EAAE,OAAO,GAAG,kBAAuB;IAYnG,iCAAiC;IACjC,KAAK,CAAC,IAAI,EAAG,MAAM,EAAE,IAAI,EAAG,MAAM,GAAI,SAAS,EAAE;IAIjD,sGAAsG;IACtG,QAAQ,CAAC,IAAI,EAAG,MAAM,EAAE,IAAI,EAAG,MAAM,GAAI,OAAO,EAAE;IAoDlD,OAAO,CAAC,OAAO;CAMlB"}