ignore-lint-errors 1.0.0 → 1.1.1

package/README.md

@@ -46,6 +46,9 @@ You must pass `--linter` to indicate which linter to run.
 # Run eslint
 pnpx ignore-lint-errors --linter eslint
 
+# Run oxlint
+pnpx ignore-lint-errors --linter oxlint
+
 # Run stylelint
 pnpx ignore-lint-errors --linter stylelint
 
@@ -82,6 +85,17 @@ pnpx ignore-lint-errors --linter eslint --src app tests
 pnpx ignore-lint-errors --linter eslint --src app/{components,templates}/**/*.gts
 ```
 
+```sh
+# oxlint supports files
+pnpx ignore-lint-errors --linter oxlint --src app/components/example-1.gts app/templates/example-2.gts
+
+# oxlint supports directories
+pnpx ignore-lint-errors --linter oxlint --src app tests
+
+# oxlint supports globs
+pnpx ignore-lint-errors --linter oxlint --src app/{components,templates}/**/*.gts
+```
+
 ```sh
 # stylelint supports files
 pnpx ignore-lint-errors --linter stylelint --src app/components/example-1.module.css app/templates/example-2.module.css
@@ -113,7 +127,7 @@ pnpm build
 ## Compatibility
 
 - Node.js v22 or above
-- Tested against `eslint@v9`, `glint@v2`, `stylelint@v17`, `typescript@v5`
+- Tested against `eslint@v9`, `glint@v2`, `oxlint@v1`, `stylelint@v17`, `typescript@v5`
 
 
 ## Contributing

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', 'stylelint', 'typescript'],
+    choices: ['eslint', 'oxlint', 'stylelint', 'typescript'],
     describe: 'Linter to run',
     type: 'string',
 })

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

@@ -8,6 +8,7 @@ function findDependencies(projectRoot) {
     return {
         eslint: projectDependencies.has('eslint'),
         glint: projectDependencies.has('@glint/ember-tsc'),
+        oxlint: projectDependencies.has('oxlint'),
         stylelint: projectDependencies.has('stylelint'),
         typescript: projectDependencies.has('typescript'),
     };

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

@@ -4,7 +4,10 @@ import { removeFiles } from '@codemod-utils/files';
 import { ignoreErrors } from '../../utils/ignore-errors/eslint.js';
 import { outputFilePath, parseOutputFile } from '../../utils/linters/eslint.js';
 export function ignoreErrorsFromEslint(options) {
-    const { projectRoot } = options;
+    const { dependencies, projectRoot } = options;
+    if (!dependencies.eslint) {
+        return;
+    }
     const outputFile = readFileSync(join(projectRoot, outputFilePath), 'utf8');
     const filesWithErrors = parseOutputFile(outputFile, projectRoot);
     filesWithErrors.forEach(({ filePath, lintErrors }) => {

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

@@ -1,3 +1,4 @@
 export * from './eslint.js';
+export * from './oxlint.js';
 export * from './stylelint.js';
 export * from './typescript.js';

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

@@ -0,0 +1,19 @@
+import { readFileSync, writeFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { removeFiles } from '@codemod-utils/files';
+import { ignoreErrors } from '../../utils/ignore-errors/oxlint.js';
+import { outputFilePath, parseOutputFile } from '../../utils/linters/oxlint.js';
+export function ignoreErrorsFromOxlint(options) {
+    const { dependencies, projectRoot } = options;
+    if (!dependencies.oxlint) {
+        return;
+    }
+    const outputFile = readFileSync(join(projectRoot, outputFilePath), 'utf8');
+    const filesWithErrors = parseOutputFile(outputFile);
+    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/stylelint.js

@@ -4,7 +4,10 @@ import { removeFiles } from '@codemod-utils/files';
 import { ignoreErrors } from '../../utils/ignore-errors/stylelint.js';
 import { outputFilePath, parseOutputFile, } from '../../utils/linters/stylelint.js';
 export function ignoreErrorsFromStylelint(options) {
-    const { projectRoot } = options;
+    const { dependencies, projectRoot } = options;
+    if (!dependencies.stylelint) {
+        return;
+    }
     const outputFile = readFileSync(join(projectRoot, outputFilePath), 'utf8');
     const filesWithErrors = parseOutputFile(outputFile, projectRoot);
     filesWithErrors.forEach(({ filePath, lintErrors }) => {

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

@@ -1,16 +1,20 @@
 import { readFileSync, writeFileSync } from 'node:fs';
 import { join } from 'node:path';
 import { removeFiles } from '@codemod-utils/files';
-import { ignoreErrors, ignoreErrorsFallback, isParseable, } from '../../utils/ignore-errors/typescript.js';
+import { areTemplateTagsValid } from '../../utils/ignore-errors/shared/index.js';
+import { ignoreErrors, ignoreErrorsFallback, } from '../../utils/ignore-errors/typescript.js';
 import { outputFilePath, parseOutputFile, } from '../../utils/linters/typescript.js';
 export function ignoreErrorsFromTypescript(options) {
-    const { projectRoot } = options;
+    const { dependencies, projectRoot } = options;
+    if (!dependencies.typescript) {
+        return;
+    }
     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)) {
+        if (!areTemplateTagsValid(newFile)) {
             newFile = ignoreErrorsFallback(file, lintErrors);
         }
         writeFileSync(join(projectRoot, filePath), newFile, 'utf8');

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

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

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

@@ -27,9 +27,12 @@ function getSrc(options) {
     }
     return src.map((token) => `"${token}"`).join(' ');
 }
-export function runEslint(options) {
-    const { projectRoot } = options;
-    const command = [
+export function getCommandEslint(options) {
+    const { dependencies } = options;
+    if (!dependencies.eslint) {
+        return undefined;
+    }
+    return [
         './node_modules/.bin/eslint',
         getSrc(options),
         getConcurrencyOption(options),
@@ -37,10 +40,4 @@ export function runEslint(options) {
         `--output-file ${outputFilePath}`,
         '--quiet',
     ].join(' ');
-    try {
-        execSync(command, { cwd: projectRoot });
-    }
-    catch {
-        // Do nothing
-    }
 }

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

@@ -1,3 +1,4 @@
 export * from './eslint.js';
+export * from './oxlint.js';
 export * from './stylelint.js';
 export * from './typescript.js';

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

@@ -0,0 +1,21 @@
+import { outputFilePath } from '../../utils/linters/oxlint.js';
+function getSrc(options) {
+    const { src } = options;
+    if (src === undefined) {
+        return '';
+    }
+    return src.map((token) => `"${token}"`).join(' ');
+}
+export function getCommandOxlint(options) {
+    const { dependencies } = options;
+    if (!dependencies.oxlint) {
+        return undefined;
+    }
+    return [
+        './node_modules/.bin/oxlint',
+        getSrc(options),
+        '--format json',
+        '--quiet',
+        `> ${outputFilePath}`,
+    ].join(' ');
+}

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

@@ -1,4 +1,3 @@
-import { execSync } from 'node:child_process';
 import { outputFilePath } from '../../utils/linters/stylelint.js';
 function getSrc(options) {
     const { src } = options;
@@ -7,9 +6,12 @@ function getSrc(options) {
     }
     return src.map((token) => `"${token}"`).join(' ');
 }
-export function runStylelint(options) {
-    const { projectRoot } = options;
-    const command = [
+export function getCommandStylelint(options) {
+    const { dependencies } = options;
+    if (!dependencies.stylelint) {
+        return undefined;
+    }
+    return [
         './node_modules/.bin/stylelint',
         getSrc(options),
         '--formatter json',
@@ -17,10 +19,4 @@ export function runStylelint(options) {
         '--quiet',
         '2>/dev/null', // Suppress output to process.stderr
     ].join(' ');
-    try {
-        execSync(command, { cwd: projectRoot });
-    }
-    catch {
-        // Do nothing
-    }
 }

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

@@ -1,14 +1,11 @@
-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 });
+export function getCommandTypescript(options) {
+    const { dependencies } = options;
+    if (!dependencies.typescript) {
+        return undefined;
     }
-    catch {
-        // Do nothing
+    if (dependencies.glint) {
+        return `./node_modules/.bin/ember-tsc > ${outputFilePath}`;
     }
+    return `./node_modules/.bin/tsc > ${outputFilePath}`;
 }

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

@@ -1,29 +1,38 @@
+import { execSync } from 'node:child_process';
 import { existsSync, mkdirSync } from 'node:fs';
 import { join } from 'node:path';
-import { runEslint, runStylelint, runTypescript } from './lint-files/index.js';
+import { getCommandEslint, getCommandOxlint, getCommandStylelint, getCommandTypescript, } from './lint-files/index.js';
 export function lintFiles(options) {
-    const { dependencies, linter, projectRoot } = options;
+    const { linter, projectRoot } = options;
     if (!existsSync(join(projectRoot, '.ignore-lint-errors'))) {
         mkdirSync(join(projectRoot, '.ignore-lint-errors'));
     }
+    let command;
     switch (linter) {
         case 'eslint': {
-            if (dependencies.eslint) {
-                runEslint(options);
-            }
+            command = getCommandEslint(options);
+            break;
+        }
+        case 'oxlint': {
+            command = getCommandOxlint(options);
             break;
         }
         case 'stylelint': {
-            if (dependencies.stylelint) {
-                runStylelint(options);
-            }
+            command = getCommandStylelint(options);
             break;
         }
         case 'typescript': {
-            if (dependencies.typescript) {
-                runTypescript(options);
-            }
+            command = getCommandTypescript(options);
             break;
         }
     }
+    if (command === undefined) {
+        return;
+    }
+    try {
+        execSync(command, { cwd: projectRoot });
+    }
+    catch {
+        // Do nothing
+    }
 }

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

@@ -0,0 +1,23 @@
+import { EOL } from 'node:os';
+import { getIgnoredRules } from './shared/index.js';
+export function ignoreErrors(file, lintErrors) {
+    const lines = file.split(EOL);
+    const ignoreDirective = 'oxlint-disable-next-line';
+    lintErrors.forEach(({ line, message }) => {
+        const currentIndex = line - 1;
+        const previousIndex = Math.max(currentIndex - 1, 0);
+        const ignoredRules = getIgnoredRules(lines[previousIndex], {
+            ignoreDirective,
+        });
+        if (ignoredRules.length === 0) {
+            lines.splice(currentIndex, 0, `// ${ignoreDirective} ${message}`);
+        }
+        else {
+            const newMessage = [...ignoredRules, ...message.split(', ')]
+                .sort()
+                .join(', ');
+            lines.splice(previousIndex, 1, `// ${ignoreDirective} ${newMessage}`);
+        }
+    });
+    return lines.join(EOL);
+}

package/dist/src/utils/ignore-errors/shared/index.js

@@ -1,8 +1,43 @@
-import { AST } from '@codemod-utils/ast-javascript';
+import { AST as ASTJavaScript } from '@codemod-utils/ast-javascript';
+import { AST as ASTTemplate } from '@codemod-utils/ast-template';
+import { findTemplateTags as upstreamFindTemplateTags } from '@codemod-utils/ast-template-tag';
+export function areTemplateTagsValid(file) {
+    let isValid = true;
+    try {
+        const templateTags = upstreamFindTemplateTags(file);
+        templateTags.forEach(({ contents }) => {
+            ASTTemplate.traverse(contents);
+        });
+    }
+    catch {
+        isValid = false;
+    }
+    return isValid;
+}
+export function findTemplateTags(file) {
+    function getLOC(file) {
+        const matches = file.match(/\r?\n/g);
+        return (matches ?? []).length;
+    }
+    const templateTags = upstreamFindTemplateTags(file);
+    return templateTags.map((templateTag) => {
+        const { contents, range } = templateTag;
+        const lineStart = getLOC(file.substring(0, range.startChar)) + 1;
+        const lineEnd = getLOC(file.substring(0, range.endChar)) + 1;
+        const lineRange = {
+            end: lineEnd,
+            start: lineStart,
+        };
+        return {
+            contents,
+            lineRange,
+        };
+    });
+}
 export function getIgnoredRules(lineOfCode, options) {
     let ignoredRules = [];
     try {
-        AST.traverse(lineOfCode, {
+        ASTJavaScript.traverse(lineOfCode, {
             visitComment(path) {
                 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
                 const comment = path.value.value.trim();

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

@@ -1,27 +1,6 @@
 import { EOL } from 'node:os';
-import { AST } from '@codemod-utils/ast-template';
-import { findTemplateTags as upstreamFindTemplateTags, updateTemplates, } from '@codemod-utils/ast-template-tag';
-import { getIgnoredRules } from './shared/index.js';
-function findTemplateTags(file) {
-    function getLOC(file) {
-        const matches = file.match(/\r?\n/g);
-        return (matches ?? []).length;
-    }
-    const templateTags = upstreamFindTemplateTags(file);
-    return templateTags.map((templateTag) => {
-        const { contents, range } = templateTag;
-        const lineStart = getLOC(file.substring(0, range.startChar)) + 1;
-        const lineEnd = getLOC(file.substring(0, range.endChar)) + 1;
-        const lineRange = {
-            end: lineEnd,
-            start: lineStart,
-        };
-        return {
-            contents,
-            lineRange,
-        };
-    });
-}
+import { updateTemplates } from '@codemod-utils/ast-template-tag';
+import { findTemplateTags, getIgnoredRules } from './shared/index.js';
 export function ignoreErrors(file, lintErrors) {
     const lines = file.split(EOL);
     const templateTags = findTemplateTags(file);
@@ -33,25 +12,26 @@ export function ignoreErrors(file, lintErrors) {
         });
         const erroredInTemplate = templateTagIndex >= 0;
         if (erroredInTemplate) {
-            const ignoreDirective = `{{! @glint-expect-error: ${message} }}`;
+            const comment = `{{! @glint-expect-error: ${message} }}`;
             const { contents, lineRange } = templateTags[templateTagIndex];
-            if (lineRange.start !== lineRange.end) {
-                lines.splice(currentIndex, 0, ignoreDirective);
-                return;
+            if (lineRange.start === lineRange.end) {
+                const newTemplate = lines[currentIndex].replace(/<template>(.+)<\/template>/, [`<template>${comment}`, `${contents}</template>`].join(EOL));
+                lines.splice(currentIndex, 1, newTemplate);
+            }
+            else {
+                lines.splice(currentIndex, 0, comment);
             }
-            const newTemplate = lines[currentIndex].replace(/<template>(.+)<\/template>/, [`<template>${ignoreDirective}`, `${contents}</template>`].join(EOL));
-            lines.splice(currentIndex, 1, newTemplate);
             return;
         }
-        const ignoreDirective = `// @ts-expect-error: ${message}`;
+        const comment = `// @ts-expect-error: ${message}`;
         const ignoredRules = getIgnoredRules(lines[previousIndex], {
             ignoreDirective: 'eslint-disable-next-line',
         });
         if (ignoredRules.length === 0) {
-            lines.splice(currentIndex, 0, ignoreDirective);
+            lines.splice(currentIndex, 0, comment);
         }
         else {
-            lines.splice(previousIndex, 0, ignoreDirective);
+            lines.splice(previousIndex, 0, comment);
         }
     });
     return lines.join(EOL);
@@ -71,36 +51,23 @@ export function ignoreErrorsFallback(file, lintErrors) {
             hasErrorInTemplate = true;
             return;
         }
-        const ignoreDirective = `// @ts-expect-error: ${message}`;
+        const comment = `// @ts-expect-error: ${message}`;
         const ignoredRules = getIgnoredRules(lines[previousIndex], {
             ignoreDirective: 'eslint-disable-next-line',
         });
         if (ignoredRules.length === 0) {
-            lines.splice(currentIndex, 0, ignoreDirective);
+            lines.splice(currentIndex, 0, comment);
         }
         else {
-            lines.splice(previousIndex, 0, ignoreDirective);
+            lines.splice(previousIndex, 0, comment);
         }
     });
     let newFile = lines.join(EOL);
     if (hasErrorInTemplate) {
         newFile = updateTemplates(newFile, (code) => {
-            const ignoreDirective = '{{! @glint-nocheck }}';
-            return [ignoreDirective, code].join('');
+            const comment = '{{! @glint-nocheck }}';
+            return [comment, code].join('');
         });
     }
     return newFile;
 }
-export function isParseable(file) {
-    let isParseable = true;
-    try {
-        const templateTags = findTemplateTags(file);
-        templateTags.forEach(({ contents }) => {
-            AST.traverse(contents);
-        });
-    }
-    catch {
-        isParseable = false;
-    }
-    return isParseable;
-}

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

@@ -0,0 +1,51 @@
+import { getFilesWithErrors } from './shared/index.js';
+export const outputFilePath = '.ignore-lint-errors/oxlint.txt';
+function extractRuleId(code) {
+    const matches = code.match(/^.+\((.+)\)$/);
+    if (matches === null) {
+        throw new Error(`Unable to extract rule ID (code: ${code})`);
+    }
+    return matches[1];
+}
+function normalize(file) {
+    const filePathToData = new Map();
+    const { diagnostics } = JSON.parse(file);
+    const filePathToMessages = new Map();
+    diagnostics.forEach((diagnostic) => {
+        const { code, filename: filePath, labels } = diagnostic;
+        const line = labels[0].span.line;
+        const ruleId = extractRuleId(code);
+        const message = {
+            line,
+            ruleId,
+        };
+        if (filePathToMessages.has(filePath)) {
+            filePathToMessages.get(filePath).push(message);
+        }
+        else {
+            filePathToMessages.set(filePath, [message]);
+        }
+    });
+    filePathToMessages.forEach((messages, filePath) => {
+        const data = new Map();
+        const lineToRules = new Map();
+        messages.forEach(({ line, ruleId }) => {
+            if (lineToRules.has(line)) {
+                lineToRules.get(line).push(ruleId);
+            }
+            else {
+                lineToRules.set(line, [ruleId]);
+            }
+        });
+        lineToRules.forEach((rules, line) => {
+            const message = Array.from(new Set(rules.sort())).join(', ');
+            data.set(line, message);
+        });
+        filePathToData.set(filePath, data);
+    });
+    return filePathToData;
+}
+export function parseOutputFile(file) {
+    const filePathToData = normalize(file);
+    return getFilesWithErrors(filePathToData);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ignore-lint-errors",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Codemod to ignore lint errors per line",
   "keywords": [
     "codemod",
@@ -24,28 +24,28 @@
     "dist"
   ],
   "dependencies": {
-    "@codemod-utils/ast-javascript": "^4.0.2",
-    "@codemod-utils/ast-template": "^4.0.0",
-    "@codemod-utils/ast-template-tag": "^2.6.0",
-    "@codemod-utils/files": "^4.0.1",
-    "@codemod-utils/package-json": "^4.0.3",
+    "@codemod-utils/ast-javascript": "^4.2.1",
+    "@codemod-utils/ast-template": "^4.1.0",
+    "@codemod-utils/ast-template-tag": "^2.7.0",
+    "@codemod-utils/files": "^4.1.0",
+    "@codemod-utils/package-json": "^4.1.0",
     "yargs": "^18.0.0"
   },
   "devDependencies": {
     "@changesets/cli": "^2.31.0",
-    "@codemod-utils/tests": "^3.0.2",
+    "@codemod-utils/tests": "^3.1.0",
     "@ijlee2-frontend-configs/changesets": "^2.1.1",
-    "@ijlee2-frontend-configs/eslint-config-node": "^3.4.4",
-    "@ijlee2-frontend-configs/prettier": "^3.2.0",
+    "@ijlee2-frontend-configs/eslint-config-node": "^4.1.0",
+    "@ijlee2-frontend-configs/prettier": "^3.3.0",
     "@sondr3/minitest": "^0.1.2",
     "@tsconfig/node22": "^22.0.5",
     "@tsconfig/strictest": "^2.0.8",
     "@types/node": "^22.20.0",
     "@types/yargs": "^17.0.35",
     "concurrently": "^10.0.3",
-    "eslint": "^9.39.4",
-    "prettier": "^3.8.4",
-    "typescript": "^5.9.3"
+    "eslint": "^10.6.0",
+    "prettier": "^3.9.4",
+    "typescript": "^6.0.3"
   },
   "engines": {
     "node": "22.* || >= 24"