@mark1russell7/ste-lint 0.0.0-bootstrap.0 → 0.1.1

package/dist/config.js

@@ -0,0 +1,251 @@
+/**
+ * The configuration file `ste.config.json`, and the configuration that the
+ * linter uses after it reads the file, the environment and the defaults.
+ */
+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);
+}
+/** 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;
+    return resolve(base, expanded);
+}
+/** This function applies the defaults and the environment to a configuration file. */
+export function resolveConfig(file, options) {
+    const env = options.env ?? {};
+    const cwd = options.cwd ?? options.root;
+    const fromEnv = env[DICTIONARY_ENV];
+    let dictionaryPath = null;
+    let dictionarySource = null;
+    if (fromEnv !== undefined && fromEnv.trim().length > 0) {
+        dictionaryPath = resolvePath(fromEnv.trim(), cwd);
+        dictionarySource = "env";
+    }
+    else if (typeof file.dictionaryPath === "string" && file.dictionaryPath.trim().length > 0) {
+        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,
+    };
+}
+/** The first `ste.config.json` in `cwd` or one of its parent directories, or null. */
+export function findConfigFile(cwd) {
+    let directory = resolve(cwd);
+    for (;;) {
+        const candidate = join(directory, CONFIG_FILE_NAME);
+        if (existsSync(candidate))
+            return candidate;
+        const parent = dirname(directory);
+        if (parent === directory)
+            return null;
+        directory = parent;
+    }
+}
+/** This function reads the configuration file, if there is one, and resolves it. */
+export function loadConfig(options) {
+    const configFile = options.configPath !== undefined ? resolve(options.cwd, options.configPath) : findConfigFile(options.cwd);
+    const env = options.env ?? {};
+    if (configFile === null)
+        return resolveConfig({}, { root: resolve(options.cwd), cwd: options.cwd, env });
+    let text;
+    try {
+        text = readFileSync(configFile, "utf8");
+    }
+    catch (error) {
+        throw new ConfigError(`Cannot read the configuration file ${configFile}: ${error.message}`);
+    }
+    let value;
+    try {
+        value = JSON.parse(text);
+    }
+    catch (error) {
+        throw new ConfigError(`${configFile}: the file is not valid JSON: ${error.message}`);
+    }
+    const file = validateConfig(value, configFile);
+    return resolveConfig(file, { root: dirname(configFile), configFile, cwd: options.cwd, env });
+}
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +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"}

package/dist/dictionary.d.ts

@@ -0,0 +1,74 @@
+/**
+ * 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;
+/** This function reads a dictionary file. */
+export declare function loadDictionary(path: string): Dictionary;
+//# sourceMappingURL=dictionary.d.ts.map

package/dist/dictionary.d.ts.map

@@ -0,0 +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"}

package/dist/dictionary.js

@@ -0,0 +1,169 @@
+/**
+ * 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.
+ */
+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 }),
+    };
+}
+/** This function reads a dictionary file. */
+export function loadDictionary(path) {
+    let text;
+    try {
+        text = readFileSync(path, "utf8");
+    }
+    catch (error) {
+        throw new DictionaryError(`Cannot read the dictionary file ${path}: ${error.message}`);
+    }
+    let value;
+    try {
+        value = JSON.parse(text);
+    }
+    catch (error) {
+        throw new DictionaryError(`${path}: the file is not valid JSON: ${error.message}`);
+    }
+    return parseDictionary(value, path);
+}
+//# sourceMappingURL=dictionary.js.map

package/dist/dictionary.js.map

@@ -0,0 +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"}

package/dist/files.d.ts

@@ -0,0 +1,35 @@
+/**
+ * File discovery: glob patterns to files.
+ *
+ * The glob syntax:
+ *
+ * - `*` matches characters in one path segment
+ * - `**` matches zero or more segments
+ * - `?` matches one character
+ * - `{a,b}` matches one of the alternatives
+ * - `[abc]` or `[!abc]` matches one character of a set.
+ *
+ * Patterns use `/` on all platforms. An absolute pattern is also correct.
+ */
+/** True when `pattern` has glob characters. */
+export declare function isGlob(pattern: string): boolean;
+/** This function converts a glob pattern to a regular expression that matches a whole relative path. */
+export declare function globToRegExp(glob: string): RegExp;
+/** The part of a pattern before the first segment with glob characters. The walk starts in that directory. */
+export declare function globBase(glob: string): string;
+export type FindOptions = {
+    /** The directory that the include patterns are relative to. */
+    readonly root: string;
+    readonly include: readonly string[];
+    readonly ignore: readonly string[];
+    /** The directory that the ignore patterns are relative to. The default is `root`. */
+    readonly ignoreRoot?: string;
+};
+/**
+ * This function finds the files that match the include patterns and no
+ * ignore pattern. A pattern without glob characters is a file name, and
+ * the ignore patterns do not apply to it. The result has absolute paths,
+ * in sorted order, without duplicates.
+ */
+export declare function findFiles(options: FindOptions): string[];
+//# sourceMappingURL=files.d.ts.map

package/dist/files.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAOH,+CAA+C;AAC/C,wBAAgB,MAAM,CAAC,OAAO,EAAG,MAAM,GAAI,OAAO,CAEjD;AAuFD,wGAAwG;AACxG,wBAAgB,YAAY,CAAC,IAAI,EAAG,MAAM,GAAI,MAAM,CAGnD;AAED,8GAA8G;AAC9G,wBAAgB,QAAQ,CAAC,IAAI,EAAG,MAAM,GAAI,MAAM,CAQ/C;AAeD,MAAM,MAAM,WAAW,GAAG;IACtB,+DAA+D;IAC/D,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAG,SAAS,MAAM,EAAE,CAAC;IACrC,QAAQ,CAAC,MAAM,EAAG,SAAS,MAAM,EAAE,CAAC;IACpC,qFAAqF;IACrF,QAAQ,CAAC,UAAU,CAAC,EAAG,MAAM,CAAC;CACjC,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAG,WAAW,GAAI,MAAM,EAAE,CAoC1D"}