@oxlint/migrate 1.50.0 → 1.52.0

package/README.md

@@ -1,8 +1,8 @@
 # @oxlint/migrate
 
 ![test](https://github.com/oxc-project/oxlint-migrate/actions/workflows/test.yml/badge.svg)
-[![NPM Version](https://img.shields.io/npm/v/%40oxlint%2Fmigrate)](https://www.npmjs.com/package/@oxlint/migrate)
-[![NPM Downloads](https://img.shields.io/npm/dm/%40oxlint%2Fmigrate)](https://www.npmjs.com/package/@oxlint/migrate)
+[![NPM Version](https://img.shields.io/npm/v/%40oxlint%2Fmigrate)](https://npmx.dev/package/@oxlint/migrate)
+[![NPM Downloads](https://img.shields.io/npm/dm/%40oxlint%2Fmigrate)](https://npmx.dev/package/@oxlint/migrate)
 
 Generates a `.oxlintrc.json` from an existing ESLint flat config.
 
@@ -18,15 +18,15 @@ When no config file is provided, the script searches for the default ESLint conf
 
 ### Options
 
-| Options                     | Description                                                                                                                                 |
-| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
-| `--merge`                   | \* merge ESLint configuration with an existing .oxlintrc.json configuration                                                                 |
-| `--type-aware`              | Include type aware rules, which are supported with `oxlint --type-aware` and [oxlint-tsgolint](https://github.com/oxc-project/tsgolint)     |
-| `--with-nursery`            | Include oxlint rules which are currently under development                                                                                  |
-| `--js-plugins`              | \*\* Include ESLint plugins via `jsPlugins` key.                                                                                            |
-| `--details`                 | List rules that could not be migrated to oxlint                                                                                             |
-| `--output-file <file>`      | The oxlint configuration file where ESLint v9 rules will be written to, default: `.oxlintrc.json`                                           |
-| `--replace-eslint-comments` | Search in the project files for ESLint comments and replaces them with oxlint. Some ESLint comments are not supported and will be reported. |
+| Options                     | Description                                                                                                                                                                                                                 |
+| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `--merge`                   | \* merge ESLint configuration with an existing .oxlintrc.json configuration                                                                                                                                                 |
+| `--type-aware`              | Include type aware rules. These rules are supported with `oxlint --type-aware` and [oxlint-tsgolint](https://github.com/oxc-project/tsgolint). This will also enable the `typeAware` option in the generated configuration. |
+| `--with-nursery`            | Include oxlint rules which are currently under development                                                                                                                                                                  |
+| `--js-plugins [bool]`       | \*\* Include ESLint plugins via `jsPlugins` key (enabled by default). Use `--js-plugins=false` to disable.                                                                                                                  |
+| `--details`                 | List rules that could not be migrated to oxlint                                                                                                                                                                             |
+| `--output-file <file>`      | The oxlint configuration file where ESLint v9 rules will be written to, default: `.oxlintrc.json`                                                                                                                           |
+| `--replace-eslint-comments` | Search in the project files for ESLint comments and replaces them with oxlint. Some ESLint comments are not supported and will be reported.                                                                                 |
 
 \* WARNING: When some `categories` are enabled, this tools will enable more rules with the combination of `plugins`.
 Else we need to disable each rule `plugin/categories` combination, which is not covered by your ESLint configuration.
@@ -49,7 +49,7 @@ TypeScript configuration files, like `eslint.config.mts`, are supported in the f
 - **Deno and Bun**: TypeScript configuration files are natively supported.
 - **Node.js >=22.18.0**: TypeScript configuration files are supported natively with built-in type-stripping enabled by default.
 - **Node.js >=22.6.0**: TypeScript configuration files can be used by setting `NODE_OPTIONS=--experimental-strip-types`.
-- **Node.js <22.6.0**: TypeScript configuration files can be used by setting `NODE_OPTIONS=--import @oxc-node/core/register` and installing [@oxc-node/core](https://www.npmjs.com/package/@oxc-node/core) as a dev dependency.
+- **Node.js <22.6.0**: TypeScript configuration files can be used by setting `NODE_OPTIONS=--import @oxc-node/core/register` and installing [@oxc-node/core](https://npmx.dev/package/@oxc-node/core) as a dev dependency.
 
 If you attempt to use a TypeScript configuration file without the proper setup for your Node.js version, Node.js will throw an error when trying to import the file.
 
@@ -65,7 +65,7 @@ Here are some known caveats to be aware of:
 
 **`settings` field migration**
 
-The `settings` field (e.g. for setting the React version) is migrated for known oxlint-supported plugins: `jsx-a11y`, `next`, `react`, `jsdoc`, and `vitest`. By default, other settings keys are skipped since they aren't supported by oxlint. If using the `--js-plugins` flag, other settings keys will also be migrated in order to support JS Plugins.
+The `settings` field (e.g. for setting the React version) is migrated for known oxlint-supported plugins: `jsx-a11y`, `next`, `react`, `jsdoc`, and `vitest`. By default, other settings keys are also migrated to support JS Plugins. Use `--js-plugins=false` to skip migrating unknown settings keys.
 
 Note: Oxlint does not support `settings` in override configs. If your ESLint config has settings in configs with `files` patterns, those settings will be skipped and a warning will be shown.
 
@@ -73,7 +73,7 @@ Not all `settings` options are supported by oxlint, and so rule behavior in cert
 
 **Local ESLint Plugins imported via path are not migrated**
 
-The `--js-plugins` flag cannot migrate ESLint plugins from file paths in the same repo currently (e.g. if you have `../eslint-plugin-myplugin` in your `eslint.config.mjs`). You will need to copy them over into the `jsPlugins` manually. See [the JS Plugins docs]() for more info.
+JS plugin migration cannot migrate ESLint plugins from file paths in the same repo currently (e.g. if you have `../eslint-plugin-myplugin` in your `eslint.config.mjs`). You will need to copy them over into the `jsPlugins` manually. See [the JS Plugins docs]() for more info.
 
 **`globals` field with large number of values**
 

package/dist/bin/oxlint-migrate.mjs

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
-import { a as preFixForJsPlugins, f as buildUnsupportedRuleExplanations, m as rules_exports, p as nurseryRules, u as isOffValue } from "../settings-D8R7axmT.mjs";
-import main from "../src/index.mjs";
+import { a as nurseryRules, i as buildUnsupportedRuleExplanations, n as preFixForJsPlugins, o as rules_exports, r as isOffValue, t as main } from "../src-TZG8ybfH.mjs";
 import { program } from "commander";
 import { existsSync, readFileSync, renameSync, writeFileSync } from "node:fs";
 import path from "node:path";
@@ -8,7 +7,6 @@ import { pathToFileURL } from "node:url";
 import { parseSync } from "oxc-parser";
 import { glob } from "tinyglobby";
 import { writeFile } from "node:fs/promises";
-
 //#region bin/config-loader.ts
 const FLAT_CONFIG_FILENAMES = [
 	"eslint.config.js",
@@ -30,11 +28,9 @@ const loadESLintConfig = async (filePath) => {
 	if (!existsSync(filePath)) throw new Error(`eslint config file not found: ${filePath}`);
 	return import(url);
 };
-
 //#endregion
 //#region package.json
-var version = "1.50.0";
-
+var version = "1.52.0";
 //#endregion
 //#region src/walker/comments/replaceRuleDirectiveComment.ts
 const allRules = Object.values(rules_exports).flat();
@@ -69,7 +65,6 @@ function replaceRuleDirectiveComment(comment, type, options) {
 	}
 	return originalComment.replace(/eslint-/, "oxlint-");
 }
-
 //#endregion
 //#region src/walker/comments/index.ts
 function replaceComments(comment, type, options) {
@@ -82,7 +77,6 @@ function replaceComments(comment, type, options) {
 	}
 	return originalComment;
 }
-
 //#endregion
 //#region src/walker/partialSourceTextLoader.ts
 function extractLangAttribute(source) {
@@ -212,7 +206,6 @@ function partialAstroSourceTextLoader(sourceText) {
 	}));
 	return results;
 }
-
 //#endregion
 //#region src/walker/replaceCommentsInFile.ts
 const getComments = (absoluteFilePath, partialSourceText, options) => {
@@ -248,7 +241,6 @@ function replaceCommentsInFile(absoluteFilePath, fileContent, options) {
 	}
 	return fileContent;
 }
-
 //#endregion
 //#region src/walker/index.ts
 const walkAndReplaceProjectFiles = (projectFiles, readFileSync, writeFile, options) => {
@@ -260,7 +252,6 @@ const walkAndReplaceProjectFiles = (projectFiles, readFileSync, writeFile, optio
 		return writeFile(file, newSourceText);
 	}));
 };
-
 //#endregion
 //#region bin/project-loader.ts
 const getAllProjectFiles = () => {
@@ -270,7 +261,6 @@ const getAllProjectFiles = () => {
 		"!**/dist/**"
 	], { absolute: true });
 };
-
 //#endregion
 //#region src/reporter.ts
 var DefaultReporter = class {
@@ -306,7 +296,6 @@ var DefaultReporter = class {
 		return result;
 	}
 };
-
 //#endregion
 //#region bin/output-formatter.ts
 const unsupportedRuleExplanations = buildUnsupportedRuleExplanations();
@@ -357,7 +346,7 @@ function detectMissingFlags(byCategory, cliOptions) {
 	const missingFlags = [];
 	if (byCategory.nursery.length > 0 && !cliOptions.withNursery) missingFlags.push("--with-nursery");
 	if (byCategory["type-aware"].length > 0 && !cliOptions.typeAware) missingFlags.push("--type-aware");
-	if (byCategory["js-plugins"].length > 0 && !cliOptions.jsPlugins) missingFlags.push("--js-plugins");
+	if (byCategory["js-plugins"].length > 0 && !cliOptions.jsPlugins) missingFlags.push("--js-plugins=true");
 	return missingFlags;
 }
 /**
@@ -399,14 +388,24 @@ function formatMigrationOutput(data) {
 	}
 	return output;
 }
+function formatWarningsOutput(warnings) {
+	if (warnings.length === 0) return "";
+	let output = `⚠️  Warnings (${warnings.length}):\n`;
+	for (const warning of warnings) {
+		const [message, ...details] = warning.split("\n");
+		output += `   * ${message}\n`;
+		for (const detail of details.filter((line) => line.trim().length)) output += `     * ${detail}\n`;
+	}
+	return output.trimEnd();
+}
 function displayMigrationResult(outputMessage, warnings) {
 	console.log(outputMessage);
-	for (const warning of warnings) console.warn(warning);
+	if (warnings.length > 0) console.warn(formatWarningsOutput(warnings));
 }
-
 //#endregion
 //#region bin/oxlint-migrate.ts
 const cwd = process.cwd();
+const parseCliBoolean = (value) => value === "false" ? false : !!value;
 const getFileContent = (absoluteFilePath) => {
 	try {
 		return readFileSync(absoluteFilePath, "utf-8");
@@ -429,8 +428,9 @@ const countEnabledRules = (config) => {
 	}
 	return enabledRules.size;
 };
-program.name("oxlint-migrate").version(version).argument("[eslint-config]", "The path to the eslint v9 config file").option("--output-file <file>", "The oxlint configuration file where to eslint v9 rules will be written to", ".oxlintrc.json").option("--merge", "Merge eslint configuration with an existing .oxlintrc.json configuration", false).option("--with-nursery", "Include oxlint rules which are currently under development", false).option("--replace-eslint-comments", "Search in the project files for eslint comments and replaces them with oxlint. Some eslint comments are not supported and will be reported.").option("--type-aware", "Includes supported type-aware rules. Needs the same flag in `oxlint` to enable it.").option("--js-plugins", "Tries to convert unsupported oxlint plugins with `jsPlugins`.").option("--details", "List rules that could not be migrated to oxlint.", false).action(async (filePath) => {
+program.name("oxlint-migrate").version(version).argument("[eslint-config]", "The path to the eslint v9 config file").option("--output-file <file>", "The oxlint configuration file where to eslint v9 rules will be written to", ".oxlintrc.json").option("--merge", "Merge eslint configuration with an existing .oxlintrc.json configuration", false).option("--with-nursery", "Include oxlint rules which are currently under development", false).option("--replace-eslint-comments", "Search in the project files for eslint comments and replaces them with oxlint. Some eslint comments are not supported and will be reported.").option("--type-aware", "Includes supported type-aware rules. Needs the same flag in `oxlint` or the `typeAware` config option to enable it.").option("--js-plugins [bool]", "Tries to convert unsupported oxlint plugins with `jsPlugins`. Enabled by default; pass `--js-plugins=false` to disable.", true).option("--details", "List rules that could not be migrated to oxlint.", false).action(async (filePath) => {
 	const cliOptions = program.opts();
+	const jsPlugins = parseCliBoolean(cliOptions.jsPlugins);
 	const oxlintFilePath = path.join(cwd, cliOptions.outputFile);
 	const reporter = new DefaultReporter();
 	const options = {
@@ -438,7 +438,7 @@ program.name("oxlint-migrate").version(version).argument("[eslint-config]", "The
 		merge: !!cliOptions.merge,
 		withNursery: !!cliOptions.withNursery,
 		typeAware: !!cliOptions.typeAware,
-		jsPlugins: !!cliOptions.jsPlugins
+		jsPlugins
 	};
 	if (cliOptions.replaceEslintComments) {
 		await walkAndReplaceProjectFiles(await getAllProjectFiles(), (filePath) => getFileContent(filePath), (filePath, content) => writeFile(filePath, content, "utf-8"), options);
@@ -467,12 +467,11 @@ program.name("oxlint-migrate").version(version).argument("[eslint-config]", "The
 			withNursery: !!cliOptions.withNursery,
 			typeAware: !!cliOptions.typeAware,
 			details: !!cliOptions.details,
-			jsPlugins: !!cliOptions.jsPlugins
+			jsPlugins
 		},
 		eslintConfigPath: filePath
 	}), reporter.getWarnings());
 });
 program.parse();
-
 //#endregion
-export {  };
+export {};