@mark1russell7/ste-lint 0.0.0-stage → 0.1.2

package/dist/rules/modal-verb.js

@@ -0,0 +1,72 @@
+import { isClauseStart } from "../text/grammar.js";
+import { isNumber, isWord } from "../text/tokens.js";
+import { DETERMINERS } from "../text/words.js";
+import { forEachToken, surface, tokenRange } from "./rule.js";
+// These tables are maps, not object literals, so a word such as "constructor" does not find an Object property.
+const SINGLE = new Map([
+    ["should", "Write \"must\" for an obligation, or \"if\" for a condition (\"If X occurs, ...\")."],
+    ["shouldn", "Write \"must not\" for an obligation."],
+    ["may", "Write \"can\" for a possibility or a permission, or \"possibly\"."],
+    ["might", "Write \"can\" or \"possibly\"."],
+    ["would", "Write \"can\", or use a simple tense (\"is\", \"gives\")."],
+    ["wouldn", "Write \"cannot\", or use a simple tense (\"is not\")."],
+    ["shall", "Write \"must\"."],
+]);
+const CONTRACTIONS = new Map([
+    ["shouldn't", "shouldn"],
+    ["wouldn't", "wouldn"],
+    ["mightn't", "might"],
+    ["shan't", "shall"],
+    ["mayn't", "may"],
+]);
+const IMPERATIVE_HELP = "Write the instruction in the imperative (\"Do X\"), or use \"must\".";
+const NECESSARY_HELP = "Write the instruction in the imperative (\"Do X\"), or use \"must\" or \"it is necessary to\".";
+const WITH_TO = new Map([
+    ["ought", "Write \"must\"."],
+    ["have", IMPERATIVE_HELP],
+    ["has", IMPERATIVE_HELP],
+    ["had", "Use the simple past tense of the verb, or \"must\"."],
+    ["having", "Rewrite the sentence with \"must\" or with the imperative."],
+    ["need", NECESSARY_HELP],
+    ["needs", NECESSARY_HELP],
+    ["needed", "Write \"it was necessary to\", or rewrite the sentence."],
+]);
+/** True when "May" is the month: "May 2026", "3 May". */
+function isMonth(tokens, index) {
+    const token = tokens[index];
+    if (token.text !== "May")
+        return false;
+    return !isClauseStart(tokens, index) || isNumber(tokens[index + 1]) || isNumber(tokens[index - 1]);
+}
+export const modalVerb = {
+    id: "modal-verb",
+    description: "Find modal verbs that are not approved: should, may, might, would, shall, ought to, have to, need to.",
+    ste: "3.1, 3.4, 5.3",
+    defaultSeverity: "error",
+    scope: "word",
+    check(unit, context) {
+        forEachToken(unit, (tokens, i) => {
+            const token = tokens[i];
+            if (!isWord(token))
+                return;
+            const key = CONTRACTIONS.get(token.lower) ?? token.lower;
+            const help = SINGLE.get(key);
+            if (help !== undefined) {
+                if (key === "may" && isMonth(tokens, i))
+                    return;
+                context.report({ ...tokenRange(tokens, i, i + 1), message: `Do not use the modal verb "${token.text}". ${help}` });
+                return;
+            }
+            const withTo = WITH_TO.get(key);
+            const next = tokens[i + 1];
+            if (withTo === undefined || !isWord(next) || next.lower !== "to")
+                return;
+            const previous = tokens[i - 1];
+            // "the need to ..." is a noun phrase, not a modal verb.
+            if (key.startsWith("need") && isWord(previous) && DETERMINERS.has(previous.lower))
+                return;
+            context.report({ ...tokenRange(tokens, i, i + 2), message: `Do not use "${surface(tokens, i, i + 2)}". ${withTo}` });
+        });
+    },
+};
+//# sourceMappingURL=modal-verb.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"modal-verb.js","sourceRoot":"","sources":["../../src/rules/modal-verb.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAc,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAa,MAAM,WAAW,CAAC;AAEzE,gHAAgH;AAChH,MAAM,MAAM,GAAiC,IAAI,GAAG,CAAC;IACjD,CAAC,QAAQ,EAAE,qFAAqF,CAAC;IACjG,CAAC,SAAS,EAAE,uCAAuC,CAAC;IACpD,CAAC,KAAK,EAAE,mEAAmE,CAAC;IAC5E,CAAC,OAAO,EAAE,gCAAgC,CAAC;IAC3C,CAAC,OAAO,EAAE,2DAA2D,CAAC;IACtE,CAAC,QAAQ,EAAE,uDAAuD,CAAC;IACnE,CAAC,OAAO,EAAE,iBAAiB,CAAC;CAC/B,CAAC,CAAC;AAEH,MAAM,YAAY,GAAiC,IAAI,GAAG,CAAC;IACvD,CAAC,WAAW,EAAE,SAAS,CAAC;IACxB,CAAC,UAAU,EAAE,QAAQ,CAAC;IACtB,CAAC,UAAU,EAAE,OAAO,CAAC;IACrB,CAAC,QAAQ,EAAE,OAAO,CAAC;IACnB,CAAC,QAAQ,EAAE,KAAK,CAAC;CACpB,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,sEAAsE,CAAC;AAC/F,MAAM,cAAc,GAAG,gGAAgG,CAAC;AAExH,MAAM,OAAO,GAAiC,IAAI,GAAG,CAAC;IAClD,CAAC,OAAO,EAAE,iBAAiB,CAAC;IAC5B,CAAC,MAAM,EAAE,eAAe,CAAC;IACzB,CAAC,KAAK,EAAE,eAAe,CAAC;IACxB,CAAC,KAAK,EAAE,qDAAqD,CAAC;IAC9D,CAAC,QAAQ,EAAE,4DAA4D,CAAC;IACxE,CAAC,MAAM,EAAE,cAAc,CAAC;IACxB,CAAC,OAAO,EAAE,cAAc,CAAC;IACzB,CAAC,QAAQ,EAAE,yDAAyD,CAAC;CACxE,CAAC,CAAC;AAEH,yDAAyD;AACzD,SAAS,OAAO,CAAC,MAAyB,EAAE,KAAc;IACtD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAE,CAAC;IAC7B,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK;QAAE,OAAO,KAAK,CAAC;IACvC,OAAO,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;AACvG,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAU;IAC5B,EAAE,EAAG,YAAY;IACjB,WAAW,EAAG,uGAAuG;IACrH,GAAG,EAAG,eAAe;IACrB,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,GAAG,GAAG,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC;YACzD,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACrB,IAAI,GAAG,KAAK,KAAK,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;oBAAE,OAAO;gBAChD,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAG,8BAA8B,KAAK,CAAC,IAAI,MAAM,IAAI,EAAE,EAAE,CAAC,CAAC;gBACpH,OAAO;YACX,CAAC;YACD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAChC,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3B,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI;gBAAE,OAAO;YACzE,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/B,wDAAwD;YACxD,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAAE,OAAO;YAC1F,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAG,eAAe,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,MAAM,EAAE,EAAE,CAAC,CAAC;QAC1H,CAAC,CAAC,CAAC;IACP,CAAC;CACJ,CAAC"}

package/dist/rules/noun-cluster.d.ts

@@ -0,0 +1,17 @@
+import { type Rule } from "./rule.js";
+/**
+ * The rule counts a group of nouns in sequence, with no article,
+ * preposition or punctuation between them. Only these known nouns count:
+ *
+ * - Technical nouns and proper nouns from the glossary
+ * - Nouns from the dictionary
+ * - A built-in list of common software nouns
+ * - Abbreviations and code.
+ *
+ * Only the last noun of a group can be plural. Without a part-of-speech
+ * tagger, the rule cannot know if other words are nouns, so it does not
+ * count them. Thus it misses some clusters, but it seldom reports a false
+ * one.
+ */
+export declare const nounCluster: Rule;
+//# sourceMappingURL=noun-cluster.d.ts.map

package/dist/rules/noun-cluster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"noun-cluster.d.ts","sourceRoot":"","sources":["../../src/rules/noun-cluster.ts"],"names":[],"mappings":"AAEA,OAAO,EAAuB,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAiC3D;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW,EAAG,IAgC1B,CAAC"}

package/dist/rules/noun-cluster.js

@@ -0,0 +1,83 @@
+import { isAbbreviation, isWord } from "../text/tokens.js";
+import { surface, tokenRange } from "./rule.js";
+function singular(word) {
+    const forms = [];
+    if (word.endsWith("ies"))
+        forms.push(word.slice(0, -3) + "y");
+    if (word.endsWith("es"))
+        forms.push(word.slice(0, -2));
+    if (word.endsWith("s"))
+        forms.push(word.slice(0, -1));
+    return forms;
+}
+/** The noun at `tokens[index]`, or null when the token is not a known noun. */
+function nounAt(tokens, index, lexicon) {
+    const token = tokens[index];
+    if (token === undefined)
+        return null;
+    if (token.kind === "code") {
+        const kind = token.placeholder?.kind;
+        return kind === "code" || kind === "link" ? { length: 1, plural: false } : null;
+    }
+    if (!isWord(token))
+        return null;
+    const phrase = lexicon.technicalNounPhrases.longestMatch(tokens, index);
+    if (phrase > 1)
+        return { length: phrase, plural: tokens[index + phrase - 1].lower.endsWith("s") };
+    if (isAbbreviation(token))
+        return { length: 1, plural: /[a-z]s$/.test(token.text) };
+    if (lexicon.nouns.has(token.lower))
+        return { length: 1, plural: false };
+    if (singular(token.lower).some((form) => lexicon.nouns.has(form)))
+        return { length: 1, plural: true };
+    return null;
+}
+/**
+ * The rule counts a group of nouns in sequence, with no article,
+ * preposition or punctuation between them. Only these known nouns count:
+ *
+ * - Technical nouns and proper nouns from the glossary
+ * - Nouns from the dictionary
+ * - A built-in list of common software nouns
+ * - Abbreviations and code.
+ *
+ * Only the last noun of a group can be plural. Without a part-of-speech
+ * tagger, the rule cannot know if other words are nouns, so it does not
+ * count them. Thus it misses some clusters, but it seldom reports a false
+ * one.
+ */
+export const nounCluster = {
+    id: "noun-cluster",
+    description: "Find groups of more than 3 nouns in sequence (noun clusters).",
+    ste: "2.1",
+    defaultSeverity: "warning",
+    scope: "word",
+    check(unit, context) {
+        const max = context.config.limits.nounClusterNouns;
+        for (const sentence of unit.sentences) {
+            const tokens = sentence.tokens;
+            let i = 0;
+            while (i < tokens.length) {
+                let count = 0;
+                let j = i;
+                let plural = false;
+                while (!plural) {
+                    const noun = nounAt(tokens, j, context.lexicon);
+                    if (noun === null)
+                        break;
+                    count++;
+                    j += noun.length;
+                    plural = noun.plural;
+                }
+                if (count > max) {
+                    context.report({
+                        ...tokenRange(tokens, i, j),
+                        message: `"${surface(tokens, i, j)}" has ${count} nouns in sequence. Use no more than ${max}. Use a preposition to divide the group, for example "the interval of the heartbeat" instead of "heartbeat interval".`,
+                    });
+                }
+                i = count > 0 ? j : i + 1;
+            }
+        }
+    },
+};
+//# sourceMappingURL=noun-cluster.js.map

package/dist/rules/noun-cluster.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"noun-cluster.js","sourceRoot":"","sources":["../../src/rules/noun-cluster.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAc,MAAM,mBAAmB,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAa,MAAM,WAAW,CAAC;AAQ3D,SAAS,QAAQ,CAAC,IAAa;IAC3B,MAAM,KAAK,GAAc,EAAE,CAAC;IAC5B,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,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,GAAG,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACtD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,+EAA+E;AAC/E,SAAS,MAAM,CAAC,MAAyB,EAAE,KAAc,EAAE,OAAiB;IACxE,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC5B,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACrC,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QACxB,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC;QACrC,OAAO,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAG,CAAC,EAAE,MAAM,EAAG,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACtF,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAChC,MAAM,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACxE,IAAI,MAAM,GAAG,CAAC;QAAE,OAAO,EAAE,MAAM,EAAG,MAAM,EAAE,MAAM,EAAG,MAAM,CAAC,KAAK,GAAG,MAAM,GAAG,CAAC,CAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;IACrG,IAAI,cAAc,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,MAAM,EAAG,CAAC,EAAE,MAAM,EAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;IACtF,IAAI,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,MAAM,EAAG,CAAC,EAAE,MAAM,EAAG,KAAK,EAAE,CAAC;IAC1E,IAAI,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAAE,OAAO,EAAE,MAAM,EAAG,CAAC,EAAE,MAAM,EAAG,IAAI,EAAE,CAAC;IACxG,OAAO,IAAI,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,WAAW,GAAU;IAC9B,EAAE,EAAG,cAAc;IACnB,WAAW,EAAG,+DAA+D;IAC7E,GAAG,EAAG,KAAK;IACX,eAAe,EAAG,SAAS;IAC3B,KAAK,EAAG,MAAM;IACd,KAAK,CAAC,IAAI,EAAE,OAAO;QACf,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC;QACnD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;YAC/B,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;gBACvB,IAAI,KAAK,GAAG,CAAC,CAAC;gBACd,IAAI,CAAC,GAAG,CAAC,CAAC;gBACV,IAAI,MAAM,GAAG,KAAK,CAAC;gBACnB,OAAO,CAAC,MAAM,EAAE,CAAC;oBACb,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;oBAChD,IAAI,IAAI,KAAK,IAAI;wBAAE,MAAM;oBACzB,KAAK,EAAE,CAAC;oBACR,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC;oBACjB,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;gBACzB,CAAC;gBACD,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;oBACd,OAAO,CAAC,MAAM,CAAC;wBACX,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;wBAC3B,OAAO,EAAG,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,SAAS,KAAK,wCAAwC,GAAG,uHAAuH;qBACtN,CAAC,CAAC;gBACP,CAAC;gBACD,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YAC9B,CAAC;QACL,CAAC;IACL,CAAC;CACJ,CAAC"}

package/dist/rules/paragraph-length.d.ts

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

package/dist/rules/paragraph-length.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paragraph-length.d.ts","sourceRoot":"","sources":["../../src/rules/paragraph-length.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtC,eAAO,MAAM,eAAe,EAAG,IAgB9B,CAAC"}

package/dist/rules/paragraph-length.js

@@ -0,0 +1,19 @@
+export const paragraphLength = {
+    id: "paragraph-length",
+    description: "A paragraph can have no more than 6 sentences.",
+    ste: "6.6",
+    defaultSeverity: "warning",
+    scope: "paragraph",
+    check(unit, context) {
+        const limit = context.config.limits.paragraphSentences;
+        const count = unit.sentences.length;
+        if (count <= limit)
+            return;
+        context.report({
+            start: unit.start,
+            end: unit.end,
+            message: `This paragraph has ${count} sentences. Use no more than ${limit} sentences in a paragraph. Divide it into two paragraphs, each with one topic.`,
+        });
+    },
+};
+//# sourceMappingURL=paragraph-length.js.map

package/dist/rules/paragraph-length.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paragraph-length.js","sourceRoot":"","sources":["../../src/rules/paragraph-length.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,eAAe,GAAU;IAClC,EAAE,EAAG,kBAAkB;IACvB,WAAW,EAAG,gDAAgD;IAC9D,GAAG,EAAG,KAAK;IACX,eAAe,EAAG,SAAS;IAC3B,KAAK,EAAG,WAAW;IACnB,KAAK,CAAC,IAAI,EAAE,OAAO;QACf,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC;QACvD,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;QACpC,IAAI,KAAK,IAAI,KAAK;YAAE,OAAO;QAC3B,OAAO,CAAC,MAAM,CAAC;YACX,KAAK,EAAG,IAAI,CAAC,KAAK;YAClB,GAAG,EAAG,IAAI,CAAC,GAAG;YACd,OAAO,EAAG,sBAAsB,KAAK,gCAAgC,KAAK,gFAAgF;SAC7J,CAAC,CAAC;IACP,CAAC;CACJ,CAAC"}

package/dist/rules/passive-instruction.d.ts

@@ -0,0 +1,15 @@
+import { type Rule } from "./rule.js";
+/**
+ * The rule examines these constructions:
+ *
+ * - An obligation in the passive voice ("must be set", "has to be called",
+ *   "needs to be installed") in any sentence. This is an instruction in a
+ *   passive form.
+ * - Any passive ("is cleared", "are triggered by CI") in a procedural
+ *   sentence: an imperative sentence or an item of an ordered list. A
+ *   participle after "be" in a condition clause ("if the file is deleted",
+ *   "make sure that the server is started") shows a state, so the rule
+ *   ignores it.
+ */
+export declare const passiveInstruction: Rule;
+//# sourceMappingURL=passive-instruction.d.ts.map

package/dist/rules/passive-instruction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"passive-instruction.d.ts","sourceRoot":"","sources":["../../src/rules/passive-instruction.ts"],"names":[],"mappings":"AACA,OAAO,EAAuB,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAE3D;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,kBAAkB,EAAG,IAqBjC,CAAC"}

package/dist/rules/passive-instruction.js

@@ -0,0 +1,38 @@
+import { findPassives } from "../text/grammar.js";
+import { surface, tokenRange } from "./rule.js";
+/**
+ * The rule examines these constructions:
+ *
+ * - An obligation in the passive voice ("must be set", "has to be called",
+ *   "needs to be installed") in any sentence. This is an instruction in a
+ *   passive form.
+ * - Any passive ("is cleared", "are triggered by CI") in a procedural
+ *   sentence: an imperative sentence or an item of an ordered list. A
+ *   participle after "be" in a condition clause ("if the file is deleted",
+ *   "make sure that the server is started") shows a state, so the rule
+ *   ignores it.
+ */
+export const passiveInstruction = {
+    id: "passive-instruction",
+    description: "Find the passive voice in instructions. An instruction uses the active voice and the imperative.",
+    ste: "3.4, 3.6, 5.3",
+    defaultSeverity: "warning",
+    scope: "sentence",
+    check(unit, context) {
+        for (const sentence of unit.sentences) {
+            const procedural = sentence.instruction || unit.list?.ordered === true;
+            for (const passive of findPassives(sentence.tokens)) {
+                if (!passive.obligation && !(procedural && !passive.inCondition))
+                    continue;
+                const from = passive.start;
+                const to = passive.participle + 1;
+                const phrase = surface(sentence.tokens, from, to);
+                const message = passive.obligation
+                    ? `"${phrase}" is an instruction in the passive voice. Write the instruction in the imperative, for example "Set the value before you start the monitor."`
+                    : `"${phrase}" is in the passive voice. In an instruction, use the active voice: write the imperative, or tell who or what does the action.`;
+                context.report({ ...tokenRange(sentence.tokens, from, to), message });
+            }
+        }
+    },
+};
+//# sourceMappingURL=passive-instruction.js.map

package/dist/rules/passive-instruction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"passive-instruction.js","sourceRoot":"","sources":["../../src/rules/passive-instruction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,UAAU,EAAa,MAAM,WAAW,CAAC;AAE3D;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAU;IACrC,EAAE,EAAG,qBAAqB;IAC1B,WAAW,EAAG,kGAAkG;IAChH,GAAG,EAAG,eAAe;IACrB,eAAe,EAAG,SAAS;IAC3B,KAAK,EAAG,UAAU;IAClB,KAAK,CAAC,IAAI,EAAE,OAAO;QACf,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,UAAU,GAAG,QAAQ,CAAC,WAAW,IAAI,IAAI,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;YACvE,KAAK,MAAM,OAAO,IAAI,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAClD,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC,UAAU,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;oBAAE,SAAS;gBAC3E,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC;gBAC3B,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,GAAG,CAAC,CAAC;gBAClC,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;gBAClD,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU;oBAC9B,CAAC,CAAC,IAAI,MAAM,8IAA8I;oBAC1J,CAAC,CAAC,IAAI,MAAM,gIAAgI,CAAC;gBACjJ,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;YAC1E,CAAC;QACL,CAAC;IACL,CAAC;CACJ,CAAC"}

package/dist/rules/pronouns.d.ts

@@ -0,0 +1,4 @@
+import { type Rule } from "./rule.js";
+export declare const genderedPronoun: Rule;
+export declare const firstPerson: Rule;
+//# sourceMappingURL=pronouns.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pronouns.d.ts","sourceRoot":"","sources":["../../src/rules/pronouns.ts"],"names":[],"mappings":"AACA,OAAO,EAA4B,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAOhE,eAAO,MAAM,eAAe,EAAG,IAgB9B,CAAC;AAKF,eAAO,MAAM,WAAW,EAAG,IAwB1B,CAAC"}

package/dist/rules/pronouns.js

@@ -0,0 +1,57 @@
+import { isWord } from "../text/tokens.js";
+import { forEachToken, tokenRange } from "./rule.js";
+const GENDERED = new Set([
+    "he", "she", "his", "her", "him", "hers", "himself", "herself",
+    "he's", "she's", "he'd", "she'd", "he'll", "she'll",
+]);
+export const genderedPronoun = {
+    id: "gendered-pronoun",
+    description: "Find gendered pronouns: he, she, his, her, him, hers, himself and herself.",
+    ste: "GR-3, GR-7",
+    defaultSeverity: "error",
+    scope: "word",
+    check(unit, context) {
+        forEachToken(unit, (tokens, i) => {
+            const token = tokens[i];
+            if (!isWord(token) || !GENDERED.has(token.lower))
+                return;
+            context.report({
+                ...tokenRange(tokens, i, i + 1),
+                message: `Do not use the gendered pronoun "${token.text}". Write "they" or "it", or write the noun again.`,
+            });
+        });
+    },
+};
+const SINGULAR = new Set(["i", "me", "my", "mine", "myself", "i'm", "i've", "i'll", "i'd"]);
+const PLURAL = new Set(["our", "ours", "ourselves"]);
+export const firstPerson = {
+    id: "first-person",
+    description: "Find first-person pronouns other than \"we\": I, me, my, our and us. Use \"we\" only for the organization that writes the text.",
+    ste: "GR-3",
+    defaultSeverity: "warning",
+    scope: "word",
+    check(unit, context) {
+        forEachToken(unit, (tokens, i) => {
+            const token = tokens[i];
+            if (!isWord(token))
+                return;
+            const lower = token.lower;
+            let message = null;
+            if (SINGULAR.has(lower)) {
+                message = `Do not use "${token.text}". Write "you" for the reader, or "we" for the organization that writes the text.`;
+            }
+            else if (PLURAL.has(lower)) {
+                message = `Do not use "${token.text}". Write the name of the project or the product, or rewrite the sentence with "we" as the subject.`;
+            }
+            else if (lower === "us" && token.text !== "US") {
+                message = "Do not use \"us\". Rewrite the sentence with \"we\" as the subject.";
+            }
+            else if (lower === "let's") {
+                message = "Do not use \"let's\". Write the instruction in the imperative.";
+            }
+            if (message !== null)
+                context.report({ ...tokenRange(tokens, i, i + 1), message });
+        });
+    },
+};
+//# sourceMappingURL=pronouns.js.map

package/dist/rules/pronouns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pronouns.js","sourceRoot":"","sources":["../../src/rules/pronouns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,UAAU,EAAa,MAAM,WAAW,CAAC;AAEhE,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC;IACrB,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS;IAC9D,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ;CACtD,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,eAAe,GAAU;IAClC,EAAE,EAAG,kBAAkB;IACvB,WAAW,EAAG,4EAA4E;IAC1F,GAAG,EAAG,YAAY;IAClB,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,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC;gBAAE,OAAO;YACzD,OAAO,CAAC,MAAM,CAAC;gBACX,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC/B,OAAO,EAAG,oCAAoC,KAAK,CAAC,IAAI,mDAAmD;aAC9G,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;CACJ,CAAC;AAEF,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;AAC5F,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;AAErD,MAAM,CAAC,MAAM,WAAW,GAAU;IAC9B,EAAE,EAAG,cAAc;IACnB,WAAW,EAAG,iIAAiI;IAC/I,GAAG,EAAG,MAAM;IACZ,eAAe,EAAG,SAAS;IAC3B,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,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;YAC1B,IAAI,OAAO,GAAmB,IAAI,CAAC;YACnC,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtB,OAAO,GAAG,eAAe,KAAK,CAAC,IAAI,mFAAmF,CAAC;YAC3H,CAAC;iBAAM,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3B,OAAO,GAAG,eAAe,KAAK,CAAC,IAAI,oGAAoG,CAAC;YAC5I,CAAC;iBAAM,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;gBAC/C,OAAO,GAAG,qEAAqE,CAAC;YACpF,CAAC;iBAAM,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;gBAC3B,OAAO,GAAG,gEAAgE,CAAC;YAC/E,CAAC;YACD,IAAI,OAAO,KAAK,IAAI;gBAAE,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACvF,CAAC,CAAC,CAAC;IACP,CAAC;CACJ,CAAC"}

package/dist/rules/rule.d.ts

@@ -0,0 +1,46 @@
+import type { ResolvedConfig } from "../config.js";
+import type { Lexicon } from "../lexicon.js";
+import type { Token } from "../text/tokens.js";
+import type { RuleId, Severity } from "../types.js";
+import type { ProseUnit, Sentence } from "../units.js";
+import type { WordListMatcher } from "./word-list-matcher.js";
+/**
+ * Which units a rule examines. Headings and table cells get only the
+ * "word" rules. Paragraphs and list items get all rules.
+ */
+export type RuleScope = "word" | "sentence" | "paragraph";
+export type Report = {
+    /** The file offset of the first character of the problem. */
+    readonly start: number;
+    /** The file offset after the last character of the problem. */
+    readonly end: number;
+    readonly message: string;
+    /** The severity of this finding, when it is not the default severity of the rule (for example a word list entry). */
+    readonly severity?: Severity;
+};
+export type RuleContext = {
+    readonly config: ResolvedConfig;
+    readonly lexicon: Lexicon;
+    readonly wordList: WordListMatcher;
+    report(report: Report): void;
+};
+export type Rule = {
+    readonly id: RuleId;
+    /** One sentence that tells what the rule finds. */
+    readonly description: string;
+    /** The related ASD-STE100 rule numbers. */
+    readonly ste: string;
+    readonly defaultSeverity: Severity;
+    readonly scope: RuleScope;
+    check(unit: ProseUnit, context: RuleContext): void;
+};
+/** The surface text of `tokens[from]` to `tokens[to - 1]`, with one space between tokens that had space between them. */
+export declare function surface(tokens: readonly Token[], from: number, to: number): string;
+/** A report for the tokens `from` to `to - 1` of a sentence. */
+export declare function tokenRange(tokens: readonly Token[], from: number, to: number): {
+    start: number;
+    end: number;
+};
+/** This function gives each token of each sentence of the unit to `visit`. */
+export declare function forEachToken(unit: ProseUnit, visit: (tokens: readonly Token[], index: number, sentence: Sentence) => void): void;
+//# sourceMappingURL=rule.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../../src/rules/rule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,WAAW,CAAC;AAE1D,MAAM,MAAM,MAAM,GAAG;IACjB,6DAA6D;IAC7D,QAAQ,CAAC,KAAK,EAAG,MAAM,CAAC;IACxB,+DAA+D;IAC/D,QAAQ,CAAC,GAAG,EAAG,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAG,MAAM,CAAC;IAC1B,qHAAqH;IACrH,QAAQ,CAAC,QAAQ,CAAC,EAAG,QAAQ,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACtB,QAAQ,CAAC,MAAM,EAAG,cAAc,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAG,OAAO,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAG,eAAe,CAAC;IACpC,MAAM,CAAC,MAAM,EAAG,MAAM,GAAI,IAAI,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACf,QAAQ,CAAC,EAAE,EAAG,MAAM,CAAC;IACrB,mDAAmD;IACnD,QAAQ,CAAC,WAAW,EAAG,MAAM,CAAC;IAC9B,2CAA2C;IAC3C,QAAQ,CAAC,GAAG,EAAG,MAAM,CAAC;IACtB,QAAQ,CAAC,eAAe,EAAG,QAAQ,CAAC;IACpC,QAAQ,CAAC,KAAK,EAAG,SAAS,CAAC;IAC3B,KAAK,CAAC,IAAI,EAAG,SAAS,EAAE,OAAO,EAAG,WAAW,GAAI,IAAI,CAAC;CACzD,CAAC;AAEF,yHAAyH;AACzH,wBAAgB,OAAO,CAAC,MAAM,EAAG,SAAS,KAAK,EAAE,EAAE,IAAI,EAAG,MAAM,EAAE,EAAE,EAAG,MAAM,GAAI,MAAM,CAQtF;AAYD,gEAAgE;AAChE,wBAAgB,UAAU,CAAC,MAAM,EAAG,SAAS,KAAK,EAAE,EAAE,IAAI,EAAG,MAAM,EAAE,EAAE,EAAG,MAAM,GAAI;IAAE,KAAK,EAAG,MAAM,CAAC;IAAC,GAAG,EAAG,MAAM,CAAA;CAAE,CAEnH;AAED,8EAA8E;AAC9E,wBAAgB,YAAY,CAAC,IAAI,EAAG,SAAS,EAAE,KAAK,EAAG,CAAC,MAAM,EAAG,SAAS,KAAK,EAAE,EAAE,KAAK,EAAG,MAAM,EAAE,QAAQ,EAAG,QAAQ,KAAK,IAAI,GAAI,IAAI,CAItI"}

package/dist/rules/rule.js

@@ -0,0 +1,31 @@
+/** The surface text of `tokens[from]` to `tokens[to - 1]`, with one space between tokens that had space between them. */
+export function surface(tokens, from, to) {
+    let text = "";
+    for (let i = from; i < to; i++) {
+        const token = tokens[i];
+        const value = token.kind === "code" && token.placeholder !== null ? placeholderText(token) : token.text;
+        text += (i > from && token.spaceBefore ? " " : "") + value;
+    }
+    return text;
+}
+function placeholderText(token) {
+    const placeholder = token.placeholder;
+    switch (placeholder.kind) {
+        case "code": return `\`${placeholder.text}\``;
+        case "quote": return `"${placeholder.text}"`;
+        case "link": return `{${placeholder.text}}`;
+        default: return placeholder.text;
+    }
+}
+/** A report for the tokens `from` to `to - 1` of a sentence. */
+export function tokenRange(tokens, from, to) {
+    return { start: tokens[from].start, end: tokens[to - 1].end };
+}
+/** This function gives each token of each sentence of the unit to `visit`. */
+export function forEachToken(unit, visit) {
+    for (const sentence of unit.sentences) {
+        for (let i = 0; i < sentence.tokens.length; i++)
+            visit(sentence.tokens, i, sentence);
+    }
+}
+//# sourceMappingURL=rule.js.map

package/dist/rules/rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule.js","sourceRoot":"","sources":["../../src/rules/rule.ts"],"names":[],"mappings":"AAyCA,yHAAyH;AACzH,MAAM,UAAU,OAAO,CAAC,MAAyB,EAAE,IAAa,EAAE,EAAW;IACzE,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;QACzB,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;QACxG,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC;IAC/D,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAS,eAAe,CAAC,KAAa;IAClC,MAAM,WAAW,GAAG,KAAK,CAAC,WAAY,CAAC;IACvC,QAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;QACvB,KAAK,MAAM,CAAC,CAAC,OAAO,KAAK,WAAW,CAAC,IAAI,IAAI,CAAC;QAC9C,KAAK,OAAO,CAAC,CAAC,OAAO,IAAI,WAAW,CAAC,IAAI,GAAG,CAAC;QAC7C,KAAK,MAAM,CAAC,CAAC,OAAO,IAAI,WAAW,CAAC,IAAI,GAAG,CAAC;QAC5C,OAAO,CAAC,CAAC,OAAO,WAAW,CAAC,IAAI,CAAC;IACrC,CAAC;AACL,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,UAAU,CAAC,MAAyB,EAAE,IAAa,EAAE,EAAW;IAC5E,OAAO,EAAE,KAAK,EAAG,MAAM,CAAC,IAAI,CAAE,CAAC,KAAK,EAAE,GAAG,EAAG,MAAM,CAAC,EAAE,GAAG,CAAC,CAAE,CAAC,GAAG,EAAE,CAAC;AACtE,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,YAAY,CAAC,IAAgB,EAAE,KAAgF;IAC3H,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;QACpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE;YAAE,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IACzF,CAAC;AACL,CAAC"}

package/dist/rules/semicolon.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"semicolon.d.ts","sourceRoot":"","sources":["../../src/rules/semicolon.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAEhE,eAAO,MAAM,SAAS,EAAG,IAgBxB,CAAC"}

package/dist/rules/semicolon.js

@@ -0,0 +1,20 @@
+import { forEachToken, tokenRange } from "./rule.js";
+export const semicolon = {
+    id: "semicolon",
+    description: "Find semicolons in prose. Semicolons in code spans are not prose.",
+    ste: "8.1",
+    defaultSeverity: "error",
+    scope: "word",
+    check(unit, context) {
+        forEachToken(unit, (tokens, i) => {
+            const token = tokens[i];
+            if (token.kind !== "punct" || (token.text !== ";" && token.text !== "；"))
+                return;
+            context.report({
+                ...tokenRange(tokens, i, i + 1),
+                message: "Do not use a semicolon. Write two sentences, or use a comma and \"and\" or \"but\". For a list of items, use a vertical list.",
+            });
+        });
+    },
+};
+//# sourceMappingURL=semicolon.js.map

package/dist/rules/semicolon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"semicolon.js","sourceRoot":"","sources":["../../src/rules/semicolon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAa,MAAM,WAAW,CAAC;AAEhE,MAAM,CAAC,MAAM,SAAS,GAAU;IAC5B,EAAE,EAAG,WAAW;IAChB,WAAW,EAAG,mEAAmE;IACjF,GAAG,EAAG,KAAK;IACX,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,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC;gBAAE,OAAO;YACjF,OAAO,CAAC,MAAM,CAAC;gBACX,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC/B,OAAO,EAAG,+HAA+H;aAC5I,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;CACJ,CAAC"}

package/dist/rules/sentence-length.d.ts

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

package/dist/rules/sentence-length.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sentence-length.d.ts","sourceRoot":"","sources":["../../src/rules/sentence-length.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtC,eAAO,MAAM,cAAc,EAAG,IA4B7B,CAAC"}

package/dist/rules/sentence-length.js

@@ -0,0 +1,31 @@
+import { countWords } from "../text/sentences.js";
+export const sentenceLength = {
+    id: "sentence-length",
+    description: "An instruction can have no more than 20 words. A description can have no more than 25 words.",
+    ste: "5.1, 6.3, 8.4-8.7",
+    defaultSeverity: "error",
+    scope: "sentence",
+    check(unit, context) {
+        const { instructionWords, descriptionWords } = context.config.limits;
+        for (const sentence of unit.sentences) {
+            const limit = sentence.instruction ? instructionWords : descriptionWords;
+            if (sentence.words > limit) {
+                const message = sentence.instruction
+                    ? `This instruction has ${sentence.words} words. Use no more than ${limit} words in an instruction. Divide it into shorter sentences.`
+                    : `This sentence has ${sentence.words} words. Use no more than ${limit} words in a descriptive sentence. Divide it into shorter sentences.`;
+                context.report({ start: sentence.start, end: sentence.end, message });
+            }
+            for (const inner of sentence.parentheticals) {
+                const words = countWords(inner, { properNouns: context.lexicon.properNounPhrases }).words;
+                if (words > descriptionWords) {
+                    context.report({
+                        start: inner[0].start,
+                        end: inner[inner.length - 1].end,
+                        message: `The text in parentheses has ${words} words. It counts as a separate sentence. Use no more than ${descriptionWords} words, or write it as a sentence after this one.`,
+                    });
+                }
+            }
+        }
+    },
+};
+//# sourceMappingURL=sentence-length.js.map

package/dist/rules/sentence-length.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sentence-length.js","sourceRoot":"","sources":["../../src/rules/sentence-length.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAGlD,MAAM,CAAC,MAAM,cAAc,GAAU;IACjC,EAAE,EAAG,iBAAiB;IACtB,WAAW,EAAG,8FAA8F;IAC5G,GAAG,EAAG,mBAAmB;IACzB,eAAe,EAAG,OAAO;IACzB,KAAK,EAAG,UAAU;IAClB,KAAK,CAAC,IAAI,EAAE,OAAO;QACf,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;QACrE,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC;YACzE,IAAI,QAAQ,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC;gBACzB,MAAM,OAAO,GAAG,QAAQ,CAAC,WAAW;oBAChC,CAAC,CAAC,wBAAwB,QAAQ,CAAC,KAAK,4BAA4B,KAAK,6DAA6D;oBACtI,CAAC,CAAC,qBAAqB,QAAQ,CAAC,KAAK,4BAA4B,KAAK,qEAAqE,CAAC;gBAChJ,OAAO,CAAC,MAAM,CAAC,EAAE,KAAK,EAAG,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAG,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;YAC5E,CAAC;YACD,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;gBAC1C,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,EAAE,EAAE,WAAW,EAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC,KAAK,CAAC;gBAC3F,IAAI,KAAK,GAAG,gBAAgB,EAAE,CAAC;oBAC3B,OAAO,CAAC,MAAM,CAAC;wBACX,KAAK,EAAG,KAAK,CAAC,CAAC,CAAE,CAAC,KAAK;wBACvB,GAAG,EAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAE,CAAC,GAAG;wBAClC,OAAO,EAAG,+BAA+B,KAAK,8DAA8D,gBAAgB,mDAAmD;qBAClL,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;CACJ,CAAC"}

package/dist/rules/unknown-word.d.ts

@@ -0,0 +1,9 @@
+import { type Rule } from "./rule.js";
+/**
+ * This rule is active only when a local dictionary is configured. It does
+ * not examine numbers, abbreviations, words that look like code or glossary
+ * terms. It also does not examine a word with a capital letter after the
+ * start of a sentence, because that word is possibly a proper noun.
+ */
+export declare const unknownWord: Rule;
+//# sourceMappingURL=unknown-word.d.ts.map

package/dist/rules/unknown-word.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unknown-word.d.ts","sourceRoot":"","sources":["../../src/rules/unknown-word.ts"],"names":[],"mappings":"AAIA,OAAO,EAAc,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAElD;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAG,IA8B1B,CAAC"}

package/dist/rules/unknown-word.js

@@ -0,0 +1,49 @@
+import { isGlossaryWord } from "../lexicon.js";
+import { nextCounted } from "../text/grammar.js";
+import { isAbbreviation, isCapitalized, isIdentifierLike, isNumber, isWord } from "../text/tokens.js";
+import { coveredByPhrases } from "./ing-verb.js";
+import { tokenRange } from "./rule.js";
+/**
+ * This rule is active only when a local dictionary is configured. It does
+ * not examine numbers, abbreviations, words that look like code or glossary
+ * terms. It also does not examine a word with a capital letter after the
+ * start of a sentence, because that word is possibly a proper noun.
+ */
+export const unknownWord = {
+    id: "unknown-word",
+    description: "Find words that are not in the local dictionary and not in the project glossary.",
+    ste: "1.1, 1.5, 1.12",
+    defaultSeverity: "warning",
+    scope: "word",
+    check(unit, context) {
+        const { lexicon } = context;
+        const dictionary = lexicon.dictionary;
+        if (dictionary === null)
+            return;
+        for (const sentence of unit.sentences) {
+            const tokens = sentence.tokens;
+            const covered = coveredByPhrases(tokens, lexicon.glossaryPhrases);
+            const first = nextCounted(tokens, 0);
+            tokens.forEach((token, i) => {
+                if (!isWord(token) || covered.has(i))
+                    return;
+                if (isNumber(token) || isAbbreviation(token) || isIdentifierLike(token) || /\d/.test(token.text))
+                    return;
+                if (i !== first && isCapitalized(token))
+                    return;
+                for (const part of token.lower.split("-")) {
+                    if (part.length === 0 || isGlossaryWord(part, lexicon))
+                        continue;
+                    const lookup = dictionary.lookup(part);
+                    if (lookup.status === "approved")
+                        continue;
+                    const message = lookup.status === "not-approved"
+                        ? `"${part}" is not an approved word. ${lookup.alternatives.length > 0 ? `Use ${lookup.alternatives.map((word) => `"${word}"`).join(" or ")}.` : "Use an approved word, or a different construction."}`
+                        : `"${part}" is not in the dictionary or the project glossary. Use an approved word. If "${part}" is a technical term, add it to technicalNouns or technicalVerbs.`;
+                    context.report({ ...tokenRange(tokens, i, i + 1), message });
+                }
+            });
+        }
+    },
+};
+//# sourceMappingURL=unknown-word.js.map

package/dist/rules/unknown-word.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unknown-word.js","sourceRoot":"","sources":["../../src/rules/unknown-word.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AACtG,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,UAAU,EAAa,MAAM,WAAW,CAAC;AAElD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAU;IAC9B,EAAE,EAAG,cAAc;IACnB,WAAW,EAAG,kFAAkF;IAChG,GAAG,EAAG,gBAAgB;IACtB,eAAe,EAAG,SAAS;IAC3B,KAAK,EAAG,MAAM;IACd,KAAK,CAAC,IAAI,EAAE,OAAO;QACf,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAC5B,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACtC,IAAI,UAAU,KAAK,IAAI;YAAE,OAAO;QAChC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;YAC/B,MAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;YAClE,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YACrC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;gBACxB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;oBAAE,OAAO;gBAC7C,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,cAAc,CAAC,KAAK,CAAC,IAAI,gBAAgB,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;oBAAE,OAAO;gBACzG,IAAI,CAAC,KAAK,KAAK,IAAI,aAAa,CAAC,KAAK,CAAC;oBAAE,OAAO;gBAChD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC;wBAAE,SAAS;oBACjE,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;oBACvC,IAAI,MAAM,CAAC,MAAM,KAAK,UAAU;wBAAE,SAAS;oBAC3C,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,KAAK,cAAc;wBAC5C,CAAC,CAAC,IAAI,IAAI,8BAA8B,MAAM,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,oDAAoD,EAAE;wBACvM,CAAC,CAAC,IAAI,IAAI,iFAAiF,IAAI,oEAAoE,CAAC;oBACxK,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;gBACjE,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC;IACL,CAAC;CACJ,CAAC"}