slopless 0.1.0

package/dist/families/orthography/sentence-case.js

@@ -0,0 +1,66 @@
+import { RuleHelper } from "textlint-rule-helper";
+import { sourceText } from "../../shared/text/traverse.js";
+import { splitWhitespace } from "../../shared/text/whitespace.js";
+const MAX_CAPITALIZED_NON_FIRST_WORDS = 2;
+const MAX_RUST_HEADING_DEPTH = 2;
+function isUppercaseLetter(character) {
+    const lower = character.toLocaleLowerCase();
+    const upper = character.toLocaleUpperCase();
+    return lower !== upper && character === upper;
+}
+function hasLowercaseLetter(text) {
+    for (const character of text) {
+        const lower = character.toLocaleLowerCase();
+        const upper = character.toLocaleUpperCase();
+        if (lower !== upper && character === lower) {
+            return true;
+        }
+    }
+    return false;
+}
+function isTitleCased(word) {
+    const first = word[0];
+    if (first === undefined || !isUppercaseLetter(first)) {
+        return false;
+    }
+    return hasLowercaseLetter(word.slice(1));
+}
+function countCapitalizedNonFirstWords(text) {
+    let count = 0;
+    const words = splitWhitespace(text);
+    for (let index = 1; index < words.length; index += 1) {
+        const word = words[index];
+        if (word !== undefined && isTitleCased(word)) {
+            count += 1;
+        }
+    }
+    return count;
+}
+const rule = (context) => {
+    const { Syntax, RuleError, report } = context;
+    const helper = new RuleHelper(context);
+    const ignoredParents = [
+        Syntax.List,
+        Syntax.ListItem,
+        Syntax.Table,
+        Syntax.TableCell
+    ];
+    return {
+        [Syntax.Header](node) {
+            if (helper.isChildNode(node, ignoredParents)) {
+                return;
+            }
+            if (node.depth > MAX_RUST_HEADING_DEPTH) {
+                return;
+            }
+            const source = sourceText(node);
+            const count = countCapitalizedNonFirstWords(source.text);
+            if (count <= MAX_CAPITALIZED_NON_FIRST_WORDS) {
+                return;
+            }
+            report(node, new RuleError(`Heading looks like title case. Use sentence case; found ${count} capitalized non-first words.`));
+        }
+    };
+};
+export default rule;
+//# sourceMappingURL=sentence-case.js.map

package/dist/families/orthography/sentence-case.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sentence-case.js","sourceRoot":"","sources":["../../../src/families/orthography/sentence-case.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAElE,MAAM,+BAA+B,GAAG,CAAC,CAAC;AAC1C,MAAM,sBAAsB,GAAG,CAAC,CAAC;AAEjC,SAAS,iBAAiB,CAAC,SAAiB;IAC1C,MAAM,KAAK,GAAG,SAAS,CAAC,iBAAiB,EAAE,CAAC;IAC5C,MAAM,KAAK,GAAG,SAAS,CAAC,iBAAiB,EAAE,CAAC;IAE5C,OAAO,KAAK,KAAK,KAAK,IAAI,SAAS,KAAK,KAAK,CAAC;AAChD,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAY;IACtC,KAAK,MAAM,SAAS,IAAI,IAAI,EAAE,CAAC;QAC7B,MAAM,KAAK,GAAG,SAAS,CAAC,iBAAiB,EAAE,CAAC;QAC5C,MAAM,KAAK,GAAG,SAAS,CAAC,iBAAiB,EAAE,CAAC;QAE5C,IAAI,KAAK,KAAK,KAAK,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;YAC3C,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACtB,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;QACrD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3C,CAAC;AAED,SAAS,6BAA6B,CAAC,IAAY;IACjD,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,MAAM,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAEpC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1B,IAAI,IAAI,KAAK,SAAS,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7C,KAAK,IAAI,CAAC,CAAC;QACb,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,IAAI,GAAuB,CAAC,OAAO,EAAE,EAAE;IAC3C,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC9C,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;IACvC,MAAM,cAAc,GAAG;QACrB,MAAM,CAAC,IAAI;QACX,MAAM,CAAC,QAAQ;QACf,MAAM,CAAC,KAAK;QACZ,MAAM,CAAC,SAAS;KACjB,CAAC;IAEF,OAAO;QACL,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAmB;YACjC,IAAI,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC;gBAC7C,OAAO;YACT,CAAC;YAED,IAAI,IAAI,CAAC,KAAK,GAAG,sBAAsB,EAAE,CAAC;gBACxC,OAAO;YACT,CAAC;YAED,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;YAChC,MAAM,KAAK,GAAG,6BAA6B,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAEzD,IAAI,KAAK,IAAI,+BAA+B,EAAE,CAAC;gBAC7C,OAAO;YACT,CAAC;YAED,MAAM,CACJ,IAAI,EACJ,IAAI,SAAS,CACX,2DAA2D,KAAK,+BAA+B,CAChG,CACF,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/families/orthography/smart-quotes.js

@@ -0,0 +1,53 @@
+import { RuleHelper } from "textlint-rule-helper";
+import { splitSentences } from "../../shared/text/sentences.js";
+import { sourceText } from "../../shared/text/traverse.js";
+const SMART_QUOTES = new Set(["\u201C", "\u201D", "\u2018", "\u2019"]);
+function findSmartQuotes(text) {
+    const matches = [];
+    for (const sentence of splitSentences(text)) {
+        let matchedText = "";
+        let start;
+        let end = sentence.start;
+        for (let index = sentence.start; index < sentence.end; index += 1) {
+            const character = text[index];
+            if (character === undefined || !SMART_QUOTES.has(character)) {
+                continue;
+            }
+            start ??= index;
+            end = index + character.length;
+            matchedText += character;
+        }
+        if (start !== undefined) {
+            matches.push({ end, matchedText, start });
+        }
+    }
+    return matches;
+}
+const rule = (context) => {
+    const { Syntax, RuleError, locator, report } = context;
+    const helper = new RuleHelper(context);
+    const ignoredParents = [
+        Syntax.List,
+        Syntax.ListItem,
+        Syntax.Table,
+        Syntax.TableCell
+    ];
+    return {
+        [Syntax.Paragraph](node) {
+            if (helper.isChildNode(node, ignoredParents)) {
+                return;
+            }
+            const source = sourceText(node);
+            for (const match of findSmartQuotes(source.text)) {
+                report(node, new RuleError(`Smart quotes found: "${match.matchedText}". Replace curly quotes with straight quotes.`, {
+                    padding: locator.range([
+                        source.originalStartFor(match.start),
+                        source.originalEndFor(match.end)
+                    ])
+                }));
+            }
+        }
+    };
+};
+export default rule;
+//# sourceMappingURL=smart-quotes.js.map

package/dist/families/orthography/smart-quotes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"smart-quotes.js","sourceRoot":"","sources":["../../../src/families/orthography/smart-quotes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAE3D,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;AAQvE,SAAS,eAAe,CAAC,IAAY;IACnC,MAAM,OAAO,GAAsB,EAAE,CAAC;IAEtC,KAAK,MAAM,QAAQ,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5C,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,IAAI,KAAyB,CAAC;QAC9B,IAAI,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC;QAEzB,KAAK,IAAI,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,QAAQ,CAAC,GAAG,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;YAClE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YAC9B,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC5D,SAAS;YACX,CAAC;YAED,KAAK,KAAK,KAAK,CAAC;YAChB,GAAG,GAAG,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC;YAC/B,WAAW,IAAI,SAAS,CAAC;QAC3B,CAAC;QAED,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,IAAI,GAAuB,CAAC,OAAO,EAAE,EAAE;IAC3C,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IACvD,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;IACvC,MAAM,cAAc,GAAG;QACrB,MAAM,CAAC,IAAI;QACX,MAAM,CAAC,QAAQ;QACf,MAAM,CAAC,KAAK;QACZ,MAAM,CAAC,SAAS;KACjB,CAAC;IAEF,OAAO;QACL,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAmB;YACpC,IAAI,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC;gBAC7C,OAAO;YACT,CAAC;YAED,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;YAEhC,KAAK,MAAM,KAAK,IAAI,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjD,MAAM,CACJ,IAAI,EACJ,IAAI,SAAS,CACX,wBAAwB,KAAK,CAAC,WAAW,+CAA+C,EACxF;oBACE,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC;wBACrB,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC;wBACpC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC;qBACjC,CAAC;iBACH,CACF,CACF,CAAC;YACJ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/families/phrases/cliches.js

@@ -0,0 +1,17 @@
+import cliches from "./data/cliches.json" with { type: "json" };
+import { findUnquotedPhraseMatches } from "../../shared/matchers/phrases.js";
+const rule = (context) => {
+    const { Syntax, RuleError, getSource, locator, report } = context;
+    return {
+        [Syntax.Str](node) {
+            const text = getSource(node);
+            for (const match of findUnquotedPhraseMatches(text, cliches)) {
+                report(node, new RuleError(`Cliche found: "${match.text}". Replace it with specific wording.`, {
+                    padding: locator.range([match.start, match.end])
+                }));
+            }
+        }
+    };
+};
+export default rule;
+//# sourceMappingURL=cliches.js.map

package/dist/families/phrases/cliches.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cliches.js","sourceRoot":"","sources":["../../../src/families/phrases/cliches.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,qBAAqB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAChE,OAAO,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAE7E,MAAM,IAAI,GAAuB,CAAC,OAAO,EAAE,EAAE;IAC3C,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAElE,OAAO;QACL,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI;YACf,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;YAE7B,KAAK,MAAM,KAAK,IAAI,yBAAyB,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;gBAC7D,MAAM,CACJ,IAAI,EACJ,IAAI,SAAS,CACX,kBAAkB,KAAK,CAAC,IAAI,sCAAsC,EAClE;oBACE,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;iBACjD,CACF,CACF,CAAC;YACJ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/families/phrases/corporate-speak.js

@@ -0,0 +1,23 @@
+import { RuleHelper } from "textlint-rule-helper";
+import corporateSpeak from "./data/corporate-speak.json" with { type: "json" };
+import { findUnquotedPhraseMatches } from "../../shared/matchers/phrases.js";
+const rule = (context) => {
+    const { Syntax, RuleError, getSource, locator, report } = context;
+    const helper = new RuleHelper(context);
+    const ignoredParents = [Syntax.Link, Syntax.LinkReference];
+    return {
+        [Syntax.Str](node) {
+            if (helper.isChildNode(node, ignoredParents)) {
+                return;
+            }
+            const text = getSource(node);
+            for (const match of findUnquotedPhraseMatches(text, corporateSpeak)) {
+                report(node, new RuleError(`Corporate-speak phrase found: "${match.text}". Replace it with specific wording.`, {
+                    padding: locator.range([match.start, match.end])
+                }));
+            }
+        }
+    };
+};
+export default rule;
+//# sourceMappingURL=corporate-speak.js.map

package/dist/families/phrases/corporate-speak.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"corporate-speak.js","sourceRoot":"","sources":["../../../src/families/phrases/corporate-speak.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,cAAc,MAAM,6BAA6B,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAC/E,OAAO,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAE7E,MAAM,IAAI,GAAuB,CAAC,OAAO,EAAE,EAAE;IAC3C,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAClE,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;IACvC,MAAM,cAAc,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;IAE3D,OAAO;QACL,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI;YACf,IAAI,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC;gBAC7C,OAAO;YACT,CAAC;YAED,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;YAE7B,KAAK,MAAM,KAAK,IAAI,yBAAyB,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC;gBACpE,MAAM,CACJ,IAAI,EACJ,IAAI,SAAS,CACX,kCAAkC,KAAK,CAAC,IAAI,sCAAsC,EAClF;oBACE,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;iBACjD,CACF,CACF,CAAC;YACJ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,IAAI,CAAC"}