@mark1russell7/ste-lint 0.0.0-stage → 0.1.2

package/dist/lexicon.js

@@ -0,0 +1,71 @@
+/**
+ * The word sets that the rules use: the project glossary from the
+ * configuration, the built-in word lists, and the local dictionary when
+ * there is one.
+ */
+import { hasLemmaIn } from "./text/grammar.js";
+import { PhraseMatcher, splitPhrase } from "./text/phrases.js";
+import { COMMON_NOUNS, COMMON_VERBS } from "./text/words.js";
+function words(terms) {
+    const single = new Set();
+    const phrases = [];
+    for (const term of terms) {
+        const parts = splitPhrase(term);
+        if (parts.length === 1)
+            single.add(parts[0]);
+        else if (parts.length > 1)
+            phrases.push(parts.join(" "));
+    }
+    return { single, phrases };
+}
+/** This function makes the lexicon for a configuration and an optional dictionary. */
+export function buildLexicon(config, dictionary = null) {
+    const nouns = words(config.technicalNouns);
+    const verbs = words(config.technicalVerbs);
+    const proper = words(config.properNouns);
+    const allowed = words(config.allowedWords);
+    const glossaryPhrases = new PhraseMatcher();
+    const technicalNounPhrases = new PhraseMatcher();
+    // A name counts as one word only with its own capital letters: "Event Timing", but not "event timing".
+    const properNounPhrases = new PhraseMatcher({ caseSensitive: true });
+    for (const phrase of nouns.phrases) {
+        glossaryPhrases.add(phrase, true);
+        technicalNounPhrases.add(phrase, true);
+    }
+    for (const phrase of verbs.phrases)
+        glossaryPhrases.add(phrase, true);
+    for (const phrase of proper.phrases)
+        glossaryPhrases.add(phrase, true);
+    for (const name of config.properNouns) {
+        if (name.trim().split(/\s+/).length > 1)
+            properNounPhrases.add(name.trim(), true);
+    }
+    const verbSet = new Set([...COMMON_VERBS, ...verbs.single, ...(dictionary?.verbs ?? [])]);
+    // A word that is often a verb counts as a noun only when the glossary or the dictionary says that it is a noun.
+    const nounSet = new Set();
+    for (const noun of COMMON_NOUNS)
+        if (!verbSet.has(noun))
+            nounSet.add(noun);
+    for (const noun of [...nouns.single, ...proper.single, ...(dictionary?.nouns ?? [])])
+        nounSet.add(noun);
+    return {
+        technicalNouns: nouns.single,
+        technicalVerbs: verbs.single,
+        properNouns: proper.single,
+        allowedWords: allowed.single,
+        glossaryPhrases,
+        technicalNounPhrases,
+        properNounPhrases,
+        nouns: nounSet,
+        verbs: verbSet,
+        dictionary,
+    };
+}
+/** True when the glossary permits the word: a technical noun or verb in any form, a proper noun, or a word of `allowedWords`. */
+export function isGlossaryWord(word, lexicon) {
+    return lexicon.properNouns.has(word)
+        || lexicon.allowedWords.has(word)
+        || hasLemmaIn(word, lexicon.technicalNouns)
+        || hasLemmaIn(word, lexicon.technicalVerbs);
+}
+//# sourceMappingURL=lexicon.js.map

package/dist/lexicon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lexicon.js","sourceRoot":"","sources":["../src/lexicon.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAuB7D,SAAS,KAAK,CAAC,KAAyB;IACpC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IACjC,MAAM,OAAO,GAAc,EAAE,CAAC;IAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC;aACzC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;AAC/B,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,YAAY,CAAC,MAAuB,EAAE,aAAiC,IAAI;IACvF,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAC3C,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAC3C,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACzC,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAE3C,MAAM,eAAe,GAAG,IAAI,aAAa,EAAE,CAAC;IAC5C,MAAM,oBAAoB,GAAG,IAAI,aAAa,EAAE,CAAC;IACjD,uGAAuG;IACvG,MAAM,iBAAiB,GAAG,IAAI,aAAa,CAAC,EAAE,aAAa,EAAG,IAAI,EAAE,CAAC,CAAC;IACtE,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;QACjC,eAAe,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAClC,oBAAoB,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IACD,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO;QAAE,eAAe,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACtE,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO;QAAE,eAAe,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACpC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC;YAAE,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;IACtF,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,GAAG,CAAS,CAAC,GAAG,YAAY,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAClG,gHAAgH;IAChH,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,KAAK,MAAM,IAAI,IAAI,YAAY;QAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC3E,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC;QAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAExG,OAAO;QACH,cAAc,EAAG,KAAK,CAAC,MAAM;QAC7B,cAAc,EAAG,KAAK,CAAC,MAAM;QAC7B,WAAW,EAAG,MAAM,CAAC,MAAM;QAC3B,YAAY,EAAG,OAAO,CAAC,MAAM;QAC7B,eAAe;QACf,oBAAoB;QACpB,iBAAiB;QACjB,KAAK,EAAG,OAAO;QACf,KAAK,EAAG,OAAO;QACf,UAAU;KACb,CAAC;AACN,CAAC;AAED,iIAAiI;AACjI,MAAM,UAAU,cAAc,CAAC,IAAa,EAAE,OAAiB;IAC3D,OAAO,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC;WAC7B,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;WAC9B,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,CAAC;WACxC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;AACpD,CAAC"}

package/dist/lint.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { ProseLinter } from "./engine.js";
+import type { Lexicon } from "./lexicon.js";
+import type { Finding } from "./types.js";
+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 extends ProseLinter {
+    constructor(config: ResolvedConfig, lexicon?: Lexicon);
+    /** The findings in a file on disk. `displayPath` is the file name in the findings. */
+    lintFile(path: string, displayPath?: string): Finding[];
+}
+/** The findings in `text`, with a new linter. To lint many files, make one `Linter` and use it again. */
+export declare function lintText(text: string, path: string, config: ResolvedConfig, lexicon?: Lexicon): Finding[];
+//# sourceMappingURL=lint.d.ts.map

package/dist/lint.d.ts.map

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

@@ -0,0 +1,23 @@
+/**
+ * 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 { 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 extends ProseLinter {
+    constructor(config, lexicon) {
+        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);
+    }
+}
+/** 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);
+}
+//# sourceMappingURL=lint.js.map

package/dist/lint.js.map

@@ -0,0 +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,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/rules/about-quantity.d.ts

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

package/dist/rules/about-quantity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"about-quantity.d.ts","sourceRoot":"","sources":["../../src/rules/about-quantity.ts"],"names":[],"mappings":"AAEA,OAAO,EAA4B,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAOhE,eAAO,MAAM,aAAa,EAAG,IAuB5B,CAAC"}

package/dist/rules/about-quantity.js

@@ -0,0 +1,34 @@
+import { isNumber, isWord } from "../text/tokens.js";
+import { UNITS } from "../text/words.js";
+import { forEachToken, tokenRange } from "./rule.js";
+/** Words after "about a" or "about an" that make a quantity: "about a second", "about an hour". */
+const QUANTITY_AFTER_ARTICLE = new Set([
+    "dozen", "few", "hundred", "thousand", "million", "billion", "third", "quarter", "half", "factor", "tenth",
+]);
+export const aboutQuantity = {
+    id: "about-quantity",
+    description: "Find \"about\" before a number or a quantity, where the word means \"approximately\".",
+    ste: "1.3, 9.2",
+    defaultSeverity: "error",
+    scope: "word",
+    check(unit, context) {
+        forEachToken(unit, (tokens, i) => {
+            const token = tokens[i];
+            if (!isWord(token) || token.lower !== "about")
+                return;
+            const next = tokens[i + 1];
+            const after = tokens[i + 2];
+            const quantity = isNumber(next)
+                || (next !== undefined && next.text === "~")
+                || (isWord(next) && /^\d/.test(next.text))
+                || (isWord(next) && (next.lower === "a" || next.lower === "an") && isWord(after) && (QUANTITY_AFTER_ARTICLE.has(after.lower) || UNITS.has(after.lower)));
+            if (!quantity)
+                return;
+            context.report({
+                ...tokenRange(tokens, i, i + 1),
+                message: "Do not use \"about\" for a quantity. Write \"approximately\". Use \"about\" only for a topic, for example \"about the monitor\".",
+            });
+        });
+    },
+};
+//# sourceMappingURL=about-quantity.js.map

package/dist/rules/about-quantity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"about-quantity.js","sourceRoot":"","sources":["../../src/rules/about-quantity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,UAAU,EAAa,MAAM,WAAW,CAAC;AAEhE,mGAAmG;AACnG,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAAC;IACnC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO;CAC7G,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,aAAa,GAAU;IAChC,EAAE,EAAG,gBAAgB;IACrB,WAAW,EAAG,uFAAuF;IACrG,GAAG,EAAG,UAAU;IAChB,eAAe,EAAG,OAAO;IACzB,KAAK,EAAG,MAAM;IACd,KAAK,CAAC,IAAI,EAAE,OAAO;QACf,YAAY,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,KAAK,OAAO;gBAAE,OAAO;YACtD,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5B,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC;mBACxB,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC;mBACzC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;mBACvC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,GAAG,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC7J,IAAI,CAAC,QAAQ;gBAAE,OAAO;YACtB,OAAO,CAAC,MAAM,CAAC;gBACX,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC/B,OAAO,EAAG,kIAAkI;aAC/I,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;CACJ,CAAC"}

package/dist/rules/index.d.ts

@@ -0,0 +1,8 @@
+import type { RuleId } from "../types.js";
+import type { Rule } from "./rule.js";
+/** All rules, in the order of the documentation. */
+export declare const RULES: readonly Rule[];
+/** The rule with the ID `id`. */
+export declare function getRule(id: RuleId): Rule;
+export type { Report, Rule, RuleContext, RuleScope } from "./rule.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/rules/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAU1C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAMtC,oDAAoD;AACpD,eAAO,MAAM,KAAK,EAAG,SAAS,IAAI,EAejC,CAAC;AAEF,iCAAiC;AACjC,wBAAgB,OAAO,CAAC,EAAE,EAAG,MAAM,GAAI,IAAI,CAE1C;AAED,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC"}

package/dist/rules/index.js

@@ -0,0 +1,35 @@
+import { aboutQuantity } from "./about-quantity.js";
+import { ingVerb } from "./ing-verb.js";
+import { latinAbbreviation } from "./latin-abbreviation.js";
+import { missingSubjectRule } from "./missing-subject.js";
+import { modalVerb } from "./modal-verb.js";
+import { nounCluster } from "./noun-cluster.js";
+import { paragraphLength } from "./paragraph-length.js";
+import { passiveInstruction } from "./passive-instruction.js";
+import { firstPerson, genderedPronoun } from "./pronouns.js";
+import { semicolon } from "./semicolon.js";
+import { sentenceLength } from "./sentence-length.js";
+import { unknownWord } from "./unknown-word.js";
+import { wordList } from "./word-list.js";
+/** All rules, in the order of the documentation. */
+export const RULES = [
+    sentenceLength,
+    paragraphLength,
+    modalVerb,
+    semicolon,
+    latinAbbreviation,
+    aboutQuantity,
+    wordList,
+    genderedPronoun,
+    firstPerson,
+    passiveInstruction,
+    nounCluster,
+    missingSubjectRule,
+    ingVerb,
+    unknownWord,
+];
+/** The rule with the ID `id`. */
+export function getRule(id) {
+    return RULES.find((rule) => rule.id === id);
+}
+//# sourceMappingURL=index.js.map

package/dist/rules/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAE7D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,oDAAoD;AACpD,MAAM,CAAC,MAAM,KAAK,GAAqB;IACnC,cAAc;IACd,eAAe;IACf,SAAS;IACT,SAAS;IACT,iBAAiB;IACjB,aAAa;IACb,QAAQ;IACR,eAAe;IACf,WAAW;IACX,kBAAkB;IAClB,WAAW;IACX,kBAAkB;IAClB,OAAO;IACP,WAAW;CACd,CAAC;AAEF,iCAAiC;AACjC,MAAM,UAAU,OAAO,CAAC,EAAW;IAC/B,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAE,CAAC;AACjD,CAAC"}

package/dist/rules/ing-verb.d.ts

@@ -0,0 +1,9 @@
+import type { PhraseMatcher } from "../text/phrases.js";
+import { type Token } from "../text/tokens.js";
+import { type Rule } from "./rule.js";
+/** The token indices that a multi-word glossary phrase covers. */
+export declare function coveredByPhrases(tokens: readonly Token[], phrases: PhraseMatcher): Set<number>;
+/** The base form of an -ing word when it is a known verb ("running" gives "run"), or null. */
+export declare function baseForm(word: string, verbs: ReadonlySet<string>): string | null;
+export declare const ingVerb: Rule;
+//# sourceMappingURL=ing-verb.d.ts.map

package/dist/rules/ing-verb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ing-verb.d.ts","sourceRoot":"","sources":["../../src/rules/ing-verb.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAqB,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAElE,OAAO,EAA4B,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAEhE,kEAAkE;AAClE,wBAAgB,gBAAgB,CAAC,MAAM,EAAG,SAAS,KAAK,EAAE,EAAE,OAAO,EAAG,aAAa,GAAI,GAAG,CAAC,MAAM,CAAC,CAQjG;AAED,8FAA8F;AAC9F,wBAAgB,QAAQ,CAAC,IAAI,EAAG,MAAM,EAAE,KAAK,EAAG,WAAW,CAAC,MAAM,CAAC,GAAI,MAAM,GAAG,IAAI,CAEnF;AAED,eAAO,MAAM,OAAO,EAAG,IA+BtB,CAAC"}

package/dist/rules/ing-verb.js

@@ -0,0 +1,60 @@
+import { isIngVerbUse, lemmas } from "../text/grammar.js";
+import { isCounted, isWord } from "../text/tokens.js";
+import { NON_VERB_ING } from "../text/words.js";
+import { forEachToken, tokenRange } from "./rule.js";
+/** The token indices that a multi-word glossary phrase covers. */
+export function coveredByPhrases(tokens, phrases) {
+    const covered = new Set();
+    if (phrases.empty)
+        return covered;
+    for (let i = 0; i < tokens.length; i++) {
+        const length = phrases.longestMatch(tokens, i);
+        if (length > 1)
+            for (let k = i; k < i + length; k++)
+                covered.add(k);
+    }
+    return covered;
+}
+/** The base form of an -ing word when it is a known verb ("running" gives "run"), or null. */
+export function baseForm(word, verbs) {
+    return lemmas(word).find((form) => form !== word && verbs.has(form)) ?? null;
+}
+export const ingVerb = {
+    id: "ing-verb",
+    description: "Find -ing forms used as verbs. Headings, technical nouns and allowed words are not examined.",
+    ste: "3.2, 3.5",
+    defaultSeverity: "warning",
+    scope: "word",
+    check(unit, context) {
+        if (unit.kind === "heading")
+            return;
+        const { lexicon, wordList } = context;
+        let covered = new Set();
+        let current = null;
+        forEachToken(unit, (tokens, i) => {
+            if (tokens !== current) {
+                current = tokens;
+                covered = coveredByPhrases(tokens, lexicon.technicalNounPhrases);
+            }
+            const token = tokens[i];
+            if (!isWord(token) || !isCounted(token))
+                return;
+            const lower = token.lower;
+            if (lower.length < 5 || !/^[a-z]+ing$/.test(lower))
+                return;
+            if (NON_VERB_ING.has(lower) || lexicon.technicalNouns.has(lower) || lexicon.properNouns.has(lower) || lexicon.allowedWords.has(lower))
+                return;
+            if (wordList.words.has(lower) || covered.has(i))
+                return;
+            if (!isIngVerbUse(tokens, i))
+                return;
+            const base = baseForm(lower, lexicon.verbs);
+            const example = base === null ? "" : `, for example "when you ${base} ..." or "to ${base} ..."`;
+            context.report({
+                ...tokenRange(tokens, i, i + 1),
+                message: `Do not use "${token.text}" as a verb. Use a simple tense, the infinitive or a noun${example}. If "${lower}" is a technical noun, add it to technicalNouns.`,
+            });
+        });
+    },
+};
+//# sourceMappingURL=ing-verb.js.map

package/dist/rules/ing-verb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ing-verb.js","sourceRoot":"","sources":["../../src/rules/ing-verb.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE1D,OAAO,EAAE,SAAS,EAAE,MAAM,EAAc,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,UAAU,EAAa,MAAM,WAAW,CAAC;AAEhE,kEAAkE;AAClE,MAAM,UAAU,gBAAgB,CAAC,MAAyB,EAAE,OAAuB;IAC/E,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,IAAI,OAAO,CAAC,KAAK;QAAE,OAAO,OAAO,CAAC;IAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC/C,IAAI,MAAM,GAAG,CAAC;YAAE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE;gBAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC;AAED,8FAA8F;AAC9F,MAAM,UAAU,QAAQ,CAAC,IAAa,EAAE,KAA2B;IAC/D,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC;AACjF,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAAU;IAC1B,EAAE,EAAG,UAAU;IACf,WAAW,EAAG,8FAA8F;IAC5G,GAAG,EAAG,UAAU;IAChB,eAAe,EAAG,SAAS;IAC3B,KAAK,EAAG,MAAM;IACd,KAAK,CAAC,IAAI,EAAE,OAAO;QACf,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS;YAAE,OAAO;QACpC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QACtC,IAAI,OAAO,GAAiB,IAAI,GAAG,EAAE,CAAC;QACtC,IAAI,OAAO,GAA6B,IAAI,CAAC;QAC7C,YAAY,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC7B,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;gBACrB,OAAO,GAAG,MAAM,CAAC;gBACjB,OAAO,GAAG,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;YACrE,CAAC;YACD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;gBAAE,OAAO;YAChD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;YAC1B,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC;gBAAE,OAAO;YAC3D,IAAI,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC;gBAAE,OAAO;YAC9I,IAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;gBAAE,OAAO;YACxD,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;gBAAE,OAAO;YACrC,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;YAC5C,MAAM,OAAO,GAAG,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,2BAA2B,IAAI,gBAAgB,IAAI,OAAO,CAAC;YAChG,OAAO,CAAC,MAAM,CAAC;gBACX,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC/B,OAAO,EAAG,eAAe,KAAK,CAAC,IAAI,4DAA4D,OAAO,SAAS,KAAK,kDAAkD;aACzK,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;CACJ,CAAC"}

package/dist/rules/latin-abbreviation.d.ts

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

package/dist/rules/latin-abbreviation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"latin-abbreviation.d.ts","sourceRoot":"","sources":["../../src/rules/latin-abbreviation.ts"],"names":[],"mappings":"AACA,OAAO,EAA4B,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAiBhE,eAAO,MAAM,iBAAiB,EAAG,IA2BhC,CAAC"}

package/dist/rules/latin-abbreviation.js

@@ -0,0 +1,48 @@
+import { isWord } from "../text/tokens.js";
+import { forEachToken, tokenRange } from "./rule.js";
+// A map, not an object literal, so that a word such as "constructor" does not find an Object property.
+const HELP = new Map([
+    ["e.g", { name: "e.g.", help: "Write \"for example\"." }],
+    ["eg", { name: "eg.", help: "Write \"for example\"." }],
+    ["i.e", { name: "i.e.", help: "Write \"that is\", or write a separate sentence." }],
+    ["ie", { name: "ie.", help: "Write \"that is\", or write a separate sentence." }],
+    ["etc", { name: "etc.", help: "Give all the items, or write \"for example\" before the items." }],
+    ["vs", { name: "vs.", help: "Write \"compared to\", \"and\" or \"or\"." }],
+    ["viz", { name: "viz.", help: "Write \"that is\" or \"for example\"." }],
+    ["cf", { name: "cf.", help: "Write \"compare with\" or \"refer to\"." }],
+]);
+/** Abbreviations that are a problem only with a period after them, because the letters alone can be another word. */
+const NEEDS_PERIOD = new Set(["eg", "ie", "cf"]);
+export const latinAbbreviation = {
+    id: "latin-abbreviation",
+    description: "Find Latin abbreviations: e.g., i.e., etc., vs., viz., cf. and et al.",
+    ste: "GR-6",
+    defaultSeverity: "error",
+    scope: "word",
+    check(unit, context) {
+        forEachToken(unit, (tokens, i) => {
+            const token = tokens[i];
+            if (!isWord(token))
+                return;
+            const next = tokens[i + 1];
+            const period = next !== undefined && next.kind === "punct" && next.text === "." && !next.spaceBefore;
+            const end = period ? i + 2 : i + 1;
+            if (token.lower === "et" && isWord(next) && next.lower === "al") {
+                const after = tokens[i + 2];
+                const withPeriod = after !== undefined && after.text === "." && !after.spaceBefore;
+                context.report({ ...tokenRange(tokens, i, withPeriod ? i + 3 : i + 2), message: "Do not use \"et al.\". Write \"and others\", or give the names." });
+                return;
+            }
+            const entry = HELP.get(token.lower);
+            if (entry === undefined)
+                return;
+            // "VS" in capital letters is a name (for example "VS Code"), not "versus".
+            if (token.lower === "vs" && token.text === "VS")
+                return;
+            if (NEEDS_PERIOD.has(token.lower) && (!period || token.text !== token.lower))
+                return;
+            context.report({ ...tokenRange(tokens, i, end), message: `Do not use the Latin abbreviation "${entry.name}". ${entry.help}` });
+        });
+    },
+};
+//# sourceMappingURL=latin-abbreviation.js.map

package/dist/rules/latin-abbreviation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"latin-abbreviation.js","sourceRoot":"","sources":["../../src/rules/latin-abbreviation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,UAAU,EAAa,MAAM,WAAW,CAAC;AAEhE,uGAAuG;AACvG,MAAM,IAAI,GAA6E,IAAI,GAAG,CAAC;IAC3F,CAAC,KAAK,EAAE,EAAE,IAAI,EAAG,MAAM,EAAE,IAAI,EAAG,wBAAwB,EAAE,CAAC;IAC3D,CAAC,IAAI,EAAE,EAAE,IAAI,EAAG,KAAK,EAAE,IAAI,EAAG,wBAAwB,EAAE,CAAC;IACzD,CAAC,KAAK,EAAE,EAAE,IAAI,EAAG,MAAM,EAAE,IAAI,EAAG,kDAAkD,EAAE,CAAC;IACrF,CAAC,IAAI,EAAE,EAAE,IAAI,EAAG,KAAK,EAAE,IAAI,EAAG,kDAAkD,EAAE,CAAC;IACnF,CAAC,KAAK,EAAE,EAAE,IAAI,EAAG,MAAM,EAAE,IAAI,EAAG,gEAAgE,EAAE,CAAC;IACnG,CAAC,IAAI,EAAE,EAAE,IAAI,EAAG,KAAK,EAAE,IAAI,EAAG,2CAA2C,EAAE,CAAC;IAC5E,CAAC,KAAK,EAAE,EAAE,IAAI,EAAG,MAAM,EAAE,IAAI,EAAG,uCAAuC,EAAE,CAAC;IAC1E,CAAC,IAAI,EAAE,EAAE,IAAI,EAAG,KAAK,EAAE,IAAI,EAAG,yCAAyC,EAAE,CAAC;CAC7E,CAAC,CAAC;AAEH,qHAAqH;AACrH,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AAEjD,MAAM,CAAC,MAAM,iBAAiB,GAAU;IACpC,EAAE,EAAG,oBAAoB;IACzB,WAAW,EAAG,uEAAuE;IACrF,GAAG,EAAG,MAAM;IACZ,eAAe,EAAG,OAAO;IACzB,KAAK,EAAG,MAAM;IACd,KAAK,CAAC,IAAI,EAAE,OAAO;QACf,YAAY,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAAE,OAAO;YAC3B,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3B,MAAM,MAAM,GAAG,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;YACrG,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC9D,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC5B,MAAM,UAAU,GAAG,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;gBACnF,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAG,iEAAiE,EAAE,CAAC,CAAC;gBACtJ,OAAO;YACX,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACpC,IAAI,KAAK,KAAK,SAAS;gBAAE,OAAO;YAChC,2EAA2E;YAC3E,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI;gBAAE,OAAO;YACxD,IAAI,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,CAAC;gBAAE,OAAO;YACrF,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,OAAO,EAAG,sCAAsC,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpI,CAAC,CAAC,CAAC;IACP,CAAC;CACJ,CAAC"}

package/dist/rules/missing-subject.d.ts

@@ -0,0 +1,16 @@
+import type { Lexicon } from "../lexicon.js";
+import { type Token } from "../text/tokens.js";
+import { type Rule } from "./rule.js";
+/** The message when the sentence at `tokens` starts without a subject, or null. */
+export declare function missingSubject(tokens: readonly Token[], lexicon: Lexicon): {
+    index: number;
+    message: string;
+} | null;
+/**
+ * The rule examines the summary and the `@remarks` text of doc comments.
+ * For example, "Returns the value." and "Called when the page is hidden."
+ * omit the subject. Text after `@param` and `@returns`, and list items, can
+ * be fragments, so the rule does not examine them.
+ */
+export declare const missingSubjectRule: Rule;
+//# sourceMappingURL=missing-subject.d.ts.map

package/dist/rules/missing-subject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"missing-subject.d.ts","sourceRoot":"","sources":["../../src/rules/missing-subject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,EAAoC,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAEjF,OAAO,EAAc,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AA6ElD,mFAAmF;AACnF,wBAAgB,cAAc,CAAC,MAAM,EAAG,SAAS,KAAK,EAAE,EAAE,OAAO,EAAG,OAAO,GAAI;IAAE,KAAK,EAAG,MAAM,CAAC;IAAC,OAAO,EAAG,MAAM,CAAA;CAAE,GAAG,IAAI,CAuBzH;AAED;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,EAAG,IAejC,CAAC"}

package/dist/rules/missing-subject.js

@@ -0,0 +1,138 @@
+import { isParticiple, nextCounted, startsObject } from "../text/grammar.js";
+import { isCapitalized, isCounted, isWord } from "../text/tokens.js";
+import { BE_FORMS, CONJUNCTIONS, DETERMINERS, HAVE_FORMS, MODALS, PREPOSITIONS, SUBJECT_PRONOUNS } from "../text/words.js";
+import { tokenRange } from "./rule.js";
+/** Auxiliary verbs that start a sentence without a subject: "Is true when ...", "Can be null.". */
+const AUXILIARY_STARTS = new Set(["is", "are", "was", "were", "has", "have", "had", "does", "can", "cannot", "must", "will", "should", "may", "might", "would", "could"]);
+/** Words that end in -s but are not verbs. */
+const NOT_VERBS = new Set([
+    "this", "its", "always", "perhaps", "sometimes", "whereas", "unless", "plus", "thus", "yes", "less", "across",
+    "towards", "afterwards", "besides", "nevertheless", "regardless", "various", "numerous", "previous", "analysis",
+    "basis", "bias", "canvas", "status", "series", "species", "atlas", "alias", "chaos", "corpus", "focus", "bonus",
+]);
+/** Words after a participle that show a missing subject: "Called when ...", "Used by ...". */
+const AFTER_PARTICIPLE = new Set([...PREPOSITIONS, "when", "if", "once", "only", "while", "as", "whenever", "unless"]);
+function stems(word) {
+    const forms = [word.slice(0, -1)];
+    if (word.endsWith("es"))
+        forms.push(word.slice(0, -2));
+    if (word.endsWith("ies"))
+        forms.push(word.slice(0, -3) + "y");
+    return forms;
+}
+/** True when a comma comes later and a subject comes after it: "Based on X, the monitor ...". */
+function hasLaterSubject(tokens, from) {
+    for (let i = from; i < tokens.length; i++) {
+        const token = tokens[i];
+        if (token.kind !== "punct" || token.text !== ",")
+            continue;
+        const next = tokens[nextCounted(tokens, i + 1)];
+        if (next === undefined)
+            return false;
+        return next.kind === "code" || isCapitalized(next) || (isWord(next) && (DETERMINERS.has(next.lower) || SUBJECT_PRONOUNS.has(next.lower)));
+    }
+    return false;
+}
+const PLURAL_AUXILIARIES = new Set(["are", "were", "have", "do", "don't", "aren't", "weren't", "can", "cannot", "must", "will"]);
+/**
+ * True when a verb for a plural subject comes later, after a noun:
+ * "Samples at or above this value wait ...", "Values below zero are ...".
+ * Then the first word is a plural noun, not a verb.
+ */
+function hasPluralVerbLater(tokens, from, lexicon) {
+    for (let i = from; i < tokens.length; i++) {
+        const token = tokens[i];
+        const previous = tokens[i - 1];
+        if (!isWord(token) || !isWord(previous))
+            continue;
+        if (DETERMINERS.has(previous.lower) || PREPOSITIONS.has(previous.lower) || MODALS.has(previous.lower) || previous.lower === "not")
+            continue;
+        if (PLURAL_AUXILIARIES.has(token.lower))
+            return true;
+        if (lexicon.verbs.has(token.lower) && !token.lower.endsWith("s"))
+            return true;
+    }
+    return false;
+}
+/** Relative pronouns. A word before one of them is a noun: "Tags whose content ...". */
+const RELATIVE_PRONOUNS = new Set(["whose", "which", "who", "whom"]);
+/**
+ * True when the words after the first word show that the first word is a
+ * plural noun, not a verb. These words show a noun:
+ *
+ * - An auxiliary verb, a conjunction or "of": "Values are ...", "Values of ..."
+ * - "per" or a relative pronoun: "Samples per round", "Tags whose ..."
+ * - A base form of a verb: "Monitors ask ..."
+ * - A participle and a preposition: "Handles returned by ...".
+ */
+function isNounSubject(tokens, index, lexicon) {
+    const next = tokens[index + 1];
+    if (!isWord(next))
+        return false;
+    const lower = next.lower;
+    if (BE_FORMS.has(lower) || MODALS.has(lower) || HAVE_FORMS.has(lower) || CONJUNCTIONS.has(lower) || lower === "of")
+        return true;
+    if (lower === "per" || RELATIVE_PRONOUNS.has(lower))
+        return true;
+    const after = tokens[index + 2];
+    const objectAfter = after === undefined || after.kind === "punct" || startsObject(after) || (isWord(after) && PREPOSITIONS.has(after.lower));
+    if (lexicon.verbs.has(lower) && !lower.endsWith("s") && !DETERMINERS.has(lower) && objectAfter)
+        return true;
+    return isParticiple(lower) && isWord(after) && PREPOSITIONS.has(after.lower);
+}
+/** The message when the sentence at `tokens` starts without a subject, or null. */
+export function missingSubject(tokens, lexicon) {
+    const k = nextCounted(tokens, 0);
+    const first = tokens[k];
+    if (!isWord(first) || !isCapitalized(first))
+        return null;
+    const lower = first.lower;
+    const next = tokens[k + 1];
+    const last = [...tokens].reverse().find((token) => token.kind === "punct");
+    if (AUXILIARY_STARTS.has(lower)) {
+        if (last?.text === "?")
+            return null;
+        return { index: k, message: `This sentence has no subject. Write the subject before "${first.text}", for example "This value ${lower} ...".` };
+    }
+    if (/^[a-z]{3,}s$/.test(lower) && !/(ss|us|is|ous|ics|ness)$/.test(lower) && !NOT_VERBS.has(lower)) {
+        const knownVerb = stems(lower).some((stem) => lexicon.verbs.has(stem));
+        if (next?.text === "," || isNounSubject(tokens, k, lexicon))
+            return null;
+        if (!knownVerb && !startsObject(next))
+            return null;
+        if (isWord(next) && PREPOSITIONS.has(next.lower) && hasPluralVerbLater(tokens, k + 2, lexicon))
+            return null;
+        const example = lower === "returns" ? "This function gives ..." : `This function ${lower} ...`;
+        return { index: k, message: `"${first.text}" has no subject. Do not omit the subject. Write a full sentence, for example "${example}".` };
+    }
+    if (isParticiple(lower) && isWord(next) && AFTER_PARTICIPLE.has(next.lower) && !hasLaterSubject(tokens, k + 1)) {
+        return { index: k, message: `"${first.text}" starts a sentence that has no subject. Write a full sentence with a subject in the active voice, for example "The monitor uses this value when ...".` };
+    }
+    return null;
+}
+/**
+ * The rule examines the summary and the `@remarks` text of doc comments.
+ * For example, "Returns the value." and "Called when the page is hidden."
+ * omit the subject. Text after `@param` and `@returns`, and list items, can
+ * be fragments, so the rule does not examine them.
+ */
+export const missingSubjectRule = {
+    id: "missing-subject",
+    description: "Find doc comment sentences that have no subject, for example \"Returns the value.\".",
+    ste: "4.2",
+    defaultSeverity: "error",
+    scope: "sentence",
+    check(unit, context) {
+        if (unit.origin.source !== "tsdoc" || unit.origin.tsdocSection === "tag" || unit.list !== null)
+            return;
+        for (const sentence of unit.sentences) {
+            if (!sentence.tokens.some(isCounted))
+                continue;
+            const found = missingSubject(sentence.tokens, context.lexicon);
+            if (found === null)
+                continue;
+            context.report({ ...tokenRange(sentence.tokens, found.index, found.index + 1), message: found.message });
+        }
+    },
+};
+//# sourceMappingURL=missing-subject.js.map

package/dist/rules/missing-subject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"missing-subject.js","sourceRoot":"","sources":["../../src/rules/missing-subject.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,EAAc,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC3H,OAAO,EAAE,UAAU,EAAa,MAAM,WAAW,CAAC;AAElD,mGAAmG;AACnG,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AAE1K,8CAA8C;AAC9C,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC;IACtB,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ;IAC7G,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,cAAc,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU;IAC/G,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO;CAClH,CAAC,CAAC;AAEH,8FAA8F;AAC9F,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEvH,SAAS,KAAK,CAAC,IAAa;IACxB,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAClC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;IAC9D,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,iGAAiG;AACjG,SAAS,eAAe,CAAC,MAAyB,EAAE,IAAa;IAC7D,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;QACzB,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,IAAI,KAAK,GAAG;YAAE,SAAS;QAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAChD,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9I,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAEjI;;;;GAIG;AACH,SAAS,kBAAkB,CAAC,MAAyB,EAAE,IAAa,EAAE,OAAiB;IACnF,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;QACzB,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;YAAE,SAAS;QAClD,IAAI,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,KAAK,KAAK;YAAE,SAAS;QAC5I,IAAI,kBAAkB,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QACrD,IAAI,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC;IAClF,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,wFAAwF;AACxF,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AAErE;;;;;;;;GAQG;AACH,SAAS,aAAa,CAAC,MAAyB,EAAE,KAAc,EAAE,OAAiB;IAC/E,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IAC/B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAChC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IACzB,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAChI,IAAI,KAAK,KAAK,KAAK,IAAI,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACjE,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IAChC,MAAM,WAAW,GAAG,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7I,IAAI,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,WAAW;QAAE,OAAO,IAAI,CAAC;IAC5G,OAAO,YAAY,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACjF,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,cAAc,CAAC,MAAyB,EAAE,OAAiB;IACvE,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACjC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACxB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACzD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;IAC1B,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3B,MAAM,IAAI,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;IAC3E,IAAI,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,IAAI,IAAI,EAAE,IAAI,KAAK,GAAG;YAAE,OAAO,IAAI,CAAC;QACpC,OAAO,EAAE,KAAK,EAAG,CAAC,EAAE,OAAO,EAAG,2DAA2D,KAAK,CAAC,IAAI,8BAA8B,KAAK,QAAQ,EAAE,CAAC;IACrJ,CAAC;IACD,IAAI,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QACjG,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QACvE,IAAI,IAAI,EAAE,IAAI,KAAK,GAAG,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,CAAC;YAAE,OAAO,IAAI,CAAC;QACzE,IAAI,CAAC,SAAS,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC;QACnD,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,kBAAkB,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC;YAAE,OAAO,IAAI,CAAC;QAC5G,MAAM,OAAO,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,iBAAiB,KAAK,MAAM,CAAC;QAC/F,OAAO,EAAE,KAAK,EAAG,CAAC,EAAE,OAAO,EAAG,IAAI,KAAK,CAAC,IAAI,kFAAkF,OAAO,IAAI,EAAE,CAAC;IAChJ,CAAC;IACD,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QAC7G,OAAO,EAAE,KAAK,EAAG,CAAC,EAAE,OAAO,EAAG,IAAI,KAAK,CAAC,IAAI,wJAAwJ,EAAE,CAAC;IAC3M,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAU;IACrC,EAAE,EAAG,iBAAiB;IACtB,WAAW,EAAG,sFAAsF;IACpG,GAAG,EAAG,KAAK;IACX,eAAe,EAAG,OAAO;IACzB,KAAK,EAAG,UAAU;IAClB,KAAK,CAAC,IAAI,EAAE,OAAO;QACf,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,KAAK,KAAK,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI;YAAE,OAAO;QACvG,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;gBAAE,SAAS;YAC/C,MAAM,KAAK,GAAG,cAAc,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YAC/D,IAAI,KAAK,KAAK,IAAI;gBAAE,SAAS;YAC7B,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,OAAO,EAAG,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9G,CAAC;IACL,CAAC;CACJ,CAAC"}

package/dist/rules/modal-verb.d.ts

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

package/dist/rules/modal-verb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modal-verb.d.ts","sourceRoot":"","sources":["../../src/rules/modal-verb.ts"],"names":[],"mappings":"AAGA,OAAO,EAAqC,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AA0CzE,eAAO,MAAM,SAAS,EAAG,IA0BxB,CAAC"}