ignore-lint-errors 0.4.2 → 0.6.0

package/README.md

@@ -15,14 +15,29 @@ In large production projects, ignoring lint errors for existing code is the most
 
 For the sake of reducing noise, some prefer disabling linting for the entire file. They do so by adding a global directive (e.g. `eslint-disable`) or creating a special file to "suppress" files with many errors.
 
-Instead, `ignore-lint-errors` takes the honest approach: It adds a local directive (e.g. `eslint-disable-next-line`) for every line that has an error. This way, we can easily see and show others (including non-engineers),
+Instead, `ignore-lint-errors` takes the honest approach: It adds a local directive (e.g. `eslint-disable-next-line`) for every line that has an error. This way, we can easily see and show others (including non-engineers and AIs),
 
-- How bad our code is in order to create the urgency to fix issues. The number of local ignores (1 per line) always estimates the actual number of errors better than the number of global ignores (1 per file).
-- Which parts of our code are good and should be replicated, and which parts are bad and to be avoided. When there is a global ignore, a linter doesn't check the file for the given rule(s).
+- How bad our code is to increase the urgency to fix issues. The number of local ignores (1 per line) will always estimate the actual number of errors better than the number of global ignores (1 per file).
+- Which parts of our code are good and should be replicated, and which parts are bad and to be avoided. When there is a global ignore, a linter won't check the file for the given rule(s).
 
 
 ## Usage
 
+Step 1. Run codemod.
+
+```sh
+cd <path/to/your/project>
+pnpx ignore-lint-errors <arguments>
+```
+
+Step 2. Fix formatting.
+
+```sh
+# Run prettier
+pnpm prettier . --write
+```
+
+
 ### Arguments
 
 You must pass `--linter` to indicate which linter to run.

package/dist/src/utils/ignore-errors/eslint.js

@@ -1,9 +1,45 @@
 import { EOL } from 'node:os';
+import { AST } from '@codemod-utils/ast-javascript';
+function getIgnoredRules(lineOfCode) {
+    const traverse = AST.traverse(true);
+    let ignoredRules = [];
+    try {
+        traverse(lineOfCode, {
+            visitComment(node) {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+                const comment = node.value.value.trim();
+                if (comment.startsWith('eslint-disable-next-line')) {
+                    ignoredRules = comment
+                        .replace(/^eslint-disable-next-line\s+/, '')
+                        .split(',')
+                        .map((token) => token.trim());
+                }
+                return false;
+            },
+        });
+    }
+    catch {
+        // Do nothing
+    }
+    return ignoredRules;
+}
 export function ignoreErrors(file, lintErrors) {
     const lines = file.split(EOL);
     lintErrors.forEach(({ line, message }) => {
-        const ignoreDirective = `// eslint-disable-next-line ${message}`;
-        lines.splice(line - 1, 0, ignoreDirective);
+        const currentIndex = line - 1;
+        const previousIndex = Math.max(currentIndex - 1, 0);
+        const ignoredRules = getIgnoredRules(lines[previousIndex]);
+        if (ignoredRules.length === 0) {
+            const ignoreDirective = `// eslint-disable-next-line ${message}`;
+            lines.splice(currentIndex, 0, ignoreDirective);
+        }
+        else {
+            const newMessage = [...ignoredRules, ...message.split(', ')]
+                .sort()
+                .join(', ');
+            const ignoreDirective = `// eslint-disable-next-line ${newMessage}`;
+            lines.splice(previousIndex, 1, ignoreDirective);
+        }
     });
     return lines.join(EOL);
 }

package/dist/src/utils/ignore-errors/stylelint.js

@@ -1,9 +1,45 @@
 import { EOL } from 'node:os';
+import { AST } from '@codemod-utils/ast-javascript';
+function getIgnoredRules(lineOfCode) {
+    const traverse = AST.traverse(true);
+    let ignoredRules = [];
+    try {
+        traverse(lineOfCode, {
+            visitComment(node) {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+                const comment = node.value.value.trim();
+                if (comment.startsWith('stylelint-disable-next-line')) {
+                    ignoredRules = comment
+                        .replace(/^stylelint-disable-next-line\s+/, '')
+                        .split(',')
+                        .map((token) => token.trim());
+                }
+                return false;
+            },
+        });
+    }
+    catch {
+        // Do nothing
+    }
+    return ignoredRules;
+}
 export function ignoreErrors(file, lintErrors) {
     const lines = file.split(EOL);
     lintErrors.forEach(({ line, message }) => {
-        const ignoreDirective = `/* stylelint-disable-next-line ${message} */`;
-        lines.splice(line - 1, 0, ignoreDirective);
+        const currentIndex = line - 1;
+        const previousIndex = Math.max(currentIndex - 1, 0);
+        const ignoredRules = getIgnoredRules(lines[previousIndex]);
+        if (ignoredRules.length === 0) {
+            const ignoreDirective = `/* stylelint-disable-next-line ${message} */`;
+            lines.splice(currentIndex, 0, ignoreDirective);
+        }
+        else {
+            const newMessage = [...ignoredRules, ...message.split(', ')]
+                .sort()
+                .join(', ');
+            const ignoreDirective = `/* stylelint-disable-next-line ${newMessage} */`;
+            lines.splice(previousIndex, 1, ignoreDirective);
+        }
     });
     return lines.join(EOL);
 }

package/dist/src/utils/ignore-errors/typescript.js

@@ -58,17 +58,14 @@ export function ignoreErrorsFallback(file, lintErrors) {
 export function isParseable(file) {
     const traverse = AST.traverse();
     let isParseable = true;
-    function parseTemplate(template) {
-        try {
-            traverse(template);
-        }
-        catch {
-            isParseable = false;
-        }
+    try {
+        const templateTags = findTemplateTags(file);
+        templateTags.forEach((templateTag) => {
+            traverse(templateTag.contents);
+        });
+    }
+    catch {
+        isParseable = false;
     }
-    const templateTags = findTemplateTags(file);
-    templateTags.forEach((templateTag) => {
-        parseTemplate(templateTag.contents);
-    });
     return isParseable;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ignore-lint-errors",
-  "version": "0.4.2",
+  "version": "0.6.0",
   "description": "Codemod to ignore lint errors per line",
   "keywords": [
     "codemod",
@@ -17,6 +17,7 @@
     "dist"
   ],
   "dependencies": {
+    "@codemod-utils/ast-javascript": "^3.0.1",
     "@codemod-utils/ast-template": "^3.0.1",
     "@codemod-utils/ast-template-tag": "^2.1.0",
     "@codemod-utils/files": "^4.0.1",