ignore-lint-errors 0.1.0 → 0.3.0

package/dist/bin/ignore-lint-errors.js

@@ -8,7 +8,7 @@ process.title = 'ignore-lint-errors';
 // Set codemod options
 const argv = yargs(hideBin(process.argv))
     .option('linter', {
-    choices: ['eslint'],
+    choices: ['eslint', 'typescript'],
     describe: 'Linter to run',
     type: 'string',
 })

package/dist/src/steps/create-options.js

@@ -1,6 +1,21 @@
+import { readPackageJson } from '@codemod-utils/package-json';
+function findDependencies(projectRoot) {
+    const packageJson = readPackageJson({ projectRoot });
+    const projectDependencies = new Set([
+        ...Object.keys(packageJson['dependencies'] ?? {}),
+        ...Object.keys(packageJson['devDependencies'] ?? {}),
+    ]);
+    return {
+        eslint: projectDependencies.has('eslint'),
+        glint: projectDependencies.has('@glint/core') ||
+            projectDependencies.has('@glint/ember-tsc'),
+        typescript: projectDependencies.has('typescript'),
+    };
+}
 export function createOptions(codemodOptions) {
     const { linter, projectRoot } = codemodOptions;
     return {
+        dependencies: findDependencies(projectRoot),
         linter,
         projectRoot,
     };

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

@@ -1,22 +1,24 @@
-import { existsSync, readFileSync, writeFileSync } from 'node:fs';
+import { readFileSync, writeFileSync } from 'node:fs';
+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;
-    if (!existsSync(join(projectRoot, outputFilePath))) {
-        return;
-    }
     const outputFile = readFileSync(join(projectRoot, outputFilePath), 'utf8');
-    const filesWithErrors = parseOutputFile(outputFile);
-    filesWithErrors.forEach(({ absoluteFilePath, lintErrors }) => {
-        const file = readFileSync(absoluteFilePath, 'utf8');
-        const lines = file.split('\n');
-        lintErrors.forEach(({ line, message }) => {
-            const ignoreDirective = `// @ts-expect-error: ${message}`;
-            lines.splice(line - 1, 0, ignoreDirective);
-        });
-        writeFileSync(absoluteFilePath, lines.join('\n'), '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/index.js

@@ -1 +1,2 @@
 export * from './eslint.js';
+export * from './typescript.js';

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

@@ -0,0 +1,60 @@
+import { readFileSync, writeFileSync } from 'node:fs';
+import { EOL } from 'node:os';
+import { join } from 'node:path';
+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 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);
+    });
+    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;
+    const outputFile = readFileSync(join(projectRoot, outputFilePath), 'utf8');
+    const filesWithErrors = parseOutputFile(outputFile);
+    filesWithErrors.forEach(({ filePath, lintErrors }) => {
+        const file = readFileSync(join(projectRoot, filePath), '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/steps/ignore-errors.js

@@ -1,9 +1,17 @@
-import { ignoreErrorsFromEslint } from './ignore-errors/index.js';
+import { ignoreErrorsFromEslint, ignoreErrorsFromTypescript, } from './ignore-errors/index.js';
 export function ignoreErrors(options) {
-    const { linter } = options;
+    const { dependencies, linter } = options;
     switch (linter) {
         case 'eslint': {
-            ignoreErrorsFromEslint(options);
+            if (dependencies.eslint) {
+                ignoreErrorsFromEslint(options);
+            }
+            break;
+        }
+        case 'typescript': {
+            if (dependencies.typescript) {
+                ignoreErrorsFromTypescript(options);
+            }
             break;
         }
     }

package/dist/src/steps/lint-files/eslint.js

@@ -1,7 +1,13 @@
 import { execSync } from 'node:child_process';
-import { command } from '../../utils/linters/eslint.js';
+import { outputFilePath } from '../../utils/linters/eslint.js';
 export function runEslint(options) {
     const { projectRoot } = options;
+    const command = [
+        './node_modules/.bin/eslint',
+        '--format json',
+        `--output-file ${outputFilePath}`,
+        '--quiet',
+    ].join(' ');
     try {
         execSync(command, { cwd: projectRoot });
     }

package/dist/src/steps/lint-files/index.js

@@ -1 +1,2 @@
 export * from './eslint.js';
+export * from './typescript.js';

package/dist/src/steps/lint-files/typescript.js

@@ -0,0 +1,14 @@
+import { execSync } from 'node:child_process';
+import { outputFilePath } from '../../utils/linters/typescript.js';
+export function runTypescript(options) {
+    const { dependencies, projectRoot } = options;
+    const command = dependencies.glint
+        ? `./node_modules/.bin/ember-tsc > ${outputFilePath}`
+        : `./node_modules/.bin/tsc > ${outputFilePath}`;
+    try {
+        execSync(command, { cwd: projectRoot });
+    }
+    catch {
+        // Do nothing
+    }
+}

package/dist/src/steps/lint-files.js

@@ -1,15 +1,22 @@
 import { existsSync, mkdirSync } from 'node:fs';
 import { join } from 'node:path';
-import { runEslint } from './lint-files/index.js';
+import { runEslint, runTypescript } from './lint-files/index.js';
 export function lintFiles(options) {
-    const { linter, projectRoot } = options;
-    const tempDir = '.ignore-lint-errors';
-    if (!existsSync(join(projectRoot, tempDir))) {
-        mkdirSync(join(projectRoot, tempDir));
+    const { dependencies, linter, projectRoot } = options;
+    if (!existsSync(join(projectRoot, '.ignore-lint-errors'))) {
+        mkdirSync(join(projectRoot, '.ignore-lint-errors'));
     }
     switch (linter) {
         case 'eslint': {
-            runEslint(options);
+            if (dependencies.eslint) {
+                runEslint(options);
+            }
+            break;
+        }
+        case 'typescript': {
+            if (dependencies.typescript) {
+                runTypescript(options);
+            }
             break;
         }
     }

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,11 +1,6 @@
+import { relative, sep } from 'node:path';
 export const outputFilePath = '.ignore-lint-errors/eslint.txt';
-export const command = [
-    './node_modules/.bin/eslint',
-    '--format json',
-    `--output-file ${outputFilePath}`,
-    '--quiet',
-].join(' ');
-export function parseOutputFile(file) {
+export function parseOutputFile(file, projectRoot) {
     const filePathToData = new Map();
     const records = JSON.parse(file);
     records.forEach((record) => {
@@ -19,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()));
@@ -41,7 +37,7 @@ export function parseOutputFile(file) {
             return 0;
         });
         filesWithErrors.push({
-            absoluteFilePath,
+            filePath,
             lintErrors,
         });
     });

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

@@ -0,0 +1,49 @@
+import { EOL } from 'node:os';
+export const outputFilePath = '.ignore-lint-errors/typescript.txt';
+export function parseOutputFile(file) {
+    const filePathToData = new Map();
+    file.split(EOL).forEach((str) => {
+        const matches = str.match(/^(.+)\((\d+),\d+\): error TS\d+: (.+)\.$/);
+        if (matches === null) {
+            return;
+        }
+        const filePath = matches[1];
+        const line = Number.parseInt(matches[2]);
+        const message = matches[3];
+        if (filePathToData.has(filePath)) {
+            if (filePathToData.get(filePath).has(line)) {
+                filePathToData.get(filePath).get(line).push(message);
+            }
+            else {
+                filePathToData.get(filePath).set(line, [message]);
+            }
+        }
+        else {
+            filePathToData.set(filePath, new Map([[line, [message]]]));
+        }
+    });
+    const filesWithErrors = [];
+    filePathToData.forEach((data, filePath) => {
+        const lintErrors = [];
+        data.forEach((_allMessages, line) => {
+            lintErrors.push({
+                line,
+                message: 'Incorrect type',
+            });
+        });
+        lintErrors.sort((a, b) => {
+            if (a.line < b.line) {
+                return 1;
+            }
+            if (b.line < a.line) {
+                return -1;
+            }
+            return 0;
+        });
+        filesWithErrors.push({
+            filePath,
+            lintErrors,
+        });
+    });
+    return filesWithErrors;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ignore-lint-errors",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Codemod to add ignore directives",
   "keywords": [
     "codemod",
@@ -17,7 +17,10 @@
     "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",
     "yargs": "^18.0.0"
   },
   "devDependencies": {