@redocly/recheck 0.15.0 → 2.58.1

package/lib/rules/scope/pattern.js

@@ -0,0 +1,58 @@
+import { overlapsAnyRange } from '../../core/inline-code.js';
+import { newLineRe, offsetToLineColumn } from '../../core/line-endings.js';
+import { formatTemplate } from '../token/messages.js';
+import { nonProseRanges } from '../utils.js';
+// On the first line, `segment.content` can start mid-line (a heading excludes
+// its '## '), so add `startColumn` to get the real column.
+function toSourceColumn(segment, lineNumber, column) {
+    return lineNumber === 1 ? segment.startColumn + (column - 1) : column;
+}
+const execute = async (rule, file, ctx) => {
+    const problems = [];
+    const options = rule.assertions['pattern'];
+    for (const segment of ctx.segments) {
+        const content = segment.content;
+        // Split on newLineRe so CRLF content does not keep a trailing '\r'.
+        const contentLines = content.split(newLineRe);
+        // Code spans and markdoc tags are not prose, so matches that overlap them are
+        // skipped (`includeCode` keeps code spans). The regex runs on the original
+        // content because a pattern like `[^\s,]+` could match through masked text.
+        const excluded = nonProseRanges(segment, options.includeCode);
+        const tokens = options.tokens || [];
+        for (const token of tokens) {
+            try {
+                const regex = new RegExp(token, options.ignoreCase ? 'gi' : 'g');
+                let match;
+                while ((match = regex.exec(content)) !== null) {
+                    // Skip empty matches (e.g. `a*`) and advance lastIndex so the loop does not hang.
+                    if (match[0].length === 0) {
+                        regex.lastIndex++;
+                        continue;
+                    }
+                    const matchEnd = match.index + match[0].length;
+                    if (overlapsAnyRange(match.index, matchEnd, excluded)) {
+                        continue;
+                    }
+                    const { line: lineNumber, column } = offsetToLineColumn(content, match.index);
+                    const matchedText = content.slice(match.index, match.index + match[0].length);
+                    problems.push({
+                        file,
+                        line: segment.startLine + lineNumber - 1,
+                        column: toSourceColumn(segment, lineNumber, column),
+                        text: contentLines[lineNumber - 1] || '',
+                        match: matchedText,
+                        ruleName: rule.name,
+                        severity: rule.severity,
+                        message: formatTemplate(rule.message ?? '', matchedText),
+                    });
+                }
+            }
+            catch {
+                // ignore invalid regex
+            }
+        }
+    }
+    return problems;
+};
+export const pattern = { id: 'pattern', fixable: false, execute };
+//# sourceMappingURL=pattern.js.map

package/lib/rules/scope/pattern.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pattern.js","sourceRoot":"","sources":["../../../src/rules/scope/pattern.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAE3E,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,8EAA8E;AAC9E,2DAA2D;AAC3D,SAAS,cAAc,CAAC,OAAgC,EAAE,UAAkB,EAAE,MAAc;IAC1F,OAAO,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AACxE,CAAC;AAED,MAAM,OAAO,GAAG,KAAK,EACnB,IAAoB,EACpB,IAAY,EACZ,GAAqB,EACD,EAAE;IACtB,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAqB,CAAC;IAE/D,KAAK,MAAM,OAAO,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAChC,oEAAoE;QACpE,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC9C,8EAA8E;QAC9E,2EAA2E;QAC3E,4EAA4E;QAC5E,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QAC9D,MAAM,MAAM,GAAa,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;QAC9C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;gBACjE,IAAI,KAA6B,CAAC;gBAClC,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;oBAC9C,kFAAkF;oBAClF,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBAC1B,KAAK,CAAC,SAAS,EAAE,CAAC;wBAClB,SAAS;oBACX,CAAC;oBACD,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;oBAC/C,IAAI,gBAAgB,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC;wBACtD,SAAS;oBACX,CAAC;oBACD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;oBAC9E,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;oBAC9E,QAAQ,CAAC,IAAI,CAAC;wBACZ,IAAI;wBACJ,IAAI,EAAE,OAAO,CAAC,SAAS,GAAG,UAAU,GAAG,CAAC;wBACxC,MAAM,EAAE,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC;wBACnD,IAAI,EAAE,YAAY,CAAC,UAAU,GAAG,CAAC,CAAC,IAAI,EAAE;wBACxC,KAAK,EAAE,WAAW;wBAClB,QAAQ,EAAE,IAAI,CAAC,IAAI;wBACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;wBACvB,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,EAAE,WAAW,CAAC;qBACzD,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,uBAAuB;YACzB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAc,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC"}

package/lib/rules/scope/repetition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"repetition.d.ts","sourceRoot":"","sources":["../../../src/rules/scope/repetition.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,SAAS,EAAoB,MAAM,aAAa,CAAC;AA4J/D,eAAO,MAAM,UAAU,EAAE,SAA6D,CAAC"}

package/lib/rules/scope/repetition.js

@@ -0,0 +1,134 @@
+import { overlapsAnyRange } from '../../core/inline-code.js';
+import { newLineRe, offsetToLineColumn } from '../../core/line-endings.js';
+import { formatTemplate } from '../token/messages.js';
+import { nonProseRanges } from '../utils.js';
+// Splits the content into tokens with `options.pattern` (default `\w+`) and
+// pairs equal neighbours separated only by whitespace, with at most one line
+// break (never across a blank line). Tokens inside code spans or markdoc tags
+// are dropped (`includeCode` keeps code spans), so `next-line line-length`
+// in a code span is not a repeat.
+function findRepeatedPairs(segment, options) {
+    let tokenRe;
+    try {
+        tokenRe = new RegExp(options.pattern ?? '\\w+', 'g');
+    }
+    catch {
+        return []; // ignore invalid regex
+    }
+    const excluded = nonProseRanges(segment, options.includeCode);
+    const tokens = [];
+    let match;
+    while ((match = tokenRe.exec(segment.content)) !== null) {
+        // Skip empty matches and advance lastIndex so the loop does not hang.
+        if (match[0].length === 0) {
+            tokenRe.lastIndex++;
+            continue;
+        }
+        if (overlapsAnyRange(match.index, match.index + match[0].length, excluded))
+            continue;
+        tokens.push({ text: match[0], index: match.index });
+    }
+    // Case is ignored by default, so 'The the' is caught.
+    const ignoreCase = options.ignoreCase !== false;
+    const pairs = [];
+    for (let i = 1; i < tokens.length; i++) {
+        const first = tokens[i - 1];
+        const second = tokens[i];
+        const gap = segment.content.slice(first.index + first.text.length, second.index);
+        if (!/^\s+$/.test(gap))
+            continue;
+        const lineBreaksInGap = gap.match(newLineRe)?.length ?? 0;
+        if (lineBreaksInGap > 1)
+            continue;
+        const same = ignoreCase
+            ? first.text.toLowerCase() === second.text.toLowerCase()
+            : first.text === second.text;
+        if (same)
+            pairs.push({ first, second });
+    }
+    return pairs;
+}
+// On the first line, `segment.content` can start mid-line (a heading excludes
+// its '## '), so add `startColumn` to get the real column.
+function toSourceColumn(segment, localLine, localColumn) {
+    return localLine === 1 ? segment.startColumn + (localColumn - 1) : localColumn;
+}
+const execute = async (rule, file, ctx) => {
+    const options = rule.assertions['repetition'];
+    const problems = [];
+    for (const segment of ctx.segments) {
+        const contentLines = segment.content.split(newLineRe);
+        for (const { second } of findRepeatedPairs(segment, options)) {
+            // Reported at the second token, which is what fix() removes.
+            const { line: localLine, column: localColumn } = offsetToLineColumn(segment.content, second.index);
+            problems.push({
+                file,
+                line: segment.startLine + localLine - 1,
+                column: toSourceColumn(segment, localLine, localColumn),
+                text: contentLines[localLine - 1] ?? '',
+                match: second.text,
+                ruleName: rule.name,
+                severity: rule.severity,
+                message: formatTemplate(rule.message ?? 'Repeated word "%s".', second.text),
+            });
+        }
+    }
+    return problems;
+};
+const fix = async (rule, file, ctx) => {
+    const options = rule.assertions['repetition'];
+    const fixes = [];
+    // Full source lines, used to check whether the token is alone on its line.
+    const fileLines = ctx.content.split(newLineRe);
+    for (const segment of ctx.segments) {
+        for (const { first, second } of findRepeatedPairs(segment, options)) {
+            const firstPos = offsetToLineColumn(segment.content, first.index);
+            const secondPos = offsetToLineColumn(segment.content, second.index);
+            if (firstPos.line === secondPos.line) {
+                // Same line: delete the gap and the second token, so 'The the' becomes 'The'.
+                const gapLength = second.index - (first.index + first.text.length);
+                fixes.push({
+                    file,
+                    ruleName: rule.name,
+                    lineNumber: segment.startLine + secondPos.line - 1,
+                    editColumn: toSourceColumn(segment, firstPos.line, firstPos.column) + first.text.length,
+                    deleteCount: gapLength + second.text.length,
+                });
+            }
+            else {
+                // Different lines: a fix can only edit one line, so delete the second
+                // token and the whitespace after it on its line.
+                const lineNumber = segment.startLine + secondPos.line - 1;
+                const editColumn = toSourceColumn(segment, secondPos.line, secondPos.column);
+                // Check the full source line; a segment can end mid-line.
+                const sourceLine = fileLines[lineNumber - 1] ?? '';
+                const beforeToken = sourceLine.slice(0, editColumn - 1);
+                const afterOnSourceLine = sourceLine.slice(editColumn - 1 + second.text.length);
+                if (/^\s*$/.test(beforeToken) && /^\s*$/.test(afterOnSourceLine)) {
+                    // The token is alone on its line, so delete the whole line (deleteCount: -1).
+                    fixes.push({
+                        file,
+                        ruleName: rule.name,
+                        lineNumber,
+                        deleteCount: -1,
+                    });
+                    continue;
+                }
+                const lines = segment.content.split(newLineRe);
+                const lineText = lines[secondPos.line - 1] ?? '';
+                const afterToken = lineText.slice(secondPos.column - 1 + second.text.length);
+                const trailingWhitespace = /^\s*/.exec(afterToken)?.[0] ?? '';
+                fixes.push({
+                    file,
+                    ruleName: rule.name,
+                    lineNumber,
+                    editColumn,
+                    deleteCount: second.text.length + trailingWhitespace.length,
+                });
+            }
+        }
+    }
+    return fixes;
+};
+export const repetition = { id: 'repetition', fixable: true, execute, fix };
+//# sourceMappingURL=repetition.js.map

package/lib/rules/scope/repetition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"repetition.js","sourceRoot":"","sources":["../../../src/rules/scope/repetition.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAG3E,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAY7C,4EAA4E;AAC5E,6EAA6E;AAC7E,8EAA8E;AAC9E,2EAA2E;AAC3E,kCAAkC;AAClC,SAAS,iBAAiB,CAAC,OAAsB,EAAE,OAA4B;IAC7E,IAAI,OAAe,CAAC;IACpB,IAAI,CAAC;QACH,OAAO,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,IAAI,MAAM,EAAE,GAAG,CAAC,CAAC;IACvD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC,CAAC,uBAAuB;IACpC,CAAC;IAED,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC9D,MAAM,MAAM,GAAY,EAAE,CAAC;IAC3B,IAAI,KAA6B,CAAC;IAClC,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QACxD,sEAAsE;QACtE,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,CAAC,SAAS,EAAE,CAAC;YACpB,SAAS;QACX,CAAC;QACD,IAAI,gBAAgB,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC;YAAE,SAAS;QACrF,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,sDAAsD;IACtD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,KAAK,KAAK,CAAC;IAEhD,MAAM,KAAK,GAAmB,EAAE,CAAC;IACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5B,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACzB,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QACjF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;YAAE,SAAS;QACjC,MAAM,eAAe,GAAG,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC;QAC1D,IAAI,eAAe,GAAG,CAAC;YAAE,SAAS;QAClC,MAAM,IAAI,GAAG,UAAU;YACrB,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE;YACxD,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC;QAC/B,IAAI,IAAI;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,8EAA8E;AAC9E,2DAA2D;AAC3D,SAAS,cAAc,CAAC,OAAgC,EAAE,SAAiB,EAAE,WAAmB;IAC9F,OAAO,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,GAAG,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;AACjF,CAAC;AAED,MAAM,OAAO,GAAG,KAAK,EACnB,IAAoB,EACpB,IAAY,EACZ,GAAqB,EACD,EAAE;IACtB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAwB,CAAC;IACrE,MAAM,QAAQ,GAAc,EAAE,CAAC;IAE/B,KAAK,MAAM,OAAO,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QACnC,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACtD,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;YAC7D,6DAA6D;YAC7D,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,kBAAkB,CACjE,OAAO,CAAC,OAAO,EACf,MAAM,CAAC,KAAK,CACb,CAAC;YACF,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI;gBACJ,IAAI,EAAE,OAAO,CAAC,SAAS,GAAG,SAAS,GAAG,CAAC;gBACvC,MAAM,EAAE,cAAc,CAAC,OAAO,EAAE,SAAS,EAAE,WAAW,CAAC;gBACvD,IAAI,EAAE,YAAY,CAAC,SAAS,GAAG,CAAC,CAAC,IAAI,EAAE;gBACvC,KAAK,EAAE,MAAM,CAAC,IAAI;gBAClB,QAAQ,EAAE,IAAI,CAAC,IAAI;gBACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC,OAAO,IAAI,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC;aAC5E,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,KAAK,EAAE,IAAoB,EAAE,IAAY,EAAE,GAAqB,EAAkB,EAAE;IAC9F,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAwB,CAAC;IACrE,MAAM,KAAK,GAAU,EAAE,CAAC;IACxB,2EAA2E;IAC3E,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAE/C,KAAK,MAAM,OAAO,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QACnC,KAAK,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;YACpE,MAAM,QAAQ,GAAG,kBAAkB,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;YAClE,MAAM,SAAS,GAAG,kBAAkB,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;YAEpE,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;gBACrC,8EAA8E;gBAC9E,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACnE,KAAK,CAAC,IAAI,CAAC;oBACT,IAAI;oBACJ,QAAQ,EAAE,IAAI,CAAC,IAAI;oBACnB,UAAU,EAAE,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,IAAI,GAAG,CAAC;oBAClD,UAAU,EAAE,cAAc,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM;oBACvF,WAAW,EAAE,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM;iBAC5C,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,sEAAsE;gBACtE,iDAAiD;gBACjD,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,IAAI,GAAG,CAAC,CAAC;gBAC1D,MAAM,UAAU,GAAG,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;gBAE7E,0DAA0D;gBAC1D,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;gBACnD,MAAM,WAAW,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,GAAG,CAAC,CAAC,CAAC;gBACxD,MAAM,iBAAiB,GAAG,UAAU,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAChF,IAAI,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;oBACjE,8EAA8E;oBAC9E,KAAK,CAAC,IAAI,CAAC;wBACT,IAAI;wBACJ,QAAQ,EAAE,IAAI,CAAC,IAAI;wBACnB,UAAU;wBACV,WAAW,EAAE,CAAC,CAAC;qBAChB,CAAC,CAAC;oBACH,SAAS;gBACX,CAAC;gBAED,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBAC/C,MAAM,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;gBACjD,MAAM,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC7E,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBAC9D,KAAK,CAAC,IAAI,CAAC;oBACT,IAAI;oBACJ,QAAQ,EAAE,IAAI,CAAC,IAAI;oBACnB,UAAU;oBACV,UAAU;oBACV,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,kBAAkB,CAAC,MAAM;iBAC5D,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAc,EAAE,EAAE,EAAE,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC"}

package/lib/rules/scope/semantic-line-breaks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"semantic-line-breaks.d.ts","sourceRoot":"","sources":["../../../src/rules/scope/semantic-line-breaks.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,SAAS,EAAoB,MAAM,aAAa,CAAC;AA2M/D,eAAO,MAAM,kBAAkB,EAAE,SAKhC,CAAC"}

package/lib/rules/scope/semantic-line-breaks.js

@@ -0,0 +1,180 @@
+import { newLineRe } from '../../core/line-endings.js';
+import { filterByTypes } from '../../parser/index.js';
+import { splitSentences } from '../../scopes/sentences.js';
+import { addRangeToSet } from '../token/helpers.js';
+// One CommonMark list marker plus the space after it. The space keeps `*text*`,
+// `-3 degrees` and `1.5 million` from matching. Lettered markers (`a.`) are not
+// list markers in CommonMark.
+const SINGLE_MARKER_RE = /^(?:[-*+]|\d+\.)[ \t]+/;
+// Lettered markers (`- a. Text`): splitSentences treats `a.` as a sentence end,
+// so --fix would split it from its text. These lines are skipped.
+const PSEUDO_MARKER_RE = /^[a-zA-Z]\.[ \t]/;
+// Length of the prefix before the text: blockquote markers, indent and every
+// nested list marker (`- 1. text` gives the length of `- 1. `).
+function listMarkerLength(lineText) {
+    const prefix = lineText.match(/^\s*(?:>\s*)*/)?.[0].length ?? 0;
+    let length = prefix;
+    let marker = lineText.slice(length).match(SINGLE_MARKER_RE);
+    if (!marker)
+        return 0;
+    while (marker) {
+        length += marker[0].length;
+        marker = lineText.slice(length).match(SINGLE_MARKER_RE);
+    }
+    return length;
+}
+function isSkippableLine(lineText) {
+    if (lineText.trim() === '' || lineText.startsWith('#'))
+        return true;
+    const markerLength = listMarkerLength(lineText);
+    if (markerLength > 0)
+        return PSEUDO_MARKER_RE.test(lineText.slice(markerLength));
+    return /^\s*[a-zA-Z]\.\s/.test(lineText);
+}
+function calculateContinuationIndent(line) {
+    // Keep the blockquote prefix as it is on continuation lines. Replacing '>'
+    // with spaces would turn them into lazy continuation lines, which no longer
+    // look like part of the quote in the source.
+    const blockquotePrefix = line.match(/^(\s*(?:>\s*)+)/)?.[1] ?? '';
+    const remainder = line.slice(blockquotePrefix.length);
+    const leadingWhitespace = remainder.match(/^(\s*)/)?.[1] || '';
+    // A marker must not repeat on continuation lines (that would start a new list
+    // item), so replace each one with spaces of the same width.
+    const listMarkers = [
+        /^(\s*[-*+]\s)/, // Bullet points
+        /^(\s*\d+\.\s)/, // Numbered lists
+        /^(\s*[a-zA-Z]\.\s)/, // Letter lists
+    ];
+    let markerRegionWidth = 0;
+    let consumed = true;
+    while (consumed) {
+        consumed = false;
+        for (const pattern of listMarkers) {
+            const match = remainder.slice(markerRegionWidth).match(pattern);
+            if (match) {
+                markerRegionWidth += match[1].length;
+                consumed = true;
+                break;
+            }
+        }
+    }
+    if (markerRegionWidth > 0) {
+        return blockquotePrefix + ' '.repeat(markerRegionWidth);
+    }
+    return blockquotePrefix + leadingWhitespace;
+}
+// Only 'sentence' mode reports problems, so fix() must only run in that mode too.
+function isSentenceMode(options) {
+    return options.mode === 'sentence';
+}
+function formatMessage(template, ...args) {
+    let result = template;
+    for (let i = 0; i < args.length; i++) {
+        result = result.replace('%s', args[i]);
+    }
+    return result;
+}
+/** Finds the 1-based line numbers inside code blocks and tables, using the whole file's tree. */
+function deriveIgnoredLineNumbers(ctx) {
+    const codeBlockLines = new Set();
+    for (const codeBlock of filterByTypes(ctx.tree, ['codeFenced', 'codeIndented'])) {
+        addRangeToSet(codeBlockLines, codeBlock.startLine, codeBlock.endLine);
+    }
+    const tableLines = new Set();
+    for (const table of filterByTypes(ctx.tree, ['table'])) {
+        addRangeToSet(tableLines, table.startLine, table.endLine);
+    }
+    return { codeBlockLines, tableLines };
+}
+/** Shared by `execute` and `fix` so --fix never changes a line that lint skips. */
+function isIgnoredLine(lineText, lineNumber, options, ignoredLines) {
+    if (options.ignoreCodeBlocks && ignoredLines.codeBlockLines.has(lineNumber))
+        return true;
+    if (options.ignoreTables && ignoredLines.tableLines.has(lineNumber))
+        return true;
+    return isSkippableLine(lineText);
+}
+const execute = async (rule, file, ctx) => {
+    const problems = [];
+    const options = rule.assertions['semantic-line-breaks'];
+    const ignoredLines = deriveIgnoredLineNumbers(ctx);
+    for (const segment of ctx.segments) {
+        const lines = segment.content.split(newLineRe);
+        for (let lineIndex = 0; lineIndex < lines.length; lineIndex++) {
+            const lineText = lines[lineIndex];
+            const lineNumber = segment.startLine + lineIndex;
+            if (isIgnoredLine(lineText, lineNumber, options, ignoredLines))
+                continue;
+            if (isSentenceMode(options)) {
+                // Count sentences after the marker; `1.` would look like a sentence end.
+                const sentenceCount = splitSentences(lineText.slice(listMarkerLength(lineText))).length;
+                if (sentenceCount > 1) {
+                    problems.push({
+                        file,
+                        line: lineNumber,
+                        column: 1,
+                        text: lineText,
+                        match: lineText,
+                        ruleName: rule.name,
+                        severity: rule.severity,
+                        message: formatMessage(rule.message ?? '', options.mode),
+                    });
+                }
+            }
+        }
+    }
+    return problems;
+};
+const fix = async (rule, file, ctx) => {
+    const fixes = [];
+    const options = rule.assertions['semantic-line-breaks'];
+    if (!isSentenceMode(options))
+        return fixes;
+    const ignoredLines = deriveIgnoredLineNumbers(ctx);
+    const rawLines = ctx.content.split(newLineRe);
+    for (const segment of ctx.segments) {
+        const lines = segment.content.split(newLineRe);
+        for (let lineIndex = 0; lineIndex < lines.length; lineIndex++) {
+            const lineText = lines[lineIndex];
+            const lineNumber = segment.startLine + lineIndex;
+            if (isIgnoredLine(lineText, lineNumber, options, ignoredLines))
+                continue;
+            // markerLength shifts the sentence positions back to positions in the line.
+            const markerLength = listMarkerLength(lineText);
+            const sentences = splitSentences(lineText.slice(markerLength));
+            if (sentences.length <= 1)
+                continue;
+            // The whole line is replaced, so build the new text from the raw source
+            // line. A scoped segment may not include the list marker, and `- First. Second.`
+            // would lose its `- `. On the first line, startColumn tells where the segment starts.
+            const rawLine = rawLines[lineNumber - 1] ?? lineText;
+            const prefixOffset = lineIndex === 0 ? segment.startColumn - 1 : 0;
+            const indentation = calculateContinuationIndent(rawLine);
+            const [firstSentence, ...continuationSentences] = sentences;
+            // Keep the original prefix (indentation, '>' and list marker) on the first line,
+            // because splitSentences trims leading whitespace from each sentence.
+            const firstLinePrefix = rawLine.slice(0, prefixOffset + markerLength + firstSentence.start);
+            const newLinesForThisLine = [
+                firstLinePrefix + firstSentence.text,
+                ...continuationSentences.map((sentence) => indentation + sentence.text),
+            ];
+            const newText = newLinesForThisLine.join('\n');
+            fixes.push({
+                file,
+                ruleName: rule.name,
+                lineNumber,
+                editColumn: 1,
+                deleteCount: -1,
+                insertText: newText,
+            });
+        }
+    }
+    return fixes;
+};
+export const semanticLineBreaks = {
+    id: 'semantic-line-breaks',
+    fixable: true,
+    execute,
+    fix,
+};
+//# sourceMappingURL=semantic-line-breaks.js.map

package/lib/rules/scope/semantic-line-breaks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"semantic-line-breaks.js","sourceRoot":"","sources":["../../../src/rules/scope/semantic-line-breaks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAO3D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGpD,gFAAgF;AAChF,gFAAgF;AAChF,8BAA8B;AAC9B,MAAM,gBAAgB,GAAG,wBAAwB,CAAC;AAElD,gFAAgF;AAChF,kEAAkE;AAClE,MAAM,gBAAgB,GAAG,kBAAkB,CAAC;AAE5C,6EAA6E;AAC7E,gEAAgE;AAChE,SAAS,gBAAgB,CAAC,QAAgB;IACxC,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC;IAChE,IAAI,MAAM,GAAG,MAAM,CAAC;IACpB,IAAI,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAC5D,IAAI,CAAC,MAAM;QAAE,OAAO,CAAC,CAAC;IACtB,OAAO,MAAM,EAAE,CAAC;QACd,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAC3B,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,eAAe,CAAC,QAAgB;IACvC,IAAI,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACpE,MAAM,YAAY,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAChD,IAAI,YAAY,GAAG,CAAC;QAAE,OAAO,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IACjF,OAAO,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC3C,CAAC;AAED,SAAS,2BAA2B,CAAC,IAAY;IAC/C,2EAA2E;IAC3E,4EAA4E;IAC5E,6CAA6C;IAC7C,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAClE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAEtD,MAAM,iBAAiB,GAAG,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAE/D,8EAA8E;IAC9E,4DAA4D;IAC5D,MAAM,WAAW,GAAG;QAClB,eAAe,EAAE,gBAAgB;QACjC,eAAe,EAAE,iBAAiB;QAClC,oBAAoB,EAAE,eAAe;KACtC,CAAC;IAEF,IAAI,iBAAiB,GAAG,CAAC,CAAC;IAC1B,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,OAAO,QAAQ,EAAE,CAAC;QAChB,QAAQ,GAAG,KAAK,CAAC;QACjB,KAAK,MAAM,OAAO,IAAI,WAAW,EAAE,CAAC;YAClC,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAChE,IAAI,KAAK,EAAE,CAAC;gBACV,iBAAiB,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;gBACrC,QAAQ,GAAG,IAAI,CAAC;gBAChB,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,iBAAiB,GAAG,CAAC,EAAE,CAAC;QAC1B,OAAO,gBAAgB,GAAG,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO,gBAAgB,GAAG,iBAAiB,CAAC;AAC9C,CAAC;AAED,kFAAkF;AAClF,SAAS,cAAc,CAAC,OAAoC;IAC1D,OAAO,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC;AACrC,CAAC;AAED,SAAS,aAAa,CAAC,QAAgB,EAAE,GAAG,IAAc;IACxD,IAAI,MAAM,GAAG,QAAQ,CAAC;IACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,iGAAiG;AACjG,SAAS,wBAAwB,CAAC,GAAqB;IAIrD,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;IACzC,KAAK,MAAM,SAAS,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC;QAChF,aAAa,CAAC,cAAc,EAAE,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IACxE,CAAC;IACD,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;IACrC,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QACvD,aAAa,CAAC,UAAU,EAAE,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC;AACxC,CAAC;AAED,mFAAmF;AACnF,SAAS,aAAa,CACpB,QAAgB,EAChB,UAAkB,EAClB,OAAoC,EACpC,YAAsE;IAEtE,IAAI,OAAO,CAAC,gBAAgB,IAAI,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC;QAAE,OAAO,IAAI,CAAC;IACzF,IAAI,OAAO,CAAC,YAAY,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC;QAAE,OAAO,IAAI,CAAC;IACjF,OAAO,eAAe,CAAC,QAAQ,CAAC,CAAC;AACnC,CAAC;AAED,MAAM,OAAO,GAAG,KAAK,EACnB,IAAoB,EACpB,IAAY,EACZ,GAAqB,EACD,EAAE;IACtB,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAgC,CAAC;IACvF,MAAM,YAAY,GAAG,wBAAwB,CAAC,GAAG,CAAC,CAAC;IAEnD,KAAK,MAAM,OAAO,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QACnC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAE/C,KAAK,IAAI,SAAS,GAAG,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC;YAC9D,MAAM,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;YAClC,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;YAEjD,IAAI,aAAa,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,YAAY,CAAC;gBAAE,SAAS;YAEzE,IAAI,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC5B,yEAAyE;gBACzE,MAAM,aAAa,GAAG,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;gBACxF,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;oBACtB,QAAQ,CAAC,IAAI,CAAC;wBACZ,IAAI;wBACJ,IAAI,EAAE,UAAU;wBAChB,MAAM,EAAE,CAAC;wBACT,IAAI,EAAE,QAAQ;wBACd,KAAK,EAAE,QAAQ;wBACf,QAAQ,EAAE,IAAI,CAAC,IAAI;wBACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;wBACvB,OAAO,EAAE,aAAa,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC;qBACzD,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,KAAK,EAAE,IAAoB,EAAE,IAAY,EAAE,GAAqB,EAAkB,EAAE;IAC9F,MAAM,KAAK,GAAU,EAAE,CAAC;IACxB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAgC,CAAC;IACvF,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;QAAE,OAAO,KAAK,CAAC;IAC3C,MAAM,YAAY,GAAG,wBAAwB,CAAC,GAAG,CAAC,CAAC;IACnD,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAE9C,KAAK,MAAM,OAAO,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QACnC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAE/C,KAAK,IAAI,SAAS,GAAG,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC;YAC9D,MAAM,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;YAClC,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;YAEjD,IAAI,aAAa,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,YAAY,CAAC;gBAAE,SAAS;YAEzE,4EAA4E;YAC5E,MAAM,YAAY,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YAChD,MAAM,SAAS,GAAG,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;YAC/D,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC;gBAAE,SAAS;YAEpC,wEAAwE;YACxE,iFAAiF;YACjF,sFAAsF;YACtF,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,GAAG,CAAC,CAAC,IAAI,QAAQ,CAAC;YACrD,MAAM,YAAY,GAAG,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACnE,MAAM,WAAW,GAAG,2BAA2B,CAAC,OAAO,CAAC,CAAC;YAEzD,MAAM,CAAC,aAAa,EAAE,GAAG,qBAAqB,CAAC,GAAG,SAAS,CAAC;YAC5D,iFAAiF;YACjF,sEAAsE;YACtE,MAAM,eAAe,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,GAAG,YAAY,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;YAC5F,MAAM,mBAAmB,GAAG;gBAC1B,eAAe,GAAG,aAAa,CAAC,IAAI;gBACpC,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC;aACxE,CAAC;YAEF,MAAM,OAAO,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAE/C,KAAK,CAAC,IAAI,CAAC;gBACT,IAAI;gBACJ,QAAQ,EAAE,IAAI,CAAC,IAAI;gBACnB,UAAU;gBACV,UAAU,EAAE,CAAC;gBACb,WAAW,EAAE,CAAC,CAAC;gBACf,UAAU,EAAE,OAAO;aACpB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAc;IAC3C,EAAE,EAAE,sBAAsB;IAC1B,OAAO,EAAE,IAAI;IACb,OAAO;IACP,GAAG;CACJ,CAAC"}

package/lib/rules/scope/spelling.d.ts

@@ -0,0 +1,11 @@
+import type { ScopeRule } from '../types.js';
+/**
+ * Turns a `dictionary` path (without the `.aff`/`.dic` extension) into the two file paths.
+ * Relative paths are resolved from `process.cwd()`.
+ */
+export declare function resolveDictionaryPaths(dictionaryPath: string): {
+    aff: string;
+    dic: string;
+};
+export declare const spelling: ScopeRule;
+//# sourceMappingURL=spelling.d.ts.map

package/lib/rules/scope/spelling.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spelling.d.ts","sourceRoot":"","sources":["../../../src/rules/scope/spelling.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,SAAS,EAAoB,MAAM,aAAa,CAAC;AAqB/D;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,cAAc,EAAE,MAAM,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAK3F;AAiJD,eAAO,MAAM,QAAQ,EAAE,SAAuD,CAAC"}

package/lib/rules/scope/spelling.js

@@ -0,0 +1,146 @@
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+import { maskInlineCode } from '../../core/inline-code.js';
+import { newLineRe, offsetToLineColumn } from '../../core/line-endings.js';
+import { TECHNICAL_PROPER_NOUNS } from '../../data/proper-nouns.js';
+import { formatTemplate } from '../token/messages.js';
+import { isAllCapsWord } from './title-case.js';
+// Spellers are cached by dictionary because parsing a dictionary is slow.
+// The cache holds promises, so concurrent callers share one load.
+const DEFAULT_DICTIONARY_KEY = '\0default';
+const spellerCache = new Map();
+/**
+ * Turns a `dictionary` path (without the `.aff`/`.dic` extension) into the two file paths.
+ * Relative paths are resolved from `process.cwd()`.
+ */
+export function resolveDictionaryPaths(dictionaryPath) {
+    const resolved = path.isAbsolute(dictionaryPath)
+        ? dictionaryPath
+        : path.join(process.cwd(), dictionaryPath);
+    return { aff: `${resolved}.aff`, dic: `${resolved}.dic` };
+}
+/** Reads a custom Hunspell `.aff`/`.dic` pair from disk. */
+async function readCustomDictionary(dictionaryPath) {
+    const { aff: affPath, dic: dicPath } = resolveDictionaryPaths(dictionaryPath);
+    const [aff, dic] = await Promise.all([fs.readFile(affPath), fs.readFile(dicPath)]);
+    return { aff, dic };
+}
+/** Loads the custom dictionary if `options.dictionary` is set, else the default English one. */
+async function loadDictionary(options) {
+    if (options.dictionary)
+        return readCustomDictionary(options.dictionary);
+    const mod = (await import('dictionary-en'));
+    return mod.default;
+}
+function loadSpeller(options) {
+    const cacheKey = options.dictionary && options.dictionary.length > 0
+        ? options.dictionary
+        : DEFAULT_DICTIONARY_KEY;
+    const cached = spellerCache.get(cacheKey);
+    if (cached)
+        return cached;
+    const loading = (async () => {
+        const [{ default: nspell }, dictionary] = await Promise.all([
+            import('nspell'),
+            loadDictionary(options),
+        ]);
+        return nspell(dictionary);
+    })();
+    spellerCache.set(cacheKey, loading);
+    // Remove a failed load from the cache so a later call can retry. Callers still
+    // see the original error because they await the same promise.
+    loading.catch(() => {
+        // Only remove it if it is still this promise; another call may have replaced it.
+        if (spellerCache.get(cacheKey) === loading) {
+            spellerCache.delete(cacheKey);
+        }
+    });
+    return loading;
+}
+// Letter runs, with an optional apostrophe suffix so "don't" is one word.
+const WORD_RE = /\p{L}+(?:['’]\p{L}+)?/gu;
+// True when a digit touches the word, as in 'sha256' or 'log4j'. Those letters
+// are part of an identifier, not a word to spell-check.
+function isDigitAdjacent(text, start, end) {
+    const before = text[start - 1];
+    const after = text[end];
+    return /\d/.test(before ?? '') || /\d/.test(after ?? '');
+}
+// On the first line, `segment.content` can start mid-line (a heading excludes
+// its '## '), so add `startColumn` to get the real column.
+function toSourceColumn(segment, lineNumber, column) {
+    return lineNumber === 1 ? segment.startColumn + (column - 1) : column;
+}
+/** Returns `''` for no suggestions, or `' — did you mean: a, b, c?'`. */
+function formatSuggestionSuffix(suggestions) {
+    if (suggestions.length === 0)
+        return '';
+    return ` — did you mean: ${suggestions.join(', ')}?`;
+}
+// Used when the rule has no `message`. The slots are the word and the suggestion suffix.
+const FALLBACK_MESSAGE = 'Unknown word "%s"%s';
+// Names like 'Node.js' and 'VS Code' are split into words, since spelling checks single words.
+const BUILTIN_VOCAB_WORDS = TECHNICAL_PROPER_NOUNS.flatMap((entry) => entry.split(/[\s.]+/).filter((part) => part.length > 0)).map((word) => word.toLowerCase());
+const execute = async (rule, file, ctx) => {
+    const options = (rule.assertions['spelling'] ?? {});
+    let speller;
+    try {
+        speller = await loadSpeller(options);
+    }
+    catch (error) {
+        // Config validation usually catches a missing peer or dictionary first. If it did
+        // not, throw so the runner reports an error instead of silently finding nothing.
+        const detail = error instanceof Error ? error.message : String(error);
+        throw new Error(`spelling: failed to load dictionary — ${detail}`);
+    }
+    const vocab = new Set((options.vocab ?? []).map((word) => word.toLowerCase()));
+    // Add the built-in words to the config's own `vocab` unless `builtinVocabulary` is false.
+    if (options.builtinVocabulary !== false) {
+        for (const word of BUILTIN_VOCAB_WORDS)
+            vocab.add(word);
+    }
+    const ignorePatterns = [];
+    for (const pattern of options.ignore ?? []) {
+        try {
+            ignorePatterns.push(new RegExp(pattern));
+        }
+        catch {
+            // ignore invalid regex
+        }
+    }
+    const problems = [];
+    for (const segment of ctx.segments) {
+        const masked = maskInlineCode(segment.content);
+        // Split on newLineRe so CRLF content does not keep a trailing '\r'.
+        const contentLines = segment.content.split(newLineRe);
+        for (const match of masked.matchAll(WORD_RE)) {
+            const word = match[0];
+            const offset = match.index ?? 0;
+            if (vocab.has(word.toLowerCase()))
+                continue;
+            if (ignorePatterns.some((re) => re.test(word)))
+                continue;
+            if (isAllCapsWord(word))
+                continue;
+            if (isDigitAdjacent(masked, offset, offset + word.length))
+                continue;
+            if (speller.correct(word))
+                continue;
+            const { line: lineNumber, column } = offsetToLineColumn(segment.content, offset);
+            const suggestions = speller.suggest(word).slice(0, 3);
+            problems.push({
+                file,
+                line: segment.startLine + lineNumber - 1,
+                column: toSourceColumn(segment, lineNumber, column),
+                text: contentLines[lineNumber - 1] ?? '',
+                match: word,
+                ruleName: rule.name,
+                severity: rule.severity,
+                message: formatTemplate(rule.message ?? FALLBACK_MESSAGE, word, formatSuggestionSuffix(suggestions)),
+            });
+        }
+    }
+    return problems;
+};
+export const spelling = { id: 'spelling', fixable: false, execute };
+//# sourceMappingURL=spelling.js.map

package/lib/rules/scope/spelling.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spelling.js","sourceRoot":"","sources":["../../../src/rules/scope/spelling.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAGpE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAehD,0EAA0E;AAC1E,kEAAkE;AAClE,MAAM,sBAAsB,GAAG,WAAW,CAAC;AAC3C,MAAM,YAAY,GAAG,IAAI,GAAG,EAA4B,CAAC;AAEzD;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,cAAsB;IAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;QAC9C,CAAC,CAAC,cAAc;QAChB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC;IAC7C,OAAO,EAAE,GAAG,EAAE,GAAG,QAAQ,MAAM,EAAE,GAAG,EAAE,GAAG,QAAQ,MAAM,EAAE,CAAC;AAC5D,CAAC;AAED,4DAA4D;AAC5D,KAAK,UAAU,oBAAoB,CAAC,cAAsB;IACxD,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,sBAAsB,CAAC,cAAc,CAAC,CAAC;IAC9E,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACnF,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AACtB,CAAC;AAED,gGAAgG;AAChG,KAAK,UAAU,cAAc,CAAC,OAA0B;IACtD,IAAI,OAAO,CAAC,UAAU;QAAE,OAAO,oBAAoB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACxE,MAAM,GAAG,GAAG,CAAC,MAAM,MAAM,CAAC,eAAe,CAAC,CAAgC,CAAC;IAC3E,OAAO,GAAG,CAAC,OAAO,CAAC;AACrB,CAAC;AAED,SAAS,WAAW,CAAC,OAA0B;IAC7C,MAAM,QAAQ,GACZ,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;QACjD,CAAC,CAAC,OAAO,CAAC,UAAU;QACpB,CAAC,CAAC,sBAAsB,CAAC;IAC7B,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC1C,IAAI,MAAM;QAAE,OAAO,MAAM,CAAC;IAE1B,MAAM,OAAO,GAAG,CAAC,KAAK,IAAI,EAAE;QAC1B,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,UAAU,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC1D,MAAM,CAAC,QAAQ,CAA4D;YAC3E,cAAc,CAAC,OAAO,CAAC;SACxB,CAAC,CAAC;QACH,OAAO,MAAM,CAAC,UAAU,CAAC,CAAC;IAC5B,CAAC,CAAC,EAAE,CAAC;IACL,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACpC,+EAA+E;IAC/E,8DAA8D;IAC9D,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE;QACjB,iFAAiF;QACjF,IAAI,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,OAAO,EAAE,CAAC;YAC3C,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChC,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,0EAA0E;AAC1E,MAAM,OAAO,GAAG,yBAAyB,CAAC;AAE1C,+EAA+E;AAC/E,wDAAwD;AACxD,SAAS,eAAe,CAAC,IAAY,EAAE,KAAa,EAAE,GAAW;IAC/D,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IACxB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;AAC3D,CAAC;AAED,8EAA8E;AAC9E,2DAA2D;AAC3D,SAAS,cAAc,CAAC,OAAsB,EAAE,UAAkB,EAAE,MAAc;IAChF,OAAO,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AACxE,CAAC;AAED,yEAAyE;AACzE,SAAS,sBAAsB,CAAC,WAAqB;IACnD,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACxC,OAAO,oBAAoB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;AACvD,CAAC;AAED,yFAAyF;AACzF,MAAM,gBAAgB,GAAG,qBAAqB,CAAC;AAE/C,+FAA+F;AAC/F,MAAM,mBAAmB,GAAsB,sBAAsB,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CACtF,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CACxD,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;AAEpC,MAAM,OAAO,GAAG,KAAK,EACnB,IAAoB,EACpB,IAAY,EACZ,GAAqB,EACD,EAAE;IACtB,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,CAAsB,CAAC;IAEzE,IAAI,OAAgB,CAAC;IACrB,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,kFAAkF;QAClF,iFAAiF;QACjF,MAAM,MAAM,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACtE,MAAM,IAAI,KAAK,CAAC,yCAAyC,MAAM,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAC/E,0FAA0F;IAC1F,IAAI,OAAO,CAAC,iBAAiB,KAAK,KAAK,EAAE,CAAC;QACxC,KAAK,MAAM,IAAI,IAAI,mBAAmB;YAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC;IACD,MAAM,cAAc,GAAa,EAAE,CAAC;IACpC,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;QAC3C,IAAI,CAAC;YACH,cAAc,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QAC3C,CAAC;QAAC,MAAM,CAAC;YACP,uBAAuB;QACzB,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAAc,EAAE,CAAC;IAE/B,KAAK,MAAM,OAAO,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QACnC,MAAM,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC/C,oEAAoE;QACpE,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAEtD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;YAEhC,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;gBAAE,SAAS;YAC5C,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAAE,SAAS;YACzD,IAAI,aAAa,CAAC,IAAI,CAAC;gBAAE,SAAS;YAClC,IAAI,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;gBAAE,SAAS;YACpE,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;gBAAE,SAAS;YAEpC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,kBAAkB,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YACjF,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAEtD,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI;gBACJ,IAAI,EAAE,OAAO,CAAC,SAAS,GAAG,UAAU,GAAG,CAAC;gBACxC,MAAM,EAAE,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC;gBACnD,IAAI,EAAE,YAAY,CAAC,UAAU,GAAG,CAAC,CAAC,IAAI,EAAE;gBACxC,KAAK,EAAE,IAAI;gBACX,QAAQ,EAAE,IAAI,CAAC,IAAI;gBACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,OAAO,EAAE,cAAc,CACrB,IAAI,CAAC,OAAO,IAAI,gBAAgB,EAChC,IAAI,EACJ,sBAAsB,CAAC,WAAW,CAAC,CACpC;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAc,EAAE,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC"}

package/lib/rules/scope/swap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"swap.d.ts","sourceRoot":"","sources":["../../../src/rules/scope/swap.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAoB,MAAM,aAAa,CAAC;AAuI/D,eAAO,MAAM,IAAI,EAAE,SAAuD,CAAC"}