ignore-lint-errors 0.1.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2026
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,56 @@
+[![This project uses GitHub Actions for continuous integration.](https://github.com/ijlee2/ignore-lint-errors/actions/workflows/ci.yml/badge.svg)](https://github.com/ijlee2/ignore-lint-errors/actions/workflows/ci.yml)
+
+# ignore-lint-errors
+
+_Codemod to add ignore directives_
+
+
+## Usage
+
+### Arguments
+
+[PROVIDE REQUIRED AND OPTIONAL ARGUMENTS.]
+
+<details>
+
+<summary>Optional: Specify the project root</summary>
+
+Pass `--root` to run the codemod somewhere else (i.e. not in the current directory).
+
+```sh
+pnpx ignore-lint-errors --root <path/to/your/project>
+```
+
+</details>
+
+
+### Limitations
+
+The codemod is designed to cover typical cases. It is not designed to cover one-off cases.
+
+To better meet your needs, consider cloning the repo and running the codemod locally.
+
+```sh
+cd <path/to/cloned/repo>
+
+# Compile TypeScript
+pnpm build
+
+# Run codemod
+./dist/bin/ignore-lint-errors.js --root <path/to/your/project>
+```
+
+
+## Compatibility
+
+- Node.js v22 or above
+
+
+## Contributing
+
+See the [Contributing](./CONTRIBUTING.md) guide for details.
+
+
+## License
+
+This project is licensed under the [MIT License](./LICENSE.md).

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

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+'use strict';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { runCodemod } from '../src/index.js';
+// Provide a title to the process in `ps`
+process.title = 'ignore-lint-errors';
+// Set codemod options
+const argv = yargs(hideBin(process.argv))
+    .option('linter', {
+    choices: ['eslint'],
+    describe: 'Linter to run',
+    type: 'string',
+})
+    .option('root', {
+    describe: 'Where to run the codemod',
+    type: 'string',
+})
+    .demandOption(['linter'])
+    .parseSync();
+const codemodOptions = {
+    linter: argv['linter'],
+    projectRoot: argv['root'] ?? process.cwd(),
+};
+runCodemod(codemodOptions);

package/dist/src/index.js

@@ -0,0 +1,6 @@
+import { createOptions, ignoreErrors, lintFiles } from './steps/index.js';
+export function runCodemod(codemodOptions) {
+    const options = createOptions(codemodOptions);
+    lintFiles(options);
+    ignoreErrors(options);
+}

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

@@ -0,0 +1,7 @@
+export function createOptions(codemodOptions) {
+    const { linter, projectRoot } = codemodOptions;
+    return {
+        linter,
+        projectRoot,
+    };
+}

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

@@ -0,0 +1,22 @@
+import { existsSync, readFileSync, writeFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { removeFiles } from '@codemod-utils/files';
+import { outputFilePath, parseOutputFile } from '../../utils/linters/eslint.js';
+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');
+    });
+    removeFiles([outputFilePath], { projectRoot });
+}

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

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

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

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

package/dist/src/steps/index.js

@@ -0,0 +1,3 @@
+export * from './create-options.js';
+export * from './ignore-errors.js';
+export * from './lint-files.js';

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

@@ -0,0 +1,11 @@
+import { execSync } from 'node:child_process';
+import { command } from '../../utils/linters/eslint.js';
+export function runEslint(options) {
+    const { projectRoot } = options;
+    try {
+        execSync(command, { cwd: projectRoot });
+    }
+    catch {
+        // Do nothing
+    }
+}

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

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

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

@@ -0,0 +1,16 @@
+import { existsSync, mkdirSync } from 'node:fs';
+import { join } from 'node:path';
+import { runEslint } 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));
+    }
+    switch (linter) {
+        case 'eslint': {
+            runEslint(options);
+            break;
+        }
+    }
+}

package/dist/src/types/index.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,49 @@
+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) {
+    const filePathToData = new Map();
+    const records = JSON.parse(file);
+    records.forEach((record) => {
+        const { filePath: absoluteFilePath, messages } = record;
+        const data = new Map();
+        messages.forEach(({ line, ruleId }) => {
+            if (data.has(line)) {
+                data.get(line).push(ruleId);
+            }
+            else {
+                data.set(line, [ruleId]);
+            }
+        });
+        filePathToData.set(absoluteFilePath, data);
+    });
+    const filesWithErrors = [];
+    filePathToData.forEach((data, absoluteFilePath) => {
+        const lintErrors = [];
+        data.forEach((allMessages, line) => {
+            const ruleIds = Array.from(new Set(allMessages.sort()));
+            lintErrors.push({
+                line,
+                message: ruleIds.join(', '),
+            });
+        });
+        lintErrors.sort((a, b) => {
+            if (a.line < b.line) {
+                return 1;
+            }
+            if (b.line < a.line) {
+                return -1;
+            }
+            return 0;
+        });
+        filesWithErrors.push({
+            absoluteFilePath,
+            lintErrors,
+        });
+    });
+    return filesWithErrors;
+}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "ignore-lint-errors",
+  "version": "0.1.0",
+  "description": "Codemod to add ignore directives",
+  "keywords": [
+    "codemod",
+    "ember-codemod",
+    "emberjs"
+  ],
+  "repository": "",
+  "license": "MIT",
+  "author": "",
+  "type": "module",
+  "main": "dist/src/index.js",
+  "bin": "dist/bin/ignore-lint-errors.js",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@codemod-utils/files": "^4.0.1",
+    "yargs": "^18.0.0"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.30.0",
+    "@codemod-utils/tests": "^3.0.1",
+    "@ijlee2-frontend-configs/changesets": "^2.1.0",
+    "@ijlee2-frontend-configs/eslint-config-node": "^3.2.0",
+    "@ijlee2-frontend-configs/prettier": "^3.0.2",
+    "@sondr3/minitest": "^0.1.2",
+    "@tsconfig/node22": "^22.0.5",
+    "@tsconfig/strictest": "^2.0.8",
+    "@types/node": "^22.19.17",
+    "@types/yargs": "^17.0.35",
+    "concurrently": "^9.2.1",
+    "eslint": "^9.39.4",
+    "prettier": "^3.8.3",
+    "typescript": "^5.9.3"
+  },
+  "engines": {
+    "node": "22.* || >= 24"
+  },
+  "scripts": {
+    "build": "sh build.sh --production",
+    "format": "prettier . --cache --write",
+    "lint": "concurrently \"pnpm:lint:*(!fix)\" --names \"lint:\"",
+    "lint:fix": "concurrently \"pnpm:lint:*:fix\" --names \"fix:\" && pnpm format",
+    "lint:format": "prettier . --cache --check",
+    "lint:js": "eslint . --cache",
+    "lint:js:fix": "eslint . --fix",
+    "lint:types": "tsc --noEmit",
+    "release:prepare": "changeset version",
+    "release:publish": "pnpm build && changeset publish",
+    "test": "sh build.sh --test && mt dist-for-testing --quiet"
+  }
+}