@tsslint/config 1.5.0 → 1.5.2

package/lib/plugins/ignore.d.ts

@@ -1,2 +1,2 @@
 import type { Plugin } from '@tsslint/types';
-export declare function create(cmd: string, reportsUnusedComments: boolean, reg?: RegExp, completeReg1?: RegExp, completeReg2?: RegExp): Plugin;
+export declare function create(cmdOption: string | [string, string], reportsUnusedComments: boolean): Plugin;

package/lib/plugins/ignore.js

@@ -2,7 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.create = create;
 const ts_api_utils_1 = require("ts-api-utils");
-function create(cmd, reportsUnusedComments, reg = new RegExp(`//\\s*${cmd}\\b[ \\t]*(?<ruleId>\\S*)\\b`), completeReg1 = /^\s*\/\/(\s*)([\S]*)?$/, completeReg2 = new RegExp(`//\\s*${cmd}\\b[ \\t]*(\\S*)?$`)) {
+function create(cmdOption, reportsUnusedComments) {
+    const mode = typeof cmdOption === 'string' ? 'singleLine' : 'multiLine';
+    const [cmd, endCmd] = Array.isArray(cmdOption) ? cmdOption : [cmdOption, undefined];
+    const cmdText = cmd.replace(/\?/g, '');
+    const withRuleId = '(\\b[ \\t]*|[ \\t]+)(?<ruleId>\\S*\\b)?';
+    const reg = new RegExp(`\\s*${cmd}${withRuleId}`);
+    const endReg = endCmd ? new RegExp(`\\s*${endCmd}${withRuleId}`) : undefined;
+    const completeReg1 = /^\s*\/\/(\s*)([\S]*)?$/;
+    const completeReg2 = new RegExp(`//\\s*${cmd}(\\S*)?$`);
     return ({ typescript: ts, languageService }) => {
         const reportedRulesOfFile = new Map();
         const { getCompletionsAtPosition } = languageService;
@@ -22,8 +30,8 @@ function create(cmd, reportsUnusedComments, reg = new RegExp(`//\\s*${cmd}\\b[ \
             if (matchCmd) {
                 const nextLineRules = reportedRules?.filter(([, reportedLine]) => reportedLine === line + 1) ?? [];
                 const item = {
-                    name: cmd,
-                    insertText: matchCmd[1].length ? cmd : ` ${cmd}`,
+                    name: cmdText,
+                    insertText: matchCmd[1].length ? cmdText : ` ${cmdText}`,
                     kind: ts.ScriptElementKind.keyword,
                     sortText: 'a',
                     replacementSpan: matchCmd[2]
@@ -102,31 +110,40 @@ function create(cmd, reportsUnusedComments, reg = new RegExp(`//\\s*${cmd}\\b[ \
                     !results.some(error => error.source === 'tsslint')) {
                     return results;
                 }
-                const disabledLines = new Map();
-                const disabledLinesByRules = new Map();
+                const comments = new Map();
+                const logs = [];
                 (0, ts_api_utils_1.forEachComment)(sourceFile, (fullText, { pos, end }) => {
+                    pos += 2; // Trim the // or /* characters
                     const commentText = fullText.substring(pos, end);
-                    const comment = commentText.match(reg);
-                    if (comment?.index === undefined) {
-                        return;
-                    }
-                    const index = comment.index + pos;
-                    const line = sourceFile.getLineAndCharacterOfPosition(index).line + 1;
-                    const ruleId = comment.groups?.ruleId;
-                    if (ruleId) {
-                        if (!disabledLinesByRules.has(ruleId)) {
-                            disabledLinesByRules.set(ruleId, new Map());
+                    logs.push(commentText);
+                    const startComment = commentText.match(reg);
+                    if (startComment?.index !== undefined) {
+                        const index = startComment.index + pos;
+                        const nextLine = sourceFile.getLineAndCharacterOfPosition(index).line + 1;
+                        const ruleId = startComment.groups?.ruleId;
+                        if (!comments.has(ruleId)) {
+                            comments.set(ruleId, []);
                         }
-                        disabledLinesByRules.get(ruleId).set(line, {
-                            start: index,
-                            end: index + comment[0].length,
+                        const disabledLines = comments.get(ruleId);
+                        disabledLines.push({
+                            commentRange: [
+                                index - 2,
+                                index + startComment[0].length,
+                            ],
+                            nextLine,
                         });
                     }
-                    else {
-                        disabledLines.set(line, {
-                            start: index,
-                            end: index + comment[0].length,
-                        });
+                    else if (endReg) {
+                        const endComment = commentText.match(endReg);
+                        if (endComment?.index !== undefined) {
+                            const index = endComment.index + pos;
+                            const prevLine = sourceFile.getLineAndCharacterOfPosition(index).line - 1;
+                            const ruleId = endComment.groups?.ruleId;
+                            const disabledLines = comments.get(ruleId);
+                            if (disabledLines) {
+                                disabledLines[disabledLines.length - 1].lastLine = prevLine;
+                            }
+                        }
                     }
                 });
                 let reportedRules = reportedRulesOfFile.get(sourceFile.fileName);
@@ -141,40 +158,45 @@ function create(cmd, reportsUnusedComments, reg = new RegExp(`//\\s*${cmd}\\b[ \
                     }
                     const line = sourceFile.getLineAndCharacterOfPosition(error.start).line;
                     reportedRules.push([error.code, line]);
-                    if (disabledLines.has(line)) {
-                        disabledLines.get(line).used = true;
-                        return false;
-                    }
-                    const disabledLinesByRule = disabledLinesByRules.get(error.code);
-                    if (disabledLinesByRule?.has(line)) {
-                        disabledLinesByRule.get(line).used = true;
-                        return false;
+                    for (const code of [undefined, error.code]) {
+                        const states = comments.get(code);
+                        if (states) {
+                            if (mode === 'singleLine') {
+                                if (states.some(({ nextLine }) => nextLine === line)) {
+                                    for (const state of states) {
+                                        if (state.nextLine === line) {
+                                            state.used = true;
+                                            break;
+                                        }
+                                    }
+                                    return false;
+                                }
+                            }
+                            else {
+                                if (states.some(({ nextLine, lastLine }) => line >= nextLine && line <= (lastLine ?? Number.MAX_VALUE))) {
+                                    for (const state of states) {
+                                        if (line >= state.nextLine && line <= (state.lastLine ?? Number.MAX_VALUE)) {
+                                            state.used = true;
+                                            break;
+                                        }
+                                    }
+                                    return false;
+                                }
+                            }
+                        }
                     }
                     return true;
                 });
                 if (reportsUnusedComments) {
-                    for (const state of disabledLines.values()) {
-                        if (!state.used) {
-                            results.push({
-                                file: sourceFile,
-                                start: state.start,
-                                length: state.end - state.start,
-                                code: 'tsslint:unused-ignore-comment',
-                                messageText: `Unused ${cmd} comment.`,
-                                source: 'tsslint',
-                                category: 1,
-                            });
-                        }
-                    }
-                    for (const disabledLinesByRule of disabledLinesByRules.values()) {
-                        for (const state of disabledLinesByRule.values()) {
+                    for (const comment of comments.values()) {
+                        for (const state of comment.values()) {
                             if (!state.used) {
                                 results.push({
                                     file: sourceFile,
-                                    start: state.start,
-                                    length: state.end - state.start,
+                                    start: state.commentRange[0],
+                                    length: state.commentRange[1] - state.commentRange[0],
                                     code: 'tsslint:unused-ignore-comment',
-                                    messageText: `Unused ${cmd} comment.`,
+                                    messageText: `Unused comment.`,
                                     source: 'tsslint',
                                     category: 1,
                                 });
@@ -191,12 +213,14 @@ function create(cmd, reportsUnusedComments, reg = new RegExp(`//\\s*${cmd}\\b[ \
                 const line = sourceFile.getLineAndCharacterOfPosition(diagnostic.start).line;
                 codeFixes.push({
                     fixName: cmd,
-                    description: `Ignore with ${cmd}`,
+                    description: `Ignore with ${cmdText}`,
                     changes: [
                         {
                             fileName: sourceFile.fileName,
                             textChanges: [{
-                                    newText: `// ${cmd} ${diagnostic.code}\n`,
+                                    newText: reg.test(`${cmdText}${diagnostic.code}`)
+                                        ? `// ${cmdText}${diagnostic.code}\n`
+                                        : `// ${cmdText} ${diagnostic.code}\n`,
                                     span: {
                                         start: sourceFile.getPositionOfLineAndCharacter(line, 0),
                                         length: 0,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tsslint/config",
-	"version": "1.5.0",
+	"version": "1.5.2",
 	"license": "MIT",
 	"files": [
 		"**/*.js",
@@ -12,8 +12,8 @@
 		"directory": "packages/config"
 	},
 	"dependencies": {
-		"@tsslint/types": "1.5.0",
+		"@tsslint/types": "1.5.2",
 		"ts-api-utils": "^2.0.0"
 	},
-	"gitHead": "6585740b4ecbc8251163923b4e8c7978fe9cb12c"
+	"gitHead": "7d5ed919f5a6ac75b76319396ff2d43b5d9a8ad4"
 }