ignore-lint-errors 1.0.0 → 1.1.0

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/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,16 @@
+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 { projectRoot } = options;
+    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.js

@@ -1,4 +1,4 @@
-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;
     switch (linter) {
@@ -8,6 +8,12 @@ export function ignoreErrors(options) {
             }
             break;
         }
+        case 'oxlint': {
+            if (dependencies.oxlint) {
+                ignoreErrorsFromOxlint(options);
+            }
+            break;
+        }
         case 'stylelint': {
             if (dependencies.stylelint) {
                 ignoreErrorsFromStylelint(options);

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,25 @@
+import { execSync } from 'node:child_process';
+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 runOxlint(options) {
+    const { projectRoot } = options;
+    const command = [
+        './node_modules/.bin/oxlint',
+        getSrc(options),
+        '--format json',
+        '--quiet',
+        `> ${outputFilePath}`,
+    ].join(' ');
+    try {
+        execSync(command, { cwd: projectRoot });
+    }
+    catch {
+        // Do nothing
+    }
+}

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

@@ -1,6 +1,6 @@
 import { existsSync, mkdirSync } from 'node:fs';
 import { join } from 'node:path';
-import { runEslint, runStylelint, runTypescript } from './lint-files/index.js';
+import { runEslint, runOxlint, runStylelint, runTypescript, } from './lint-files/index.js';
 export function lintFiles(options) {
     const { dependencies, linter, projectRoot } = options;
     if (!existsSync(join(projectRoot, '.ignore-lint-errors'))) {
@@ -13,6 +13,12 @@ export function lintFiles(options) {
             }
             break;
         }
+        case 'oxlint': {
+            if (dependencies.oxlint) {
+                runOxlint(options);
+            }
+            break;
+        }
         case 'stylelint': {
             if (dependencies.stylelint) {
                 runStylelint(options);

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/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.0",
   "description": "Codemod to ignore lint errors per line",
   "keywords": [
     "codemod",