@mark1russell7/ste-lint 0.1.1 → 0.1.2

package/dist/config-core.js

@@ -0,0 +1,198 @@
+/**
+ * The parts of the configuration that need no file system: the types of
+ * `ste.config.json`, the defaults, the validation and the word list merge.
+ * A browser can use this module.
+ */
+import { isRuleId, RULE_IDS } from "./types.js";
+import { DEFAULT_WORD_LIST } from "./word-list.js";
+export const CONFIG_FILE_NAME = "ste.config.json";
+/** The environment variable that gives the path of the local dictionary. It has priority over `dictionaryPath`. */
+export const DICTIONARY_ENV = "STE_DICTIONARY";
+export const DEFAULT_INCLUDE = [
+    "README.md",
+    "docs/**/*.{md,mdx}",
+    "packages/*/README.md",
+    "packages/*/src/**/*.{ts,tsx}",
+    "packages/*/build/**/*.{ts,tsx}",
+    "packages/*/commands/**/*.{ts,tsx}",
+    "packages/*/*.config.{ts,mts}",
+];
+export const DEFAULT_IGNORE = [
+    "**/node_modules/**",
+    "**/dist/**",
+    "**/*.d.ts",
+    "**/*.test.ts",
+    "**/*.test.tsx",
+    "**/*.spec.ts",
+    "**/*.spec.tsx",
+];
+export const DEFAULT_LIMITS = {
+    instructionWords: 20,
+    descriptionWords: 25,
+    paragraphSentences: 6,
+    nounClusterNouns: 3,
+};
+/** An error in the configuration. */
+export class ConfigError extends Error {
+    name = "ConfigError";
+}
+const SETTINGS = ["error", "warning", "off"];
+const KNOWN_KEYS = new Set([
+    "$schema", "include", "ignore", "technicalNouns", "technicalVerbs", "properNouns", "allowedWords",
+    "rules", "wordList", "limits", "dictionaryPath",
+]);
+const WORD_LIST_KEYS = new Set(["id", "match", "suggest", "note", "severity", "verbOnly"]);
+/** This function makes sure that `value` is a valid configuration. It throws a `ConfigError` that lists all problems. */
+export function validateConfig(value, source) {
+    const problems = [];
+    if (typeof value !== "object" || value === null || Array.isArray(value)) {
+        throw new ConfigError(`${source}: the configuration must be a JSON object.`);
+    }
+    const record = value;
+    for (const key of Object.keys(record)) {
+        if (!KNOWN_KEYS.has(key))
+            problems.push(`"${key}" is not a known property. Known properties: ${[...KNOWN_KEYS].join(", ")}.`);
+    }
+    for (const key of ["include", "ignore", "technicalNouns", "technicalVerbs", "properNouns", "allowedWords"]) {
+        const item = record[key];
+        if (item !== undefined && !(Array.isArray(item) && item.every((entry) => typeof entry === "string"))) {
+            problems.push(`"${key}" must be an array of strings.`);
+        }
+    }
+    const rules = record["rules"];
+    if (rules !== undefined) {
+        if (typeof rules !== "object" || rules === null || Array.isArray(rules)) {
+            problems.push(`"rules" must be an object.`);
+        }
+        else {
+            for (const [id, setting] of Object.entries(rules)) {
+                if (!isRuleId(id))
+                    problems.push(`"rules.${id}" is not a known rule. Known rules: ${RULE_IDS.join(", ")}.`);
+                if (typeof setting !== "string" || !SETTINGS.includes(setting))
+                    problems.push(`"rules.${id}" must be "error", "warning" or "off".`);
+            }
+        }
+    }
+    const limits = record["limits"];
+    if (limits !== undefined) {
+        if (typeof limits !== "object" || limits === null || Array.isArray(limits)) {
+            problems.push(`"limits" must be an object.`);
+        }
+        else {
+            for (const [key, limit] of Object.entries(limits)) {
+                if (!Object.hasOwn(DEFAULT_LIMITS, key))
+                    problems.push(`"limits.${key}" is not a known limit. Known limits: ${Object.keys(DEFAULT_LIMITS).join(", ")}.`);
+                if (typeof limit !== "number" || !Number.isInteger(limit) || limit < 1)
+                    problems.push(`"limits.${key}" must be an integer of 1 or more.`);
+            }
+        }
+    }
+    const dictionaryPath = record["dictionaryPath"];
+    if (dictionaryPath !== undefined && dictionaryPath !== null && typeof dictionaryPath !== "string") {
+        problems.push(`"dictionaryPath" must be a string or null.`);
+    }
+    const wordList = record["wordList"];
+    if (wordList !== undefined) {
+        if (!Array.isArray(wordList)) {
+            problems.push(`"wordList" must be an array.`);
+        }
+        else {
+            wordList.forEach((item, index) => problems.push(...validateWordListEntry(item, `wordList[${index}]`)));
+        }
+    }
+    if (problems.length > 0)
+        throw new ConfigError(`${source}:\n  - ${problems.join("\n  - ")}`);
+    return record;
+}
+function validateWordListEntry(item, where) {
+    if (typeof item !== "object" || item === null || Array.isArray(item))
+        return [`"${where}" must be an object.`];
+    const problems = [];
+    const entry = item;
+    for (const key of Object.keys(entry)) {
+        if (!WORD_LIST_KEYS.has(key))
+            problems.push(`"${where}.${key}" is not a known property.`);
+    }
+    const match = entry["match"];
+    const matchValid = typeof match === "string" || (Array.isArray(match) && match.length > 0 && match.every((word) => typeof word === "string"));
+    if (match !== undefined && !matchValid)
+        problems.push(`"${where}.match" must be a string or an array of strings.`);
+    if (entry["id"] !== undefined && typeof entry["id"] !== "string")
+        problems.push(`"${where}.id" must be a string.`);
+    if (entry["id"] === undefined && match === undefined)
+        problems.push(`"${where}" must have "id" or "match".`);
+    for (const key of ["suggest", "note"]) {
+        const text = entry[key];
+        if (text !== undefined && text !== null && typeof text !== "string")
+            problems.push(`"${where}.${key}" must be a string or null.`);
+    }
+    const severity = entry["severity"];
+    if (severity !== undefined && (typeof severity !== "string" || !SETTINGS.includes(severity)))
+        problems.push(`"${where}.severity" must be "error", "warning" or "off".`);
+    if (entry["verbOnly"] !== undefined && typeof entry["verbOnly"] !== "boolean")
+        problems.push(`"${where}.verbOnly" must be true or false.`);
+    return problems;
+}
+/**
+ * This function merges the default word list and the entries of the
+ * configuration. An entry with the ID (or the first `match` word) of a
+ * default entry changes that entry. The severity "off" removes the entry
+ * with that ID, and it removes the `match` words from all entries.
+ */
+export function mergeWordList(defaults, overrides) {
+    const entries = new Map(defaults.map((entry) => [entry.id, entry]));
+    for (const override of overrides) {
+        const match = override.match === undefined ? undefined : typeof override.match === "string" ? [override.match] : [...override.match];
+        const id = override.id ?? match[0];
+        const base = entries.get(id) ?? null;
+        if (override.severity === "off") {
+            entries.set(id, null);
+            const removed = new Set((match ?? []).map((word) => word.toLowerCase()));
+            for (const [key, entry] of entries) {
+                if (entry === null)
+                    continue;
+                const kept = entry.match.filter((word) => !removed.has(word.toLowerCase()));
+                entries.set(key, kept.length === 0 ? null : { ...entry, match: kept });
+            }
+            continue;
+        }
+        const merged = {
+            id,
+            match: match ?? base?.match ?? [id],
+            suggest: override.suggest !== undefined ? override.suggest : base?.suggest ?? null,
+            note: override.note !== undefined ? override.note : base?.note ?? null,
+            severity: override.severity ?? base?.severity ?? "error",
+            verbOnly: override.verbOnly ?? base?.verbOnly ?? false,
+            context: base?.context ?? null,
+        };
+        entries.set(id, merged);
+    }
+    return [...entries.values()].filter((entry) => entry !== null);
+}
+/**
+ * This function applies the defaults to a configuration file. It reads no
+ * file and no environment variable, thus the result has no dictionary path.
+ */
+export function baseConfig(file = {}, options = {}) {
+    const rules = {};
+    for (const [id, setting] of Object.entries(file.rules ?? {})) {
+        if (isRuleId(id))
+            rules[id] = setting;
+    }
+    return {
+        root: options.root ?? "",
+        configFile: options.configFile ?? null,
+        include: file.include ?? DEFAULT_INCLUDE,
+        ignore: file.ignore ?? DEFAULT_IGNORE,
+        technicalNouns: file.technicalNouns ?? [],
+        technicalVerbs: file.technicalVerbs ?? [],
+        properNouns: file.properNouns ?? [],
+        allowedWords: file.allowedWords ?? [],
+        rules,
+        wordList: mergeWordList(DEFAULT_WORD_LIST, file.wordList ?? []),
+        limits: { ...DEFAULT_LIMITS, ...file.limits },
+        dictionaryPath: null,
+        dictionarySource: null,
+    };
+}
+//# sourceMappingURL=config-core.js.map

package/dist/config-core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-core.js","sourceRoot":"","sources":["../src/config-core.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAgD,MAAM,YAAY,CAAC;AAC9F,OAAO,EAAE,iBAAiB,EAAsB,MAAM,gBAAgB,CAAC;AAEvE,MAAM,CAAC,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAElD,mHAAmH;AACnH,MAAM,CAAC,MAAM,cAAc,GAAG,gBAAgB,CAAC;AA8D/C,MAAM,CAAC,MAAM,eAAe,GAAuB;IAC/C,WAAW;IACX,oBAAoB;IACpB,sBAAsB;IACtB,8BAA8B;IAC9B,gCAAgC;IAChC,mCAAmC;IACnC,8BAA8B;CACjC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAuB;IAC9C,oBAAoB;IACpB,YAAY;IACZ,WAAW;IACX,cAAc;IACd,eAAe;IACf,cAAc;IACd,eAAe;CAClB,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAY;IACnC,gBAAgB,EAAG,EAAE;IACrB,gBAAgB,EAAG,EAAE;IACrB,kBAAkB,EAAG,CAAC;IACtB,gBAAgB,EAAG,CAAC;CACvB,CAAC;AAEF,qCAAqC;AACrC,MAAM,OAAO,WAAY,SAAQ,KAAK;IAChB,IAAI,GAAY,aAAa,CAAC;CACnD;AAED,MAAM,QAAQ,GAAuB,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;AAEjE,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC;IACvB,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,aAAa,EAAE,cAAc;IACjG,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,gBAAgB;CAClD,CAAC,CAAC;AAEH,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;AAE3F,yHAAyH;AACzH,MAAM,UAAU,cAAc,CAAC,KAAe,EAAE,MAAe;IAC3D,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACtE,MAAM,IAAI,WAAW,CAAC,GAAG,MAAM,4CAA4C,CAAC,CAAC;IACjF,CAAC;IACD,MAAM,MAAM,GAAG,KAAgC,CAAC;IAChD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,GAAG,gDAAgD,CAAC,GAAG,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClI,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,aAAa,EAAE,cAAc,CAAC,EAAE,CAAC;QACzG,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,EAAE,CAAC;YACnG,QAAQ,CAAC,IAAI,CAAC,IAAI,GAAG,gCAAgC,CAAC,CAAC;QAC3D,CAAC;IACL,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACtE,QAAQ,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACJ,KAAK,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChD,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,uCAAuC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC5G,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;oBAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,wCAAwC,CAAC,CAAC;YACxI,CAAC;QACL,CAAC;IACL,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;IAChC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACzE,QAAQ,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;aAAM,CAAC;YACJ,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAChD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,GAAG,CAAC;oBAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,GAAG,yCAAyC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACzJ,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC;oBAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,GAAG,oCAAoC,CAAC,CAAC;YAC9I,CAAC;QACL,CAAC;IACL,CAAC;IACD,MAAM,cAAc,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAChD,IAAI,cAAc,KAAK,SAAS,IAAI,cAAc,KAAK,IAAI,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;QAChG,QAAQ,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;IACpC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3B,QAAQ,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YACJ,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAc,EAAE,KAAc,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,qBAAqB,CAAC,IAAI,EAAE,YAAY,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;QAC9H,CAAC;IACL,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,GAAG,MAAM,UAAU,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC7F,OAAO,MAAuB,CAAC;AACnC,CAAC;AAED,SAAS,qBAAqB,CAAC,IAAc,EAAE,KAAc;IACzD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,CAAC,IAAI,KAAK,sBAAsB,CAAC,CAAC;IAC/G,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,KAAK,GAAG,IAA+B,CAAC;IAC9C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACnC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,GAAG,4BAA4B,CAAC,CAAC;IAC9F,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,MAAM,UAAU,GAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC;IAC9I,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,UAAU;QAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,kDAAkD,CAAC,CAAC;IACnH,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,QAAQ;QAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,CAAC;IACnH,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS;QAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,8BAA8B,CAAC,CAAC;IAC7G,KAAK,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QACxB,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,GAAG,6BAA6B,CAAC,CAAC;IACtI,CAAC;IACD,MAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IACnC,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,iDAAiD,CAAC,CAAC;IACxK,IAAI,KAAK,CAAC,UAAU,CAAC,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,UAAU,CAAC,KAAK,SAAS;QAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,mCAAmC,CAAC,CAAC;IAC3I,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,QAAmC,EAAE,SAA0C;IACzG,MAAM,OAAO,GAAG,IAAI,GAAG,CAA+B,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAClG,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,QAAQ,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;QACrI,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAE,IAAI,KAAM,CAAC,CAAC,CAAE,CAAC;QACrC,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC;QACrC,IAAI,QAAQ,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YACtB,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;YACzE,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;gBACjC,IAAI,KAAK,KAAK,IAAI;oBAAE,SAAS;gBAC7B,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;gBAC5E,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,KAAK,EAAG,IAAI,EAAE,CAAC,CAAC;YAC5E,CAAC;YACD,SAAS;QACb,CAAC;QACD,MAAM,MAAM,GAAmB;YAC3B,EAAE;YACF,KAAK,EAAG,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;YACpC,OAAO,EAAG,QAAQ,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,IAAI,IAAI;YACnF,IAAI,EAAG,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,IAAI,IAAI;YACvE,QAAQ,EAAI,QAAQ,CAAC,QAAiC,IAAI,IAAI,EAAE,QAAQ,IAAI,OAAO;YACnF,QAAQ,EAAG,QAAQ,CAAC,QAAQ,IAAI,IAAI,EAAE,QAAQ,IAAI,KAAK;YACvD,OAAO,EAAG,IAAI,EAAE,OAAO,IAAI,IAAI;SAClC,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IAC5B,CAAC;IACD,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAA2B,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;AAC5F,CAAC;AAQD;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,OAAuB,EAAE,EAAE,UAA8B,EAAE;IAClF,MAAM,KAAK,GAA0C,EAAE,CAAC;IACxD,KAAK,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;QAC3D,IAAI,QAAQ,CAAC,EAAE,CAAC;YAAE,KAAK,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;IAC1C,CAAC;IACD,OAAO;QACH,IAAI,EAAG,OAAO,CAAC,IAAI,IAAI,EAAE;QACzB,UAAU,EAAG,OAAO,CAAC,UAAU,IAAI,IAAI;QACvC,OAAO,EAAG,IAAI,CAAC,OAAO,IAAI,eAAe;QACzC,MAAM,EAAG,IAAI,CAAC,MAAM,IAAI,cAAc;QACtC,cAAc,EAAG,IAAI,CAAC,cAAc,IAAI,EAAE;QAC1C,cAAc,EAAG,IAAI,CAAC,cAAc,IAAI,EAAE;QAC1C,WAAW,EAAG,IAAI,CAAC,WAAW,IAAI,EAAE;QACpC,YAAY,EAAG,IAAI,CAAC,YAAY,IAAI,EAAE;QACtC,KAAK;QACL,QAAQ,EAAG,aAAa,CAAC,iBAAiB,EAAE,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;QAChE,MAAM,EAAG,EAAE,GAAG,cAAc,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE;QAC9C,cAAc,EAAG,IAAI;QACrB,gBAAgB,EAAG,IAAI;KAC1B,CAAC;AACN,CAAC"}

package/dist/config.d.ts

@@ -2,82 +2,8 @@
  * The configuration file `ste.config.json`, and the configuration that the
  * linter uses after it reads the file, the environment and the defaults.
  */
-import { type RuleId, type RuleSetting } from "./types.js";
-import { type WordListEntry } from "./word-list.js";
-export declare const CONFIG_FILE_NAME = "ste.config.json";
-/** The environment variable that gives the path of the local dictionary. It has priority over `dictionaryPath`. */
-export declare const DICTIONARY_ENV = "STE_DICTIONARY";
-/** An entry of `wordList` in the configuration file. */
-export type WordListEntryConfig = {
-    /** The ID of a default entry to change. A new entry gets the first word of `match` as its ID. */
-    readonly id?: string;
-    readonly match?: string | readonly string[];
-    readonly suggest?: string | null;
-    readonly note?: string | null;
-    readonly severity?: RuleSetting;
-    readonly verbOnly?: boolean;
-};
-export type LimitsConfig = {
-    /** The maximum number of words in an instruction. Default: 20 (STE Rule 5.1). */
-    readonly instructionWords?: number;
-    /** The maximum number of words in a description. Default: 25 (STE Rule 6.3). */
-    readonly descriptionWords?: number;
-    /** The maximum number of sentences in a paragraph. Default: 6 (STE Rule 6.6). */
-    readonly paragraphSentences?: number;
-    /** The maximum number of nouns in a noun cluster. Default: 3 (STE Rule 2.1). */
-    readonly nounClusterNouns?: number;
-};
-/** The contents of `ste.config.json`. All properties are optional. */
-export type SteConfigFile = {
-    readonly $schema?: string;
-    readonly include?: readonly string[];
-    readonly ignore?: readonly string[];
-    readonly technicalNouns?: readonly string[];
-    readonly technicalVerbs?: readonly string[];
-    readonly properNouns?: readonly string[];
-    readonly allowedWords?: readonly string[];
-    readonly rules?: Readonly<Record<string, RuleSetting>>;
-    readonly wordList?: readonly WordListEntryConfig[];
-    readonly limits?: LimitsConfig;
-    readonly dictionaryPath?: string | null;
-};
-export type Limits = Required<LimitsConfig>;
-export type ResolvedConfig = {
-    /** The directory that `include` and `ignore` are relative to. */
-    readonly root: string;
-    /** The configuration file, or null when the linter uses the defaults. */
-    readonly configFile: string | null;
-    readonly include: readonly string[];
-    readonly ignore: readonly string[];
-    readonly technicalNouns: readonly string[];
-    readonly technicalVerbs: readonly string[];
-    readonly properNouns: readonly string[];
-    readonly allowedWords: readonly string[];
-    /** The rule settings from the configuration. A rule without a setting uses its default severity. */
-    readonly rules: Readonly<Partial<Record<RuleId, RuleSetting>>>;
-    readonly wordList: readonly WordListEntry[];
-    readonly limits: Limits;
-    /** The absolute path of the local dictionary, or null. */
-    readonly dictionaryPath: string | null;
-    /** Where the dictionary path came from. */
-    readonly dictionarySource: "env" | "config" | null;
-};
-export declare const DEFAULT_INCLUDE: readonly string[];
-export declare const DEFAULT_IGNORE: readonly string[];
-export declare const DEFAULT_LIMITS: Limits;
-/** An error in the configuration. */
-export declare class ConfigError extends Error {
-    readonly name: string;
-}
-/** This function makes sure that `value` is a valid configuration. It throws a `ConfigError` that lists all problems. */
-export declare function validateConfig(value: unknown, source: string): SteConfigFile;
-/**
- * This function merges the default word list and the entries of the
- * configuration. An entry with the ID (or the first `match` word) of a
- * default entry changes that entry. The severity "off" removes the entry
- * with that ID, and it removes the `match` words from all entries.
- */
-export declare function mergeWordList(defaults: readonly WordListEntry[], overrides: readonly WordListEntryConfig[]): WordListEntry[];
+import { type ResolvedConfig, type SteConfigFile } from "./config-core.js";
+export * from "./config-core.js";
 /** This function expands a leading `~/` to the home directory, and makes the path absolute. */
 export declare function resolvePath(path: string, base: string): string;
 export type ResolveOptions = {

package/dist/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAsB,KAAK,MAAM,EAAE,KAAK,WAAW,EAAiB,MAAM,YAAY,CAAC;AAC9F,OAAO,EAAqB,KAAK,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEvE,eAAO,MAAM,gBAAgB,oBAAoB,CAAC;AAElD,mHAAmH;AACnH,eAAO,MAAM,cAAc,mBAAmB,CAAC;AAE/C,wDAAwD;AACxD,MAAM,MAAM,mBAAmB,GAAG;IAC9B,iGAAiG;IACjG,QAAQ,CAAC,EAAE,CAAC,EAAG,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,CAAC,EAAG,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC;IAC7C,QAAQ,CAAC,OAAO,CAAC,EAAG,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,IAAI,CAAC,EAAG,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,QAAQ,CAAC,EAAG,WAAW,CAAC;IACjC,QAAQ,CAAC,QAAQ,CAAC,EAAG,OAAO,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACvB,iFAAiF;IACjF,QAAQ,CAAC,gBAAgB,CAAC,EAAG,MAAM,CAAC;IACpC,gFAAgF;IAChF,QAAQ,CAAC,gBAAgB,CAAC,EAAG,MAAM,CAAC;IACpC,iFAAiF;IACjF,QAAQ,CAAC,kBAAkB,CAAC,EAAG,MAAM,CAAC;IACtC,gFAAgF;IAChF,QAAQ,CAAC,gBAAgB,CAAC,EAAG,MAAM,CAAC;CACvC,CAAC;AAEF,sEAAsE;AACtE,MAAM,MAAM,aAAa,GAAG;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAG,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAG,SAAS,MAAM,EAAE,CAAC;IACtC,QAAQ,CAAC,MAAM,CAAC,EAAG,SAAS,MAAM,EAAE,CAAC;IACrC,QAAQ,CAAC,cAAc,CAAC,EAAG,SAAS,MAAM,EAAE,CAAC;IAC7C,QAAQ,CAAC,cAAc,CAAC,EAAG,SAAS,MAAM,EAAE,CAAC;IAC7C,QAAQ,CAAC,WAAW,CAAC,EAAG,SAAS,MAAM,EAAE,CAAC;IAC1C,QAAQ,CAAC,YAAY,CAAC,EAAG,SAAS,MAAM,EAAE,CAAC;IAC3C,QAAQ,CAAC,KAAK,CAAC,EAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;IACxD,QAAQ,CAAC,QAAQ,CAAC,EAAG,SAAS,mBAAmB,EAAE,CAAC;IACpD,QAAQ,CAAC,MAAM,CAAC,EAAG,YAAY,CAAC;IAChC,QAAQ,CAAC,cAAc,CAAC,EAAG,MAAM,GAAG,IAAI,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC;AAE5C,MAAM,MAAM,cAAc,GAAG;IACzB,iEAAiE;IACjE,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAC;IACvB,yEAAyE;IACzE,QAAQ,CAAC,UAAU,EAAG,MAAM,GAAG,IAAI,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAG,SAAS,MAAM,EAAE,CAAC;IACrC,QAAQ,CAAC,MAAM,EAAG,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,cAAc,EAAG,SAAS,MAAM,EAAE,CAAC;IAC5C,QAAQ,CAAC,cAAc,EAAG,SAAS,MAAM,EAAE,CAAC;IAC5C,QAAQ,CAAC,WAAW,EAAG,SAAS,MAAM,EAAE,CAAC;IACzC,QAAQ,CAAC,YAAY,EAAG,SAAS,MAAM,EAAE,CAAC;IAC1C,oGAAoG;IACpG,QAAQ,CAAC,KAAK,EAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAChE,QAAQ,CAAC,QAAQ,EAAG,SAAS,aAAa,EAAE,CAAC;IAC7C,QAAQ,CAAC,MAAM,EAAG,MAAM,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,cAAc,EAAG,MAAM,GAAG,IAAI,CAAC;IACxC,2CAA2C;IAC3C,QAAQ,CAAC,gBAAgB,EAAG,KAAK,GAAG,QAAQ,GAAG,IAAI,CAAC;CACvD,CAAC;AAEF,eAAO,MAAM,eAAe,EAAG,SAAS,MAAM,EAQ7C,CAAC;AAEF,eAAO,MAAM,cAAc,EAAG,SAAS,MAAM,EAQ5C,CAAC;AAEF,eAAO,MAAM,cAAc,EAAG,MAK7B,CAAC;AAEF,qCAAqC;AACrC,qBAAa,WAAY,SAAQ,KAAK;IAClC,SAAkB,IAAI,EAAG,MAAM,CAAiB;CACnD;AAWD,yHAAyH;AACzH,wBAAgB,cAAc,CAAC,KAAK,EAAG,OAAO,EAAE,MAAM,EAAG,MAAM,GAAI,aAAa,CAmD/E;AAwBD;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAG,SAAS,aAAa,EAAE,EAAE,SAAS,EAAG,SAAS,mBAAmB,EAAE,GAAI,aAAa,EAAE,CA4B/H;AAED,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,IAAI,EAAG,MAAM,EAAE,IAAI,EAAG,MAAM,GAAI,MAAM,CAGjE;AAED,MAAM,MAAM,cAAc,GAAG;IACzB,yEAAyE;IACzE,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAC;IACvB,QAAQ,CAAC,UAAU,CAAC,EAAG,MAAM,GAAG,IAAI,CAAC;IACrC,iEAAiE;IACjE,QAAQ,CAAC,GAAG,CAAC,EAAG,MAAM,CAAC;IACvB,QAAQ,CAAC,GAAG,CAAC,EAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;CAChE,CAAC;AAEF,sFAAsF;AACtF,wBAAgB,aAAa,CAAC,IAAI,EAAG,aAAa,EAAE,OAAO,EAAG,cAAc,GAAI,cAAc,CAgC7F;AAED,sFAAsF;AACtF,wBAAgB,cAAc,CAAC,GAAG,EAAG,MAAM,GAAI,MAAM,GAAG,IAAI,CAS3D;AAED,MAAM,MAAM,WAAW,GAAG;IACtB,QAAQ,CAAC,GAAG,EAAG,MAAM,CAAC;IACtB,0FAA0F;IAC1F,QAAQ,CAAC,UAAU,CAAC,EAAG,MAAM,CAAC;IAC9B,QAAQ,CAAC,GAAG,CAAC,EAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;CAChE,CAAC;AAEF,oFAAoF;AACpF,wBAAgB,UAAU,CAAC,OAAO,EAAG,WAAW,GAAI,cAAc,CAkBjE"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAA6E,KAAK,cAAc,EAAE,KAAK,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEtJ,cAAc,kBAAkB,CAAC;AAEjC,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,IAAI,EAAG,MAAM,EAAE,IAAI,EAAG,MAAM,GAAI,MAAM,CAGjE;AAED,MAAM,MAAM,cAAc,GAAG;IACzB,yEAAyE;IACzE,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAC;IACvB,QAAQ,CAAC,UAAU,CAAC,EAAG,MAAM,GAAG,IAAI,CAAC;IACrC,iEAAiE;IACjE,QAAQ,CAAC,GAAG,CAAC,EAAG,MAAM,CAAC;IACvB,QAAQ,CAAC,GAAG,CAAC,EAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;CAChE,CAAC;AAEF,sFAAsF;AACtF,wBAAgB,aAAa,CAAC,IAAI,EAAG,aAAa,EAAE,OAAO,EAAG,cAAc,GAAI,cAAc,CAc7F;AAED,sFAAsF;AACtF,wBAAgB,cAAc,CAAC,GAAG,EAAG,MAAM,GAAI,MAAM,GAAG,IAAI,CAS3D;AAED,MAAM,MAAM,WAAW,GAAG;IACtB,QAAQ,CAAC,GAAG,EAAG,MAAM,CAAC;IACtB,0FAA0F;IAC1F,QAAQ,CAAC,UAAU,CAAC,EAAG,MAAM,CAAC;IAC9B,QAAQ,CAAC,GAAG,CAAC,EAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;CAChE,CAAC;AAEF,oFAAoF;AACpF,wBAAgB,UAAU,CAAC,OAAO,EAAG,WAAW,GAAI,cAAc,CAkBjE"}

package/dist/config.js

@@ -5,172 +5,8 @@
 import { existsSync, readFileSync } from "node:fs";
 import { homedir } from "node:os";
 import { dirname, join, resolve } from "node:path";
-import { isRuleId, RULE_IDS } from "./types.js";
-import { DEFAULT_WORD_LIST } from "./word-list.js";
-export const CONFIG_FILE_NAME = "ste.config.json";
-/** The environment variable that gives the path of the local dictionary. It has priority over `dictionaryPath`. */
-export const DICTIONARY_ENV = "STE_DICTIONARY";
-export const DEFAULT_INCLUDE = [
-    "README.md",
-    "docs/**/*.{md,mdx}",
-    "packages/*/README.md",
-    "packages/*/src/**/*.{ts,tsx}",
-    "packages/*/build/**/*.{ts,tsx}",
-    "packages/*/commands/**/*.{ts,tsx}",
-    "packages/*/*.config.{ts,mts}",
-];
-export const DEFAULT_IGNORE = [
-    "**/node_modules/**",
-    "**/dist/**",
-    "**/*.d.ts",
-    "**/*.test.ts",
-    "**/*.test.tsx",
-    "**/*.spec.ts",
-    "**/*.spec.tsx",
-];
-export const DEFAULT_LIMITS = {
-    instructionWords: 20,
-    descriptionWords: 25,
-    paragraphSentences: 6,
-    nounClusterNouns: 3,
-};
-/** An error in the configuration. */
-export class ConfigError extends Error {
-    name = "ConfigError";
-}
-const SETTINGS = ["error", "warning", "off"];
-const KNOWN_KEYS = new Set([
-    "$schema", "include", "ignore", "technicalNouns", "technicalVerbs", "properNouns", "allowedWords",
-    "rules", "wordList", "limits", "dictionaryPath",
-]);
-const WORD_LIST_KEYS = new Set(["id", "match", "suggest", "note", "severity", "verbOnly"]);
-/** This function makes sure that `value` is a valid configuration. It throws a `ConfigError` that lists all problems. */
-export function validateConfig(value, source) {
-    const problems = [];
-    if (typeof value !== "object" || value === null || Array.isArray(value)) {
-        throw new ConfigError(`${source}: the configuration must be a JSON object.`);
-    }
-    const record = value;
-    for (const key of Object.keys(record)) {
-        if (!KNOWN_KEYS.has(key))
-            problems.push(`"${key}" is not a known property. Known properties: ${[...KNOWN_KEYS].join(", ")}.`);
-    }
-    for (const key of ["include", "ignore", "technicalNouns", "technicalVerbs", "properNouns", "allowedWords"]) {
-        const item = record[key];
-        if (item !== undefined && !(Array.isArray(item) && item.every((entry) => typeof entry === "string"))) {
-            problems.push(`"${key}" must be an array of strings.`);
-        }
-    }
-    const rules = record["rules"];
-    if (rules !== undefined) {
-        if (typeof rules !== "object" || rules === null || Array.isArray(rules)) {
-            problems.push(`"rules" must be an object.`);
-        }
-        else {
-            for (const [id, setting] of Object.entries(rules)) {
-                if (!isRuleId(id))
-                    problems.push(`"rules.${id}" is not a known rule. Known rules: ${RULE_IDS.join(", ")}.`);
-                if (typeof setting !== "string" || !SETTINGS.includes(setting))
-                    problems.push(`"rules.${id}" must be "error", "warning" or "off".`);
-            }
-        }
-    }
-    const limits = record["limits"];
-    if (limits !== undefined) {
-        if (typeof limits !== "object" || limits === null || Array.isArray(limits)) {
-            problems.push(`"limits" must be an object.`);
-        }
-        else {
-            for (const [key, limit] of Object.entries(limits)) {
-                if (!Object.hasOwn(DEFAULT_LIMITS, key))
-                    problems.push(`"limits.${key}" is not a known limit. Known limits: ${Object.keys(DEFAULT_LIMITS).join(", ")}.`);
-                if (typeof limit !== "number" || !Number.isInteger(limit) || limit < 1)
-                    problems.push(`"limits.${key}" must be an integer of 1 or more.`);
-            }
-        }
-    }
-    const dictionaryPath = record["dictionaryPath"];
-    if (dictionaryPath !== undefined && dictionaryPath !== null && typeof dictionaryPath !== "string") {
-        problems.push(`"dictionaryPath" must be a string or null.`);
-    }
-    const wordList = record["wordList"];
-    if (wordList !== undefined) {
-        if (!Array.isArray(wordList)) {
-            problems.push(`"wordList" must be an array.`);
-        }
-        else {
-            wordList.forEach((item, index) => problems.push(...validateWordListEntry(item, `wordList[${index}]`)));
-        }
-    }
-    if (problems.length > 0)
-        throw new ConfigError(`${source}:\n  - ${problems.join("\n  - ")}`);
-    return record;
-}
-function validateWordListEntry(item, where) {
-    if (typeof item !== "object" || item === null || Array.isArray(item))
-        return [`"${where}" must be an object.`];
-    const problems = [];
-    const entry = item;
-    for (const key of Object.keys(entry)) {
-        if (!WORD_LIST_KEYS.has(key))
-            problems.push(`"${where}.${key}" is not a known property.`);
-    }
-    const match = entry["match"];
-    const matchValid = typeof match === "string" || (Array.isArray(match) && match.length > 0 && match.every((word) => typeof word === "string"));
-    if (match !== undefined && !matchValid)
-        problems.push(`"${where}.match" must be a string or an array of strings.`);
-    if (entry["id"] !== undefined && typeof entry["id"] !== "string")
-        problems.push(`"${where}.id" must be a string.`);
-    if (entry["id"] === undefined && match === undefined)
-        problems.push(`"${where}" must have "id" or "match".`);
-    for (const key of ["suggest", "note"]) {
-        const text = entry[key];
-        if (text !== undefined && text !== null && typeof text !== "string")
-            problems.push(`"${where}.${key}" must be a string or null.`);
-    }
-    const severity = entry["severity"];
-    if (severity !== undefined && (typeof severity !== "string" || !SETTINGS.includes(severity)))
-        problems.push(`"${where}.severity" must be "error", "warning" or "off".`);
-    if (entry["verbOnly"] !== undefined && typeof entry["verbOnly"] !== "boolean")
-        problems.push(`"${where}.verbOnly" must be true or false.`);
-    return problems;
-}
-/**
- * This function merges the default word list and the entries of the
- * configuration. An entry with the ID (or the first `match` word) of a
- * default entry changes that entry. The severity "off" removes the entry
- * with that ID, and it removes the `match` words from all entries.
- */
-export function mergeWordList(defaults, overrides) {
-    const entries = new Map(defaults.map((entry) => [entry.id, entry]));
-    for (const override of overrides) {
-        const match = override.match === undefined ? undefined : typeof override.match === "string" ? [override.match] : [...override.match];
-        const id = override.id ?? match[0];
-        const base = entries.get(id) ?? null;
-        if (override.severity === "off") {
-            entries.set(id, null);
-            const removed = new Set((match ?? []).map((word) => word.toLowerCase()));
-            for (const [key, entry] of entries) {
-                if (entry === null)
-                    continue;
-                const kept = entry.match.filter((word) => !removed.has(word.toLowerCase()));
-                entries.set(key, kept.length === 0 ? null : { ...entry, match: kept });
-            }
-            continue;
-        }
-        const merged = {
-            id,
-            match: match ?? base?.match ?? [id],
-            suggest: override.suggest !== undefined ? override.suggest : base?.suggest ?? null,
-            note: override.note !== undefined ? override.note : base?.note ?? null,
-            severity: override.severity ?? base?.severity ?? "error",
-            verbOnly: override.verbOnly ?? base?.verbOnly ?? false,
-            context: base?.context ?? null,
-        };
-        entries.set(id, merged);
-    }
-    return [...entries.values()].filter((entry) => entry !== null);
-}
+import { baseConfig, CONFIG_FILE_NAME, ConfigError, DICTIONARY_ENV, validateConfig } from "./config-core.js";
+export * from "./config-core.js";
 /** This function expands a leading `~/` to the home directory, and makes the path absolute. */
 export function resolvePath(path, base) {
     const expanded = path === "~" ? homedir() : path.startsWith("~/") || path.startsWith("~\\") ? join(homedir(), path.slice(2)) : path;
@@ -191,26 +27,7 @@ export function resolveConfig(file, options) {
         dictionaryPath = resolvePath(file.dictionaryPath.trim(), options.root);
         dictionarySource = "config";
     }
-    const rules = {};
-    for (const [id, setting] of Object.entries(file.rules ?? {})) {
-        if (isRuleId(id))
-            rules[id] = setting;
-    }
-    return {
-        root: options.root,
-        configFile: options.configFile ?? null,
-        include: file.include ?? DEFAULT_INCLUDE,
-        ignore: file.ignore ?? DEFAULT_IGNORE,
-        technicalNouns: file.technicalNouns ?? [],
-        technicalVerbs: file.technicalVerbs ?? [],
-        properNouns: file.properNouns ?? [],
-        allowedWords: file.allowedWords ?? [],
-        rules,
-        wordList: mergeWordList(DEFAULT_WORD_LIST, file.wordList ?? []),
-        limits: { ...DEFAULT_LIMITS, ...file.limits },
-        dictionaryPath,
-        dictionarySource,
-    };
+    return { ...baseConfig(file, { root: options.root, configFile: options.configFile ?? null }), dictionaryPath, dictionarySource };
 }
 /** The first `ste.config.json` in `cwd` or one of its parent directories, or null. */
 export function findConfigFile(cwd) {

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAgD,MAAM,YAAY,CAAC;AAC9F,OAAO,EAAE,iBAAiB,EAAsB,MAAM,gBAAgB,CAAC;AAEvE,MAAM,CAAC,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAElD,mHAAmH;AACnH,MAAM,CAAC,MAAM,cAAc,GAAG,gBAAgB,CAAC;AA8D/C,MAAM,CAAC,MAAM,eAAe,GAAuB;IAC/C,WAAW;IACX,oBAAoB;IACpB,sBAAsB;IACtB,8BAA8B;IAC9B,gCAAgC;IAChC,mCAAmC;IACnC,8BAA8B;CACjC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAuB;IAC9C,oBAAoB;IACpB,YAAY;IACZ,WAAW;IACX,cAAc;IACd,eAAe;IACf,cAAc;IACd,eAAe;CAClB,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAY;IACnC,gBAAgB,EAAG,EAAE;IACrB,gBAAgB,EAAG,EAAE;IACrB,kBAAkB,EAAG,CAAC;IACtB,gBAAgB,EAAG,CAAC;CACvB,CAAC;AAEF,qCAAqC;AACrC,MAAM,OAAO,WAAY,SAAQ,KAAK;IAChB,IAAI,GAAY,aAAa,CAAC;CACnD;AAED,MAAM,QAAQ,GAAuB,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;AAEjE,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC;IACvB,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,aAAa,EAAE,cAAc;IACjG,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,gBAAgB;CAClD,CAAC,CAAC;AAEH,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;AAE3F,yHAAyH;AACzH,MAAM,UAAU,cAAc,CAAC,KAAe,EAAE,MAAe;IAC3D,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACtE,MAAM,IAAI,WAAW,CAAC,GAAG,MAAM,4CAA4C,CAAC,CAAC;IACjF,CAAC;IACD,MAAM,MAAM,GAAG,KAAgC,CAAC;IAChD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,GAAG,gDAAgD,CAAC,GAAG,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClI,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,aAAa,EAAE,cAAc,CAAC,EAAE,CAAC;QACzG,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,EAAE,CAAC;YACnG,QAAQ,CAAC,IAAI,CAAC,IAAI,GAAG,gCAAgC,CAAC,CAAC;QAC3D,CAAC;IACL,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACtE,QAAQ,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACJ,KAAK,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChD,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,uCAAuC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC5G,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;oBAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,wCAAwC,CAAC,CAAC;YACxI,CAAC;QACL,CAAC;IACL,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;IAChC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACzE,QAAQ,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;aAAM,CAAC;YACJ,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAChD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,GAAG,CAAC;oBAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,GAAG,yCAAyC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACzJ,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC;oBAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,GAAG,oCAAoC,CAAC,CAAC;YAC9I,CAAC;QACL,CAAC;IACL,CAAC;IACD,MAAM,cAAc,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAChD,IAAI,cAAc,KAAK,SAAS,IAAI,cAAc,KAAK,IAAI,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;QAChG,QAAQ,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;IACpC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3B,QAAQ,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YACJ,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAc,EAAE,KAAc,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,qBAAqB,CAAC,IAAI,EAAE,YAAY,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;QAC9H,CAAC;IACL,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,GAAG,MAAM,UAAU,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC7F,OAAO,MAAuB,CAAC;AACnC,CAAC;AAED,SAAS,qBAAqB,CAAC,IAAc,EAAE,KAAc;IACzD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,CAAC,IAAI,KAAK,sBAAsB,CAAC,CAAC;IAC/G,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,KAAK,GAAG,IAA+B,CAAC;IAC9C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACnC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,GAAG,4BAA4B,CAAC,CAAC;IAC9F,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,MAAM,UAAU,GAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC;IAC9I,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,UAAU;QAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,kDAAkD,CAAC,CAAC;IACnH,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,QAAQ;QAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,CAAC;IACnH,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS;QAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,8BAA8B,CAAC,CAAC;IAC7G,KAAK,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QACxB,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,GAAG,6BAA6B,CAAC,CAAC;IACtI,CAAC;IACD,MAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IACnC,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,iDAAiD,CAAC,CAAC;IACxK,IAAI,KAAK,CAAC,UAAU,CAAC,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,UAAU,CAAC,KAAK,SAAS;QAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,mCAAmC,CAAC,CAAC;IAC3I,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,QAAmC,EAAE,SAA0C;IACzG,MAAM,OAAO,GAAG,IAAI,GAAG,CAA+B,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAClG,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,QAAQ,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;QACrI,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAE,IAAI,KAAM,CAAC,CAAC,CAAE,CAAC;QACrC,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC;QACrC,IAAI,QAAQ,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YACtB,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;YACzE,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;gBACjC,IAAI,KAAK,KAAK,IAAI;oBAAE,SAAS;gBAC7B,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;gBAC5E,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,KAAK,EAAG,IAAI,EAAE,CAAC,CAAC;YAC5E,CAAC;YACD,SAAS;QACb,CAAC;QACD,MAAM,MAAM,GAAmB;YAC3B,EAAE;YACF,KAAK,EAAG,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;YACpC,OAAO,EAAG,QAAQ,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,IAAI,IAAI;YACnF,IAAI,EAAG,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,IAAI,IAAI;YACvE,QAAQ,EAAI,QAAQ,CAAC,QAAiC,IAAI,IAAI,EAAE,QAAQ,IAAI,OAAO;YACnF,QAAQ,EAAG,QAAQ,CAAC,QAAQ,IAAI,IAAI,EAAE,QAAQ,IAAI,KAAK;YACvD,OAAO,EAAG,IAAI,EAAE,OAAO,IAAI,IAAI;SAClC,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IAC5B,CAAC;IACD,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAA2B,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;AAC5F,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,WAAW,CAAC,IAAa,EAAE,IAAa;IACpD,MAAM,QAAQ,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACpI,OAAO,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AACnC,CAAC;AAWD,sFAAsF;AACtF,MAAM,UAAU,aAAa,CAAC,IAAoB,EAAE,OAAwB;IACxE,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC;IAC9B,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IACxC,MAAM,OAAO,GAAG,GAAG,CAAC,cAAc,CAAC,CAAC;IACpC,IAAI,cAAc,GAAmB,IAAI,CAAC;IAC1C,IAAI,gBAAgB,GAAwC,IAAI,CAAC;IACjE,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrD,cAAc,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;QAClD,gBAAgB,GAAG,KAAK,CAAC;IAC7B,CAAC;SAAM,IAAI,OAAO,IAAI,CAAC,cAAc,KAAK,QAAQ,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1F,cAAc,GAAG,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QACvE,gBAAgB,GAAG,QAAQ,CAAC;IAChC,CAAC;IACD,MAAM,KAAK,GAA0C,EAAE,CAAC;IACxD,KAAK,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;QAC3D,IAAI,QAAQ,CAAC,EAAE,CAAC;YAAE,KAAK,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;IAC1C,CAAC;IACD,OAAO;QACH,IAAI,EAAG,OAAO,CAAC,IAAI;QACnB,UAAU,EAAG,OAAO,CAAC,UAAU,IAAI,IAAI;QACvC,OAAO,EAAG,IAAI,CAAC,OAAO,IAAI,eAAe;QACzC,MAAM,EAAG,IAAI,CAAC,MAAM,IAAI,cAAc;QACtC,cAAc,EAAG,IAAI,CAAC,cAAc,IAAI,EAAE;QAC1C,cAAc,EAAG,IAAI,CAAC,cAAc,IAAI,EAAE;QAC1C,WAAW,EAAG,IAAI,CAAC,WAAW,IAAI,EAAE;QACpC,YAAY,EAAG,IAAI,CAAC,YAAY,IAAI,EAAE;QACtC,KAAK;QACL,QAAQ,EAAG,aAAa,CAAC,iBAAiB,EAAE,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;QAChE,MAAM,EAAG,EAAE,GAAG,cAAc,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE;QAC9C,cAAc;QACd,gBAAgB;KACnB,CAAC;AACN,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,cAAc,CAAC,GAAY;IACvC,IAAI,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7B,SAAS,CAAC;QACN,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACpD,IAAI,UAAU,CAAC,SAAS,CAAC;YAAE,OAAO,SAAS,CAAC;QAC5C,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;QAClC,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QACtC,SAAS,GAAG,MAAM,CAAC;IACvB,CAAC;AACL,CAAC;AASD,oFAAoF;AACpF,MAAM,UAAU,UAAU,CAAC,OAAqB;IAC5C,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7H,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC;IAC9B,IAAI,UAAU,KAAK,IAAI;QAAE,OAAO,aAAa,CAAC,EAAE,EAAE,EAAE,IAAI,EAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,EAAG,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;IAC3G,IAAI,IAAa,CAAC;IAClB,IAAI,CAAC;QACD,IAAI,GAAG,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,WAAW,CAAC,sCAAsC,UAAU,KAAM,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3G,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,WAAW,CAAC,GAAG,UAAU,iCAAkC,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IACD,MAAM,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IAC/C,OAAO,aAAa,CAAC,IAAI,EAAE,EAAE,IAAI,EAAG,OAAO,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,GAAG,EAAG,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;AACnG,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,WAAW,EAAE,cAAc,EAAE,cAAc,EAA2C,MAAM,kBAAkB,CAAC;AAEtJ,cAAc,kBAAkB,CAAC;AAEjC,+FAA+F;AAC/F,MAAM,UAAU,WAAW,CAAC,IAAa,EAAE,IAAa;IACpD,MAAM,QAAQ,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACpI,OAAO,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AACnC,CAAC;AAWD,sFAAsF;AACtF,MAAM,UAAU,aAAa,CAAC,IAAoB,EAAE,OAAwB;IACxE,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC;IAC9B,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IACxC,MAAM,OAAO,GAAG,GAAG,CAAC,cAAc,CAAC,CAAC;IACpC,IAAI,cAAc,GAAmB,IAAI,CAAC;IAC1C,IAAI,gBAAgB,GAAwC,IAAI,CAAC;IACjE,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrD,cAAc,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;QAClD,gBAAgB,GAAG,KAAK,CAAC;IAC7B,CAAC;SAAM,IAAI,OAAO,IAAI,CAAC,cAAc,KAAK,QAAQ,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1F,cAAc,GAAG,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QACvE,gBAAgB,GAAG,QAAQ,CAAC;IAChC,CAAC;IACD,OAAO,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,EAAE,IAAI,EAAG,OAAO,CAAC,IAAI,EAAE,UAAU,EAAG,OAAO,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC,EAAE,cAAc,EAAE,gBAAgB,EAAE,CAAC;AACvI,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,cAAc,CAAC,GAAY;IACvC,IAAI,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7B,SAAS,CAAC;QACN,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACpD,IAAI,UAAU,CAAC,SAAS,CAAC;YAAE,OAAO,SAAS,CAAC;QAC5C,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;QAClC,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QACtC,SAAS,GAAG,MAAM,CAAC;IACvB,CAAC;AACL,CAAC;AASD,oFAAoF;AACpF,MAAM,UAAU,UAAU,CAAC,OAAqB;IAC5C,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7H,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC;IAC9B,IAAI,UAAU,KAAK,IAAI;QAAE,OAAO,aAAa,CAAC,EAAE,EAAE,EAAE,IAAI,EAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,EAAG,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;IAC3G,IAAI,IAAa,CAAC;IAClB,IAAI,CAAC;QACD,IAAI,GAAG,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,WAAW,CAAC,sCAAsC,UAAU,KAAM,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3G,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,WAAW,CAAC,GAAG,UAAU,iCAAkC,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IACD,MAAM,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IAC/C,OAAO,aAAa,CAAC,IAAI,EAAE,EAAE,IAAI,EAAG,OAAO,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,GAAG,EAAG,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;AACnG,CAAC"}

package/dist/core.d.ts

@@ -0,0 +1,16 @@
+/**
+ * `@mark1russell7/ste-lint/core`: the linter without a file system, for a
+ * browser or another host that has the text in memory. It examines Markdown
+ * and MDX. For TypeScript doc comments, give the extractor of
+ * `@mark1russell7/ste-lint/code` to `ProseLinter`. The rules are the same
+ * rules that the command line uses.
+ */
+export { baseConfig, CONFIG_FILE_NAME, ConfigError, DEFAULT_IGNORE, DEFAULT_INCLUDE, DEFAULT_LIMITS, DICTIONARY_ENV, mergeWordList, validateConfig, type BaseConfigOptions, type Limits, type LimitsConfig, type ResolvedConfig, type SteConfigFile, type WordListEntryConfig, } from "./config-core.js";
+export { Dictionary, DICTIONARY_FORMAT, DictionaryError, parseDictionary, type DictionaryEntry, type DictionaryLookup } from "./dictionary-core.js";
+export { fileKind, ProseLinter, type CodeExtractor, type FileKind, type ProseLinterOptions } from "./engine.js";
+export { formatJson, formatText, summarize, type RuleCount, type Summary } from "./format.js";
+export { buildLexicon, type Lexicon } from "./lexicon.js";
+export { getRule, RULES, type Rule } from "./rules/index.js";
+export { isRuleId, RULE_IDS, type Finding, type RuleId, type RuleSetting, type Severity } from "./types.js";
+export { DEFAULT_WORD_LIST, type WordListEntry } from "./word-list.js";
+//# sourceMappingURL=core.d.ts.map

package/dist/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EACH,UAAU,EACV,gBAAgB,EAChB,WAAW,EACX,cAAc,EACd,eAAe,EACf,cAAc,EACd,cAAc,EACd,aAAa,EACb,cAAc,EACd,KAAK,iBAAiB,EACtB,KAAK,MAAM,EACX,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,mBAAmB,GAC3B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,eAAe,EAAE,eAAe,EAAE,KAAK,eAAe,EAAE,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACpJ,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,KAAK,aAAa,EAAE,KAAK,QAAQ,EAAE,KAAK,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAChH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,SAAS,EAAE,KAAK,OAAO,EAAE,MAAM,aAAa,CAAC;AAC9F,OAAO,EAAE,YAAY,EAAE,KAAK,OAAO,EAAE,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,WAAW,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC5G,OAAO,EAAE,iBAAiB,EAAE,KAAK,aAAa,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/core.js

@@ -0,0 +1,16 @@
+/**
+ * `@mark1russell7/ste-lint/core`: the linter without a file system, for a
+ * browser or another host that has the text in memory. It examines Markdown
+ * and MDX. For TypeScript doc comments, give the extractor of
+ * `@mark1russell7/ste-lint/code` to `ProseLinter`. The rules are the same
+ * rules that the command line uses.
+ */
+export { baseConfig, CONFIG_FILE_NAME, ConfigError, DEFAULT_IGNORE, DEFAULT_INCLUDE, DEFAULT_LIMITS, DICTIONARY_ENV, mergeWordList, validateConfig, } from "./config-core.js";
+export { Dictionary, DICTIONARY_FORMAT, DictionaryError, parseDictionary } from "./dictionary-core.js";
+export { fileKind, ProseLinter } from "./engine.js";
+export { formatJson, formatText, summarize } from "./format.js";
+export { buildLexicon } from "./lexicon.js";
+export { getRule, RULES } from "./rules/index.js";
+export { isRuleId, RULE_IDS } from "./types.js";
+export { DEFAULT_WORD_LIST } from "./word-list.js";
+//# sourceMappingURL=core.js.map

package/dist/core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EACH,UAAU,EACV,gBAAgB,EAChB,WAAW,EACX,cAAc,EACd,eAAe,EACf,cAAc,EACd,cAAc,EACd,aAAa,EACb,cAAc,GAOjB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,eAAe,EAAE,eAAe,EAA+C,MAAM,sBAAsB,CAAC;AACpJ,OAAO,EAAE,QAAQ,EAAE,WAAW,EAA8D,MAAM,aAAa,CAAC;AAChH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAgC,MAAM,aAAa,CAAC;AAC9F,OAAO,EAAE,YAAY,EAAgB,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,OAAO,EAAE,KAAK,EAAa,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAA8D,MAAM,YAAY,CAAC;AAC5G,OAAO,EAAE,iBAAiB,EAAsB,MAAM,gBAAgB,CAAC"}