@mark1russell7/ste-lint 0.1.1 → 0.1.2

package/dist/engine.js

@@ -0,0 +1,122 @@
+/**
+ * The lint engine without a file system. It extracts the prose of a text,
+ * runs the rules on each prose unit, and gives the findings with their lines
+ * and columns. A browser can use this module.
+ */
+import { buildLexicon } from "./lexicon.js";
+import { RULES } from "./rules/index.js";
+import { WordListMatcher } from "./rules/word-list-matcher.js";
+import { LineIndex } from "./source/lines.js";
+import { extractMarkdown } from "./source/markdown.js";
+import { isSuppressed } from "./source/suppressions.js";
+import { buildUnit } from "./units.js";
+/** The kind of a file, from its extension, or null when the linter cannot read it. */
+export function fileKind(path) {
+    const lower = path.toLowerCase();
+    if (lower.endsWith(".mdx"))
+        return "mdx";
+    if (lower.endsWith(".md") || lower.endsWith(".markdown"))
+        return "markdown";
+    if (/\.(?:[mc]?ts|tsx|[mc]?js|jsx)$/.test(lower) && !lower.endsWith(".d.ts"))
+        return "typescript";
+    return null;
+}
+/**
+ * A linter for one configuration, for text in memory. It makes the lexicon
+ * and the word list matcher one time. It reads no file.
+ */
+export class ProseLinter {
+    config;
+    lexicon;
+    wordList;
+    rules;
+    extractCode;
+    constructor(config, lexicon, options = {}) {
+        this.config = config;
+        this.lexicon = lexicon ?? buildLexicon(config);
+        this.wordList = new WordListMatcher(config.wordList);
+        this.extractCode = options.extractCode ?? null;
+        this.rules = RULES.flatMap((rule) => {
+            const setting = config.rules[rule.id];
+            if (setting === "off")
+                return [];
+            if (rule.id === "unknown-word" && this.lexicon.dictionary === null)
+                return [];
+            return [{ rule, override: setting ?? null }];
+        });
+    }
+    /** The prose units of a file. */
+    units(text, path) {
+        return this.extract(text, path).blocks.flatMap((block) => buildUnit(block, this.lexicon) ?? []);
+    }
+    /** The findings in `text`. `path` gives the kind of file, and it is the file name in the findings. */
+    lintText(text, path) {
+        const extraction = this.extract(text, path);
+        const lineIndex = new LineIndex(text);
+        const raw = [];
+        for (const block of extraction.blocks) {
+            const unit = buildUnit(block, this.lexicon);
+            if (unit === null)
+                continue;
+            const wordOnly = unit.kind !== "paragraph";
+            for (const { rule, override } of this.rules) {
+                if (wordOnly && rule.scope !== "word")
+                    continue;
+                rule.check(unit, {
+                    config: this.config,
+                    lexicon: this.lexicon,
+                    wordList: this.wordList,
+                    report: (report) => {
+                        raw.push({
+                            ruleId: rule.id,
+                            severity: override ?? report.severity ?? rule.defaultSeverity,
+                            start: report.start,
+                            end: report.end,
+                            message: report.message,
+                            eachWord: reportsEachWord(rule),
+                        });
+                    },
+                });
+            }
+        }
+        // An unknown word that another rule reports already gets no second finding. A finding for a
+        // sentence, a paragraph or a noun cluster does not report each word in it.
+        const others = raw.filter((finding) => finding.ruleId !== "unknown-word" && finding.eachWord);
+        const kept = raw.filter((finding) => finding.ruleId !== "unknown-word"
+            || !others.some((other) => other.start < finding.end && finding.start < other.end));
+        return kept
+            .filter((finding) => !isSuppressed(extraction.suppressions, finding.ruleId, finding.start))
+            .sort((a, b) => a.start - b.start || a.end - b.end || a.ruleId.localeCompare(b.ruleId))
+            .map((finding) => {
+            const start = lineIndex.position(finding.start);
+            const end = lineIndex.position(Math.max(finding.start, finding.end));
+            return {
+                file: path,
+                line: start.line,
+                column: start.column,
+                endLine: end.line,
+                endColumn: end.column,
+                ruleId: finding.ruleId,
+                severity: finding.severity,
+                message: finding.message,
+            };
+        });
+    }
+    extract(text, path) {
+        const kind = fileKind(path);
+        if (kind === "typescript")
+            return this.extractCode === null ? { blocks: [], suppressions: [] } : this.extractCode(text, path);
+        if (kind === null)
+            return { blocks: [], suppressions: [] };
+        return extractMarkdown(text, { mdx: kind === "mdx" });
+    }
+}
+/**
+ * True when a finding of the rule is about each word in its range. A word rule reports a word or a
+ * phrase, for example a modal verb or a word list phrase. The noun-cluster rule reports a group of
+ * nouns, and the sentence and paragraph rules report a full sentence or paragraph.
+ */
+function reportsEachWord(rule) {
+    return rule.scope === "word" && rule.id !== "noun-cluster";
+}
+//# sourceMappingURL=engine.js.map

package/dist/engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.js","sourceRoot":"","sources":["../src/engine.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,YAAY,EAAgB,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAa,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAmB,MAAM,sBAAsB,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD,OAAO,EAAE,SAAS,EAAkB,MAAM,YAAY,CAAC;AAIvD,sFAAsF;AACtF,MAAM,UAAU,QAAQ,CAAC,IAAa;IAClC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACjC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO,KAAK,CAAC;IACzC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC;QAAE,OAAO,UAAU,CAAC;IAC5E,IAAI,gCAAgC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,OAAO,YAAY,CAAC;IAClG,OAAO,IAAI,CAAC;AAChB,CAAC;AAiBD;;;GAGG;AACH,MAAM,OAAO,WAAW;IAMC;IALZ,OAAO,CAAW;IACV,QAAQ,CAAmB;IAC3B,KAAK,CAAgF;IACrF,WAAW,CAAwB;IAEpD,YAAqB,MAAuB,EAAE,OAAkB,EAAE,UAA+B,EAAE;QAA9E,WAAM,GAAN,MAAM,CAAiB;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;QAC/C,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACrD,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,IAAI,CAAC;QAC/C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAChC,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACtC,IAAI,OAAO,KAAK,KAAK;gBAAE,OAAO,EAAE,CAAC;YACjC,IAAI,IAAI,CAAC,EAAE,KAAK,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,KAAK,IAAI;gBAAE,OAAO,EAAE,CAAC;YAC9E,OAAO,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAG,OAAO,IAAI,IAAI,EAAE,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;IACP,CAAC;IAED,iCAAiC;IACjC,KAAK,CAAC,IAAa,EAAE,IAAa;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACpG,CAAC;IAED,sGAAsG;IACtG,QAAQ,CAAC,IAAa,EAAE,IAAa;QACjC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC5C,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;QAEtC,MAAM,GAAG,GAAW,EAAE,CAAC;QACvB,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YACpC,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5C,IAAI,IAAI,KAAK,IAAI;gBAAE,SAAS;YAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC;YAC3C,KAAK,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC1C,IAAI,QAAQ,IAAI,IAAI,CAAC,KAAK,KAAK,MAAM;oBAAE,SAAS;gBAChD,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;oBACb,MAAM,EAAG,IAAI,CAAC,MAAM;oBACpB,OAAO,EAAG,IAAI,CAAC,OAAO;oBACtB,QAAQ,EAAG,IAAI,CAAC,QAAQ;oBACxB,MAAM,EAAG,CAAC,MAAM,EAAE,EAAE;wBAChB,GAAG,CAAC,IAAI,CAAC;4BACL,MAAM,EAAG,IAAI,CAAC,EAAE;4BAChB,QAAQ,EAAG,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,eAAe;4BAC9D,KAAK,EAAG,MAAM,CAAC,KAAK;4BACpB,GAAG,EAAG,MAAM,CAAC,GAAG;4BAChB,OAAO,EAAG,MAAM,CAAC,OAAO;4BACxB,QAAQ,EAAG,eAAe,CAAC,IAAI,CAAC;yBACnC,CAAC,CAAC;oBACP,CAAC;iBACJ,CAAC,CAAC;YACP,CAAC;QACL,CAAC;QACD,4FAA4F;QAC5F,2EAA2E;QAC3E,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,cAAc,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC9F,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,cAAc;eAC/D,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QACxF,OAAO,IAAI;aACN,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;aAC1F,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;aACtF,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACb,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAChD,MAAM,GAAG,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;YACrE,OAAO;gBACH,IAAI,EAAG,IAAI;gBACX,IAAI,EAAG,KAAK,CAAC,IAAI;gBACjB,MAAM,EAAG,KAAK,CAAC,MAAM;gBACrB,OAAO,EAAG,GAAG,CAAC,IAAI;gBAClB,SAAS,EAAG,GAAG,CAAC,MAAM;gBACtB,MAAM,EAAG,OAAO,CAAC,MAAM;gBACvB,QAAQ,EAAG,OAAO,CAAC,QAAQ;gBAC3B,OAAO,EAAG,OAAO,CAAC,OAAO;aAC5B,CAAC;QACN,CAAC,CAAC,CAAC;IACX,CAAC;IAEO,OAAO,CAAC,IAAa,EAAE,IAAa;QACxC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,IAAI,KAAK,YAAY;YAAE,OAAO,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAG,EAAE,EAAE,YAAY,EAAG,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChI,IAAI,IAAI,KAAK,IAAI;YAAE,OAAO,EAAE,MAAM,EAAG,EAAE,EAAE,YAAY,EAAG,EAAE,EAAE,CAAC;QAC7D,OAAO,eAAe,CAAC,IAAI,EAAE,EAAE,GAAG,EAAG,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC;IAC3D,CAAC;CACJ;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,IAAW;IAChC,OAAO,IAAI,CAAC,KAAK,KAAK,MAAM,IAAI,IAAI,CAAC,EAAE,KAAK,cAAc,CAAC;AAC/D,CAAC"}

package/dist/index.d.ts

@@ -4,12 +4,14 @@
  * ASD-STE100 Simplified Technical English. It does not certify that a text
  * obeys the standard.
  */
-export { CONFIG_FILE_NAME, ConfigError, DEFAULT_IGNORE, DEFAULT_INCLUDE, DEFAULT_LIMITS, DICTIONARY_ENV, findConfigFile, loadConfig, mergeWordList, resolveConfig, validateConfig, type Limits, type LimitsConfig, type ResolvedConfig, type SteConfigFile, type WordListEntryConfig, } from "./config.js";
+export { baseConfig, CONFIG_FILE_NAME, ConfigError, DEFAULT_IGNORE, DEFAULT_INCLUDE, DEFAULT_LIMITS, DICTIONARY_ENV, findConfigFile, loadConfig, mergeWordList, resolveConfig, validateConfig, type BaseConfigOptions, type Limits, type LimitsConfig, type ResolvedConfig, type SteConfigFile, type WordListEntryConfig, } from "./config.js";
 export { Dictionary, DICTIONARY_FORMAT, DictionaryError, loadDictionary, parseDictionary, type DictionaryEntry, type DictionaryLookup } from "./dictionary.js";
 export { findFiles, globToRegExp } from "./files.js";
 export { formatJson, formatText, summarize, type RuleCount, type Summary } from "./format.js";
 export { buildLexicon, type Lexicon } from "./lexicon.js";
+export { ProseLinter, type CodeExtractor, type ProseLinterOptions } from "./engine.js";
 export { fileKind, Linter, lintText, type FileKind } from "./lint.js";
+export { extractCode } from "./source/code.js";
 export { getRule, RULES, type Rule } from "./rules/index.js";
 export { parseArgs, runCli, USAGE, type CliIo, type CliOptions } from "./run-cli.js";
 export { isRuleId, RULE_IDS, type Finding, type RuleId, type RuleSetting, type Severity } from "./types.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACH,gBAAgB,EAChB,WAAW,EACX,cAAc,EACd,eAAe,EACf,cAAc,EACd,cAAc,EACd,cAAc,EACd,UAAU,EACV,aAAa,EACb,aAAa,EACb,cAAc,EACd,KAAK,MAAM,EACX,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,mBAAmB,GAC3B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,eAAe,EAAE,cAAc,EAAE,eAAe,EAAE,KAAK,eAAe,EAAE,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC/J,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACrD,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,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,QAAQ,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,KAAK,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AACrF,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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACH,UAAU,EACV,gBAAgB,EAChB,WAAW,EACX,cAAc,EACd,eAAe,EACf,cAAc,EACd,cAAc,EACd,cAAc,EACd,UAAU,EACV,aAAa,EACb,aAAa,EACb,cAAc,EACd,KAAK,iBAAiB,EACtB,KAAK,MAAM,EACX,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,mBAAmB,GAC3B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,eAAe,EAAE,cAAc,EAAE,eAAe,EAAE,KAAK,eAAe,EAAE,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC/J,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACrD,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,WAAW,EAAE,KAAK,aAAa,EAAE,KAAK,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACvF,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,QAAQ,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,KAAK,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AACrF,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/index.js

@@ -4,12 +4,14 @@
  * ASD-STE100 Simplified Technical English. It does not certify that a text
  * obeys the standard.
  */
-export { CONFIG_FILE_NAME, ConfigError, DEFAULT_IGNORE, DEFAULT_INCLUDE, DEFAULT_LIMITS, DICTIONARY_ENV, findConfigFile, loadConfig, mergeWordList, resolveConfig, validateConfig, } from "./config.js";
+export { baseConfig, CONFIG_FILE_NAME, ConfigError, DEFAULT_IGNORE, DEFAULT_INCLUDE, DEFAULT_LIMITS, DICTIONARY_ENV, findConfigFile, loadConfig, mergeWordList, resolveConfig, validateConfig, } from "./config.js";
 export { Dictionary, DICTIONARY_FORMAT, DictionaryError, loadDictionary, parseDictionary } from "./dictionary.js";
 export { findFiles, globToRegExp } from "./files.js";
 export { formatJson, formatText, summarize } from "./format.js";
 export { buildLexicon } from "./lexicon.js";
+export { ProseLinter } from "./engine.js";
 export { fileKind, Linter, lintText } from "./lint.js";
+export { extractCode } from "./source/code.js";
 export { getRule, RULES } from "./rules/index.js";
 export { parseArgs, runCli, USAGE } from "./run-cli.js";
 export { isRuleId, RULE_IDS } from "./types.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACH,gBAAgB,EAChB,WAAW,EACX,cAAc,EACd,eAAe,EACf,cAAc,EACd,cAAc,EACd,cAAc,EACd,UAAU,EACV,aAAa,EACb,aAAa,EACb,cAAc,GAMjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,eAAe,EAAE,cAAc,EAAE,eAAe,EAA+C,MAAM,iBAAiB,CAAC;AAC/J,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAgC,MAAM,aAAa,CAAC;AAC9F,OAAO,EAAE,YAAY,EAAgB,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAiB,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAa,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAA+B,MAAM,cAAc,CAAC;AACrF,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAA8D,MAAM,YAAY,CAAC;AAC5G,OAAO,EAAE,iBAAiB,EAAsB,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACH,UAAU,EACV,gBAAgB,EAChB,WAAW,EACX,cAAc,EACd,eAAe,EACf,cAAc,EACd,cAAc,EACd,cAAc,EACd,UAAU,EACV,aAAa,EACb,aAAa,EACb,cAAc,GAOjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,eAAe,EAAE,cAAc,EAAE,eAAe,EAA+C,MAAM,iBAAiB,CAAC;AAC/J,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAgC,MAAM,aAAa,CAAC;AAC9F,OAAO,EAAE,YAAY,EAAgB,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,WAAW,EAA+C,MAAM,aAAa,CAAC;AACvF,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAiB,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAa,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAA+B,MAAM,cAAc,CAAC;AACrF,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAA8D,MAAM,YAAY,CAAC;AAC5G,OAAO,EAAE,iBAAiB,EAAsB,MAAM,gBAAgB,CAAC"}

package/dist/lint.d.ts

@@ -1,25 +1,15 @@
 /**
- * The lint engine. It extracts the prose of a file, runs the rules on each
- * prose unit, and gives the findings with their lines and columns.
+ * The linter for files: the engine of `engine.ts`, with the extractor of
+ * TypeScript doc comments and the file system.
  */
 import type { ResolvedConfig } from "./config.js";
-import { type Lexicon } from "./lexicon.js";
+import { ProseLinter } from "./engine.js";
+import type { Lexicon } from "./lexicon.js";
 import type { Finding } from "./types.js";
-import { type ProseUnit } from "./units.js";
-export type FileKind = "markdown" | "mdx" | "typescript";
-/** The kind of a file, from its extension, or null when the linter cannot read it. */
-export declare function fileKind(path: string): FileKind | null;
+export { fileKind, type FileKind } from "./engine.js";
 /** A linter for one configuration. It makes the lexicon and the word list matcher one time. */
-export declare class Linter {
-    readonly config: ResolvedConfig;
-    readonly lexicon: Lexicon;
-    private readonly wordList;
-    private readonly rules;
+export declare class Linter extends ProseLinter {
     constructor(config: ResolvedConfig, lexicon?: Lexicon);
-    /** The prose units of a file. */
-    units(text: string, path: string): ProseUnit[];
-    /** The findings in `text`. `path` gives the kind of file, and it is the file name in the findings. */
-    lintText(text: string, path: string): Finding[];
     /** The findings in a file on disk. `displayPath` is the file name in the findings. */
     lintFile(path: string, displayPath?: string): Finding[];
 }

package/dist/lint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lint.d.ts","sourceRoot":"","sources":["../src/lint.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAgB,KAAK,OAAO,EAAE,MAAM,cAAc,CAAC;AAQ1D,OAAO,KAAK,EAAE,OAAO,EAAoB,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAa,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvD,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,KAAK,GAAG,YAAY,CAAC;AAEzD,sFAAsF;AACtF,wBAAgB,QAAQ,CAAC,IAAI,EAAG,MAAM,GAAI,QAAQ,GAAG,IAAI,CAMxD;AAED,+FAA+F;AAC/F,qBAAa,MAAM;IAKH,QAAQ,CAAC,MAAM,EAAG,cAAc;IAJ5C,QAAQ,CAAC,OAAO,EAAG,OAAO,CAAC;IAC3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgF;gBAEjF,MAAM,EAAG,cAAc,EAAE,OAAO,CAAC,EAAG,OAAO;IAWhE,iCAAiC;IACjC,KAAK,CAAC,IAAI,EAAG,MAAM,EAAE,IAAI,EAAG,MAAM,GAAI,SAAS,EAAE;IAIjD,sGAAsG;IACtG,QAAQ,CAAC,IAAI,EAAG,MAAM,EAAE,IAAI,EAAG,MAAM,GAAI,OAAO,EAAE;IAoDlD,sFAAsF;IACtF,QAAQ,CAAC,IAAI,EAAG,MAAM,EAAE,WAAW,GAAG,MAAa,GAAI,OAAO,EAAE;CAGnE;AAuBD,yGAAyG;AACzG,wBAAgB,QAAQ,CAAC,IAAI,EAAG,MAAM,EAAE,IAAI,EAAG,MAAM,EAAE,MAAM,EAAG,cAAc,EAAE,OAAO,CAAC,EAAG,OAAO,GAAI,OAAO,EAAE,CAE9G"}
+{"version":3,"file":"lint.d.ts","sourceRoot":"","sources":["../src/lint.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAE1C,OAAO,EAAE,QAAQ,EAAE,KAAK,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEtD,+FAA+F;AAC/F,qBAAa,MAAO,SAAQ,WAAW;gBACvB,MAAM,EAAG,cAAc,EAAE,OAAO,CAAC,EAAG,OAAO;IAIvD,sFAAsF;IACtF,QAAQ,CAAC,IAAI,EAAG,MAAM,EAAE,WAAW,GAAG,MAAa,GAAI,OAAO,EAAE;CAGnE;AAED,yGAAyG;AACzG,wBAAgB,QAAQ,CAAC,IAAI,EAAG,MAAM,EAAE,IAAI,EAAG,MAAM,EAAE,MAAM,EAAG,cAAc,EAAE,OAAO,CAAC,EAAG,OAAO,GAAI,OAAO,EAAE,CAE9G"}

package/dist/lint.js

@@ -1,130 +1,21 @@
 /**
- * The lint engine. It extracts the prose of a file, runs the rules on each
- * prose unit, and gives the findings with their lines and columns.
+ * The linter for files: the engine of `engine.ts`, with the extractor of
+ * TypeScript doc comments and the file system.
  */
 import { readFileSync } from "node:fs";
-import { buildLexicon } from "./lexicon.js";
-import { RULES } from "./rules/index.js";
-import { WordListMatcher } from "./rules/word-list-matcher.js";
-import { LineIndex } from "./source/lines.js";
-import { extractMarkdown } from "./source/markdown.js";
-import { isSuppressed } from "./source/suppressions.js";
-import { extractTsdoc } from "./source/tsdoc.js";
-import { extractJsxText } from "./source/jsx.js";
-import { buildUnit } from "./units.js";
-/** The kind of a file, from its extension, or null when the linter cannot read it. */
-export function fileKind(path) {
-    const lower = path.toLowerCase();
-    if (lower.endsWith(".mdx"))
-        return "mdx";
-    if (lower.endsWith(".md") || lower.endsWith(".markdown"))
-        return "markdown";
-    if (/\.(?:[mc]?ts|tsx|[mc]?js|jsx)$/.test(lower) && !lower.endsWith(".d.ts"))
-        return "typescript";
-    return null;
-}
+import { ProseLinter } from "./engine.js";
+import { extractCode } from "./source/code.js";
+export { fileKind } from "./engine.js";
 /** A linter for one configuration. It makes the lexicon and the word list matcher one time. */
-export class Linter {
-    config;
-    lexicon;
-    wordList;
-    rules;
+export class Linter extends ProseLinter {
     constructor(config, lexicon) {
-        this.config = config;
-        this.lexicon = lexicon ?? buildLexicon(config);
-        this.wordList = new WordListMatcher(config.wordList);
-        this.rules = RULES.flatMap((rule) => {
-            const setting = config.rules[rule.id];
-            if (setting === "off")
-                return [];
-            if (rule.id === "unknown-word" && this.lexicon.dictionary === null)
-                return [];
-            return [{ rule, override: setting ?? null }];
-        });
-    }
-    /** The prose units of a file. */
-    units(text, path) {
-        return extract(text, path).blocks.flatMap((block) => buildUnit(block, this.lexicon) ?? []);
-    }
-    /** The findings in `text`. `path` gives the kind of file, and it is the file name in the findings. */
-    lintText(text, path) {
-        const extraction = extract(text, path);
-        const lineIndex = new LineIndex(text);
-        const raw = [];
-        for (const block of extraction.blocks) {
-            const unit = buildUnit(block, this.lexicon);
-            if (unit === null)
-                continue;
-            const wordOnly = unit.kind !== "paragraph";
-            for (const { rule, override } of this.rules) {
-                if (wordOnly && rule.scope !== "word")
-                    continue;
-                rule.check(unit, {
-                    config: this.config,
-                    lexicon: this.lexicon,
-                    wordList: this.wordList,
-                    report: (report) => {
-                        raw.push({
-                            ruleId: rule.id,
-                            severity: override ?? report.severity ?? rule.defaultSeverity,
-                            start: report.start,
-                            end: report.end,
-                            message: report.message,
-                            eachWord: reportsEachWord(rule),
-                        });
-                    },
-                });
-            }
-        }
-        // An unknown word that another rule reports already gets no second finding. A finding for a
-        // sentence, a paragraph or a noun cluster does not report each word in it.
-        const others = raw.filter((finding) => finding.ruleId !== "unknown-word" && finding.eachWord);
-        const kept = raw.filter((finding) => finding.ruleId !== "unknown-word"
-            || !others.some((other) => other.start < finding.end && finding.start < other.end));
-        return kept
-            .filter((finding) => !isSuppressed(extraction.suppressions, finding.ruleId, finding.start))
-            .sort((a, b) => a.start - b.start || a.end - b.end || a.ruleId.localeCompare(b.ruleId))
-            .map((finding) => {
-            const start = lineIndex.position(finding.start);
-            const end = lineIndex.position(Math.max(finding.start, finding.end));
-            return {
-                file: path,
-                line: start.line,
-                column: start.column,
-                endLine: end.line,
-                endColumn: end.column,
-                ruleId: finding.ruleId,
-                severity: finding.severity,
-                message: finding.message,
-            };
-        });
+        super(config, lexicon, { extractCode });
     }
     /** The findings in a file on disk. `displayPath` is the file name in the findings. */
     lintFile(path, displayPath = path) {
         return this.lintText(readFileSync(path, "utf8"), displayPath);
     }
 }
-/**
- * True when a finding of the rule is about each word in its range. A word rule reports a word or a
- * phrase, for example a modal verb or a word list phrase. The noun-cluster rule reports a group of
- * nouns, and the sentence and paragraph rules report a full sentence or paragraph.
- */
-function reportsEachWord(rule) {
-    return rule.scope === "word" && rule.id !== "noun-cluster";
-}
-function extract(text, path) {
-    const kind = fileKind(path);
-    if (kind === "typescript") {
-        const comments = extractTsdoc(text, path);
-        if (!/\.[jt]sx$/i.test(path))
-            return comments;
-        // The text that the user interface shows
-        return { blocks: [...comments.blocks, ...extractJsxText(text, path).blocks], suppressions: comments.suppressions };
-    }
-    if (kind === null)
-        return { blocks: [], suppressions: [] };
-    return extractMarkdown(text, { mdx: kind === "mdx" });
-}
 /** The findings in `text`, with a new linter. To lint many files, make one `Linter` and use it again. */
 export function lintText(text, path, config, lexicon) {
     return new Linter(config, lexicon).lintText(text, path);

package/dist/lint.js.map

@@ -1 +1 @@
-{"version":3,"file":"lint.js","sourceRoot":"","sources":["../src/lint.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,OAAO,EAAE,YAAY,EAAgB,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAa,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAmB,MAAM,sBAAsB,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAE,SAAS,EAAkB,MAAM,YAAY,CAAC;AAIvD,sFAAsF;AACtF,MAAM,UAAU,QAAQ,CAAC,IAAa;IAClC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACjC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO,KAAK,CAAC;IACzC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC;QAAE,OAAO,UAAU,CAAC;IAC5E,IAAI,gCAAgC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,OAAO,YAAY,CAAC;IAClG,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,+FAA+F;AAC/F,MAAM,OAAO,MAAM;IAKM;IAJZ,OAAO,CAAW;IACV,QAAQ,CAAmB;IAC3B,KAAK,CAAgF;IAEtG,YAAqB,MAAuB,EAAE,OAAkB;QAA3C,WAAM,GAAN,MAAM,CAAiB;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;QAC/C,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACrD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAChC,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACtC,IAAI,OAAO,KAAK,KAAK;gBAAE,OAAO,EAAE,CAAC;YACjC,IAAI,IAAI,CAAC,EAAE,KAAK,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,KAAK,IAAI;gBAAE,OAAO,EAAE,CAAC;YAC9E,OAAO,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAG,OAAO,IAAI,IAAI,EAAE,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;IACP,CAAC;IAED,iCAAiC;IACjC,KAAK,CAAC,IAAa,EAAE,IAAa;QAC9B,OAAO,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED,sGAAsG;IACtG,QAAQ,CAAC,IAAa,EAAE,IAAa;QACjC,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACvC,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;QAEtC,MAAM,GAAG,GAAW,EAAE,CAAC;QACvB,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YACpC,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5C,IAAI,IAAI,KAAK,IAAI;gBAAE,SAAS;YAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC;YAC3C,KAAK,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC1C,IAAI,QAAQ,IAAI,IAAI,CAAC,KAAK,KAAK,MAAM;oBAAE,SAAS;gBAChD,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;oBACb,MAAM,EAAG,IAAI,CAAC,MAAM;oBACpB,OAAO,EAAG,IAAI,CAAC,OAAO;oBACtB,QAAQ,EAAG,IAAI,CAAC,QAAQ;oBACxB,MAAM,EAAG,CAAC,MAAM,EAAE,EAAE;wBAChB,GAAG,CAAC,IAAI,CAAC;4BACL,MAAM,EAAG,IAAI,CAAC,EAAE;4BAChB,QAAQ,EAAG,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,eAAe;4BAC9D,KAAK,EAAG,MAAM,CAAC,KAAK;4BACpB,GAAG,EAAG,MAAM,CAAC,GAAG;4BAChB,OAAO,EAAG,MAAM,CAAC,OAAO;4BACxB,QAAQ,EAAG,eAAe,CAAC,IAAI,CAAC;yBACnC,CAAC,CAAC;oBACP,CAAC;iBACJ,CAAC,CAAC;YACP,CAAC;QACL,CAAC;QACD,4FAA4F;QAC5F,2EAA2E;QAC3E,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,cAAc,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC9F,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,cAAc;eAC/D,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QACxF,OAAO,IAAI;aACN,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;aAC1F,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;aACtF,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACb,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAChD,MAAM,GAAG,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;YACrE,OAAO;gBACH,IAAI,EAAG,IAAI;gBACX,IAAI,EAAG,KAAK,CAAC,IAAI;gBACjB,MAAM,EAAG,KAAK,CAAC,MAAM;gBACrB,OAAO,EAAG,GAAG,CAAC,IAAI;gBAClB,SAAS,EAAG,GAAG,CAAC,MAAM;gBACtB,MAAM,EAAG,OAAO,CAAC,MAAM;gBACvB,QAAQ,EAAG,OAAO,CAAC,QAAQ;gBAC3B,OAAO,EAAG,OAAO,CAAC,OAAO;aAC5B,CAAC;QACN,CAAC,CAAC,CAAC;IACX,CAAC;IAED,sFAAsF;IACtF,QAAQ,CAAC,IAAa,EAAE,cAAuB,IAAI;QAC/C,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,CAAC;IAClE,CAAC;CACJ;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,IAAW;IAChC,OAAO,IAAI,CAAC,KAAK,KAAK,MAAM,IAAI,IAAI,CAAC,EAAE,KAAK,cAAc,CAAC;AAC/D,CAAC;AAED,SAAS,OAAO,CAAC,IAAa,EAAE,IAAa;IACzC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;QACxB,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,OAAO,QAAQ,CAAC;QAC9C,yCAAyC;QACzC,OAAO,EAAE,MAAM,EAAG,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,EAAE,YAAY,EAAG,QAAQ,CAAC,YAAY,EAAE,CAAC;IACzH,CAAC;IACD,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,EAAE,MAAM,EAAG,EAAE,EAAE,YAAY,EAAG,EAAE,EAAE,CAAC;IAC7D,OAAO,eAAe,CAAC,IAAI,EAAE,EAAE,GAAG,EAAG,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC;AAC3D,CAAC;AAED,yGAAyG;AACzG,MAAM,UAAU,QAAQ,CAAC,IAAa,EAAE,IAAa,EAAE,MAAuB,EAAE,OAAkB;IAC9F,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAC5D,CAAC"}
+{"version":3,"file":"lint.js","sourceRoot":"","sources":["../src/lint.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C,OAAO,EAAE,QAAQ,EAAiB,MAAM,aAAa,CAAC;AAEtD,+FAA+F;AAC/F,MAAM,OAAO,MAAO,SAAQ,WAAW;IACnC,YAAY,MAAuB,EAAE,OAAkB;QACnD,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,sFAAsF;IACtF,QAAQ,CAAC,IAAa,EAAE,cAAuB,IAAI;QAC/C,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,CAAC;IAClE,CAAC;CACJ;AAED,yGAAyG;AACzG,MAAM,UAAU,QAAQ,CAAC,IAAa,EAAE,IAAa,EAAE,MAAuB,EAAE,OAAkB;IAC9F,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAC5D,CAAC"}

package/dist/source/code.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The prose of a TypeScript or JavaScript file: the doc comments, and the
+ * text that the JSX of a TSX or JSX file shows. This module needs the
+ * `typescript` package, but no file system. A browser can use it.
+ */
+import type { Extraction } from "./markdown.js";
+/** This function extracts the prose of the source text of a TypeScript or JavaScript file. `path` gives the kind of file. */
+export declare function extractCode(text: string, path: string): Extraction;
+//# sourceMappingURL=code.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"code.d.ts","sourceRoot":"","sources":["../../src/source/code.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAGhD,6HAA6H;AAC7H,wBAAgB,WAAW,CAAC,IAAI,EAAG,MAAM,EAAE,IAAI,EAAG,MAAM,GAAI,UAAU,CAKrE"}

package/dist/source/code.js

@@ -0,0 +1,16 @@
+/**
+ * The prose of a TypeScript or JavaScript file: the doc comments, and the
+ * text that the JSX of a TSX or JSX file shows. This module needs the
+ * `typescript` package, but no file system. A browser can use it.
+ */
+import { extractJsxText } from "./jsx.js";
+import { extractTsdoc } from "./tsdoc.js";
+/** This function extracts the prose of the source text of a TypeScript or JavaScript file. `path` gives the kind of file. */
+export function extractCode(text, path) {
+    const comments = extractTsdoc(text, path);
+    if (!/\.[jt]sx$/i.test(path))
+        return comments;
+    // The text that the user interface shows
+    return { blocks: [...comments.blocks, ...extractJsxText(text, path).blocks], suppressions: comments.suppressions };
+}
+//# sourceMappingURL=code.js.map

package/dist/source/code.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"code.js","sourceRoot":"","sources":["../../src/source/code.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE1C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,6HAA6H;AAC7H,MAAM,UAAU,WAAW,CAAC,IAAa,EAAE,IAAa;IACpD,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC1C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,QAAQ,CAAC;IAC9C,yCAAyC;IACzC,OAAO,EAAE,MAAM,EAAG,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,EAAE,YAAY,EAAG,QAAQ,CAAC,YAAY,EAAE,CAAC;AACzH,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@mark1russell7/ste-lint",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "A linter for the writing rules of ASD-STE100 Simplified Technical English in Markdown, MDX and TypeScript doc comments",
   "type": "module",
   "engines": {
@@ -14,6 +14,14 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
+    "./core": {
+      "types": "./dist/core.d.ts",
+      "import": "./dist/core.js"
+    },
+    "./code": {
+      "types": "./dist/source/code.d.ts",
+      "import": "./dist/source/code.js"
+    },
     "./ste.config.schema.json": "./ste.config.schema.json"
   },
   "bin": {
@@ -42,7 +50,7 @@
   },
   "scripts": {
     "build": "tsc -b",
-    "typecheck": "tsc -p tsconfig.test.json",
+    "typecheck": "tsc -p tsconfig.test.json && pnpm --filter @ste-lint/site run typecheck",
     "test": "vitest run",
     "lint:ste": "tsx src/cli.ts"
   }