ignore-lint-errors 0.2.0 → 0.3.0

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

@@ -3,18 +3,22 @@ import { EOL } from 'node:os';
 import { join } from 'node:path';
 import { removeFiles } from '@codemod-utils/files';
 import { outputFilePath, parseOutputFile } from '../../utils/linters/eslint.js';
+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);
+    });
+    return lines.join(EOL);
+}
 export function ignoreErrorsFromEslint(options) {
     const { projectRoot } = options;
     const outputFile = readFileSync(join(projectRoot, outputFilePath), 'utf8');
-    const filesWithErrors = parseOutputFile(outputFile);
-    filesWithErrors.forEach(({ absoluteFilePath, lintErrors }) => {
-        const file = readFileSync(absoluteFilePath, 'utf8');
-        const lines = file.split(EOL);
-        lintErrors.forEach(({ line, message }) => {
-            const ignoreDirective = `// @ts-expect-error: ${message}`;
-            lines.splice(line - 1, 0, ignoreDirective);
-        });
-        writeFileSync(absoluteFilePath, lines.join(EOL), 'utf8');
+    const filesWithErrors = parseOutputFile(outputFile, projectRoot);
+    filesWithErrors.forEach(({ filePath, lintErrors }) => {
+        const file = readFileSync(join(projectRoot, filePath), 'utf8');
+        const newFile = ignoreErrors(file, lintErrors);
+        writeFileSync(join(projectRoot, filePath), newFile, 'utf8');
     });
     removeFiles([outputFilePath], { projectRoot });
 }

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

@@ -1,23 +1,48 @@
 import { readFileSync, writeFileSync } from 'node:fs';
 import { EOL } from 'node:os';
 import { join } from 'node:path';
-import { findTemplateTags } from '@codemod-utils/ast-template-tag';
+import { updateTemplates } from '@codemod-utils/ast-template-tag';
 import { removeFiles } from '@codemod-utils/files';
+import { findLinesWithTemplate, isParseable, } from '../../utils/ignore-errors/typescript.js';
 import { outputFilePath, parseOutputFile, } from '../../utils/linters/typescript.js';
-function findLinesWithTemplate(file) {
-    function getLOC(file) {
-        const matches = file.match(/\r?\n/g);
-        return (matches ?? []).length;
-    }
-    const templateTags = findTemplateTags(file);
-    const linesWithTemplate = [];
-    templateTags.forEach((templateTag) => {
-        const { range } = templateTag;
-        const lineStart = getLOC(file.substring(0, range.startChar)) + 1;
-        const lineEnd = getLOC(file.substring(0, range.endChar)) + 1;
-        linesWithTemplate.push([lineStart, lineEnd]);
+function ignoreErrors(file, lintErrors) {
+    const linesWithTemplate = findLinesWithTemplate(file);
+    const lines = file.split(EOL);
+    lintErrors.forEach(({ line, message }) => {
+        const erroredInTemplate = linesWithTemplate.some(([lineStart, lineEnd]) => {
+            return lineStart <= line && line <= lineEnd;
+        });
+        const ignoreDirective = erroredInTemplate
+            ? `{{! @glint-expect-error: ${message} }}`
+            : `// @ts-expect-error: ${message}`;
+        lines.splice(line - 1, 0, ignoreDirective);
+    });
+    return lines.join(EOL);
+}
+// For fallback, ignore type checks in templates
+function ignoreErrorsFallback(file, lintErrors) {
+    const linesWithTemplate = findLinesWithTemplate(file);
+    const lines = file.split(EOL);
+    let hasErrorInTemplate = false;
+    lintErrors.forEach(({ line, message }) => {
+        const erroredInTemplate = linesWithTemplate.some(([lineStart, lineEnd]) => {
+            return lineStart <= line && line <= lineEnd;
+        });
+        if (erroredInTemplate) {
+            hasErrorInTemplate = true;
+            return;
+        }
+        const ignoreDirective = `// @ts-expect-error: ${message}`;
+        lines.splice(line - 1, 0, ignoreDirective);
     });
-    return linesWithTemplate;
+    let newFile = lines.join(EOL);
+    if (hasErrorInTemplate) {
+        newFile = updateTemplates(newFile, (code) => {
+            const ignoreDirective = '{{! @glint-nocheck }}';
+            return [ignoreDirective, code].join(EOL);
+        });
+    }
+    return newFile;
 }
 export function ignoreErrorsFromTypescript(options) {
     const { projectRoot } = options;
@@ -25,18 +50,11 @@ export function ignoreErrorsFromTypescript(options) {
     const filesWithErrors = parseOutputFile(outputFile);
     filesWithErrors.forEach(({ filePath, lintErrors }) => {
         const file = readFileSync(join(projectRoot, filePath), 'utf8');
-        const lines = file.split(EOL);
-        const linesWithTemplate = findLinesWithTemplate(file);
-        lintErrors.forEach(({ line, message }) => {
-            const erroredInTemplate = linesWithTemplate.some(([lineStart, lineEnd]) => {
-                return lineStart <= line && line <= lineEnd;
-            });
-            const ignoreDirective = erroredInTemplate
-                ? `{{! @glint-expect-error: ${message} }}`
-                : `// @ts-expect-error: ${message}`;
-            lines.splice(line - 1, 0, ignoreDirective);
-        });
-        writeFileSync(join(projectRoot, filePath), lines.join(EOL), 'utf8');
+        let newFile = ignoreErrors(file, lintErrors);
+        if (!isParseable(newFile)) {
+            newFile = ignoreErrorsFallback(file, lintErrors);
+        }
+        writeFileSync(join(projectRoot, filePath), newFile, 'utf8');
     });
     removeFiles([outputFilePath], { projectRoot });
 }

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

@@ -0,0 +1,34 @@
+import { AST } from '@codemod-utils/ast-template';
+import { findTemplateTags } from '@codemod-utils/ast-template-tag';
+export function findLinesWithTemplate(file) {
+    function getLOC(file) {
+        const matches = file.match(/\r?\n/g);
+        return (matches ?? []).length;
+    }
+    const templateTags = findTemplateTags(file);
+    const linesWithTemplate = [];
+    templateTags.forEach((templateTag) => {
+        const { range } = templateTag;
+        const lineStart = getLOC(file.substring(0, range.startChar)) + 1;
+        const lineEnd = getLOC(file.substring(0, range.endChar)) + 1;
+        linesWithTemplate.push([lineStart, lineEnd]);
+    });
+    return linesWithTemplate;
+}
+export function isParseable(file) {
+    const traverse = AST.traverse();
+    let isParseable = true;
+    function parseTemplate(template) {
+        try {
+            traverse(template);
+        }
+        catch {
+            isParseable = false;
+        }
+    }
+    const templateTags = findTemplateTags(file);
+    templateTags.forEach((templateTag) => {
+        parseTemplate(templateTag.contents);
+    });
+    return isParseable;
+}

package/dist/src/utils/linters/eslint.js

@@ -1,5 +1,6 @@
+import { relative, sep } from 'node:path';
 export const outputFilePath = '.ignore-lint-errors/eslint.txt';
-export function parseOutputFile(file) {
+export function parseOutputFile(file, projectRoot) {
     const filePathToData = new Map();
     const records = JSON.parse(file);
     records.forEach((record) => {
@@ -13,10 +14,11 @@ export function parseOutputFile(file) {
                 data.set(line, [ruleId]);
             }
         });
-        filePathToData.set(absoluteFilePath, data);
+        const filePath = relative(projectRoot, absoluteFilePath).replaceAll(sep, '/');
+        filePathToData.set(filePath, data);
     });
     const filesWithErrors = [];
-    filePathToData.forEach((data, absoluteFilePath) => {
+    filePathToData.forEach((data, filePath) => {
         const lintErrors = [];
         data.forEach((allMessages, line) => {
             const ruleIds = Array.from(new Set(allMessages.sort()));
@@ -35,7 +37,7 @@ export function parseOutputFile(file) {
             return 0;
         });
         filesWithErrors.push({
-            absoluteFilePath,
+            filePath,
             lintErrors,
         });
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ignore-lint-errors",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Codemod to add ignore directives",
   "keywords": [
     "codemod",
@@ -17,6 +17,7 @@
     "dist"
   ],
   "dependencies": {
+    "@codemod-utils/ast-template": "^3.0.1",
     "@codemod-utils/ast-template-tag": "^2.1.0",
     "@codemod-utils/files": "^4.0.1",
     "@codemod-utils/package-json": "^4.0.1",