@oxlint/migrate 1.43.0 → 1.46.0

package/README.md

@@ -44,31 +44,18 @@ Tested ESLint Plugins with `oxlint` can be found in this [Oxc Discussion](https:
 
 ### TypeScript ESLint Configuration Files
 
-For Deno and Bun, TypeScript configuration files, like `eslint.config.mts`, are natively supported.
-For Node.js, you must install [jiti](https://www.npmjs.com/package/jiti) as a dev dependency.
+TypeScript configuration files, like `eslint.config.mts`, are supported in the following environments:
 
-## Contributing
-
-### Generate rules
+- **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.
 
-Generates the rules from installed oxlint version
+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.
 
-```shell
-pnpm generate
-pnpm format
-```
-
-### Unit + Integration Test
-
-```shell
-pnpm vitest
-```
-
-### Manual Testing
+## Contributing
 
-```shell
-pnpm manual-test
-```
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to contribute to this project.
 
 ## Caveats
 
@@ -76,9 +63,11 @@ The migration tool has been tested to work quite well for simple ESLint flat con
 
 Here are some known caveats to be aware of:
 
-**`settings` field not migrated**
+**`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 not migrated to the oxlint config yet. You may need to copy it over manually if you have any settings specified.
+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.
 
 Not all `settings` options are supported by oxlint, and so rule behavior in certain edge-cases may differ. See [the Settings docs](https://oxc.rs/docs/guide/usage/linter/config-file-reference.html#settings) for more info.
 

package/dist/bin/oxlint-migrate.mjs

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
-import { a as rules_exports, i as nurseryRules, n as preFixForJsPlugins, r as isOffValue, t as src_default } from "../src-BMWXAQvA.mjs";
+import { a as preFixForJsPlugins, f as nurseryRules, p as rules_exports, u as isOffValue } from "../settings-C8UlaScv.mjs";
+import main from "../src/index.mjs";
 import { program } from "commander";
 import { existsSync, readFileSync, renameSync, writeFileSync } from "node:fs";
 import path from "node:path";
@@ -27,20 +28,12 @@ const loadESLintConfig = async (filePath) => {
 	if (filePath.endsWith("json")) throw new Error(`json format is not supported. @oxlint/migrate only supports the eslint flat configuration`);
 	let url = pathToFileURL(filePath).toString();
 	if (!existsSync(filePath)) throw new Error(`eslint config file not found: ${filePath}`);
-	if ("Bun" in globalThis || "Deno" in globalThis) return import(url);
-	if (filePath.endsWith(".ts") || filePath.endsWith(".mts") || filePath.endsWith(".cts")) {
-		const { createJiti } = await import("jiti");
-		return createJiti(filePath, {
-			interopDefault: false,
-			moduleCache: false
-		}).import(url);
-	}
 	return import(url);
 };
 
 //#endregion
 //#region package.json
-var version = "1.43.0";
+var version = "1.46.0";
 
 //#endregion
 //#region src/walker/comments/replaceRuleDirectiveComment.ts
@@ -449,7 +442,7 @@ program.name("oxlint-migrate").version(version).argument("[eslint-config]", "The
 		encoding: "utf8",
 		flag: "r"
 	}));
-	const oxlintConfig = "default" in eslintConfigs ? await src_default(eslintConfigs.default, config, options) : await src_default(eslintConfigs, config, options);
+	const oxlintConfig = "default" in eslintConfigs ? await main(eslintConfigs.default, config, options) : await main(eslintConfigs, config, options);
 	if (existsSync(oxlintFilePath)) renameSync(oxlintFilePath, `${oxlintFilePath}.bak`);
 	writeFileSync(oxlintFilePath, JSON.stringify(oxlintConfig, null, 2));
 	const enabledRulesCount = countEnabledRules(oxlintConfig);

package/dist/{src-BMWXAQvA.mjs → settings-C8UlaScv.mjs}

@@ -1,8 +1,8 @@
 import globals from "globals";
 
-//#region rolldown:runtime
+//#region \0rolldown/runtime.js
 var __defProp = Object.defineProperty;
-var __exportAll = (all, symbols) => {
+var __exportAll = (all, no_symbols) => {
 	let target = {};
 	for (var name in all) {
 		__defProp(target, name, {
@@ -10,7 +10,7 @@ var __exportAll = (all, symbols) => {
 			enumerable: true
 		});
 	}
-	if (symbols) {
+	if (!no_symbols) {
 		__defProp(target, Symbol.toStringTag, { value: "Module" });
 	}
 	return target;
@@ -427,6 +427,7 @@ const styleRules = [
 	"@typescript-eslint/ban-tslint-comment",
 	"@typescript-eslint/consistent-generic-constructors",
 	"@typescript-eslint/consistent-indexed-object-style",
+	"@typescript-eslint/consistent-type-assertions",
 	"@typescript-eslint/consistent-type-definitions",
 	"@typescript-eslint/consistent-type-imports",
 	"@typescript-eslint/no-empty-interface",
@@ -471,6 +472,7 @@ const styleRules = [
 	"unicorn/prefer-string-raw",
 	"unicorn/prefer-string-trim-start-end",
 	"unicorn/prefer-structured-clone",
+	"unicorn/relative-url-style",
 	"unicorn/require-array-join-separator",
 	"unicorn/require-module-attributes",
 	"unicorn/switch-case-braces",
@@ -482,6 +484,7 @@ const styleRules = [
 	"vitest/prefer-called-once",
 	"vitest/prefer-called-times",
 	"vitest/prefer-describe-function-title",
+	"vitest/prefer-expect-type-of",
 	"vitest/prefer-to-be-falsy",
 	"vitest/prefer-to-be-object",
 	"vitest/prefer-to-be-truthy",
@@ -605,7 +608,6 @@ const restrictionRules = [
 	"no-empty",
 	"no-empty-function",
 	"no-eq-null",
-	"no-iterator",
 	"no-param-reassign",
 	"no-plusplus",
 	"no-proto",
@@ -717,7 +719,9 @@ const correctnessRules = [
 	"no-import-assign",
 	"no-invalid-regexp",
 	"no-irregular-whitespace",
+	"no-iterator",
 	"no-loss-of-precision",
+	"no-misleading-character-class",
 	"no-new-native-nonconstructor",
 	"no-nonoctal-decimal-escape",
 	"no-obj-calls",
@@ -903,7 +907,6 @@ const correctnessRules = [
 ];
 const nurseryRules = [
 	"getter-return",
-	"no-misleading-character-class",
 	"no-undef",
 	"no-unreachable",
 	"import/export",
@@ -1533,59 +1536,105 @@ function processConfigFiles(files, reporter) {
 }
 
 //#endregion
-//#region src/index.ts
-const buildConfig = (configs, oxlintConfig, options) => {
-	if (oxlintConfig === void 0) if (options?.merge) oxlintConfig = {
-		plugins: [
-			"oxc",
-			"typescript",
-			"unicorn",
-			"react"
-		],
-		categories: { correctness: "warn" }
-	};
-	else oxlintConfig = {
-		$schema: "./node_modules/oxlint/configuration_schema.json",
-		plugins: [],
-		categories: { correctness: "off" }
-	};
-	if (oxlintConfig.$schema === void 0 && options?.merge) oxlintConfig.$schema = "./node_modules/oxlint/configuration_schema.json";
-	if (oxlintConfig.env?.builtin === void 0) {
-		if (oxlintConfig.env === void 0) oxlintConfig.env = {};
-		oxlintConfig.env.builtin = true;
-	}
-	const overrides = options?.merge ? oxlintConfig.overrides ?? [] : [];
-	for (const config of configs) {
-		if (config.name?.startsWith("oxlint/")) continue;
-		let targetConfig;
-		if (config.files === void 0) targetConfig = oxlintConfig;
-		else {
-			const validFiles = processConfigFiles(config.files, options?.reporter);
-			if (validFiles.length === 0) continue;
-			targetConfig = { files: validFiles };
-			const [push, result] = detectSameOverride(oxlintConfig, targetConfig);
-			if (push) overrides.push(result);
+//#region src/settings.ts
+const OXLINT_SUPPORTED_SETTINGS_KEYS = [
+	"jsx-a11y",
+	"next",
+	"react",
+	"jsdoc",
+	"vitest"
+];
+const UNSUPPORTED_SETTINGS_SUB_KEYS = {
+	react: ["pragma", "fragment"],
+	vitest: ["vitestImports"]
+};
+/**
+* Deep merge source into target, combining nested objects rather than replacing them.
+* Arrays are replaced, not merged. Mutates `target` in place.
+*/
+const deepMerge = (target, source) => {
+	for (const [key, value] of Object.entries(source)) if (value !== null && typeof value === "object" && !Array.isArray(value) && key in target && target[key] !== null && typeof target[key] === "object" && !Array.isArray(target[key])) deepMerge(target[key], value);
+	else target[key] = value;
+};
+/**
+* Check if a settings key is known to be supported by oxlint.
+*/
+const isSupportedSettingsKey = (key) => {
+	return OXLINT_SUPPORTED_SETTINGS_KEYS.includes(key);
+};
+/**
+* Transform ESLint settings to oxlint settings.
+*
+* Only processes settings for the base config (not overrides) since oxlint
+* does not support settings in overrides.
+*
+* Only known oxlint-supported settings keys are migrated:
+* - jsx-a11y
+* - next
+* - react
+* - jsdoc
+* - vitest
+*
+* @param eslintConfig - The source ESLint config
+* @param targetConfig - The target oxlint config (must be base config, not override)
+* @param options - Migration options
+*/
+const transformSettings = (eslintConfig, targetConfig, options) => {
+	if (eslintConfig.settings === void 0 || eslintConfig.settings === null || Object.keys(eslintConfig.settings).length === 0) return;
+	const eslintSettings = eslintConfig.settings;
+	const filteredSettings = {};
+	const skippedKeys = [];
+	for (const [key, value] of Object.entries(eslintSettings)) {
+		if (value === null || typeof value !== "object") {
+			skippedKeys.push(key);
+			continue;
+		}
+		if (!options?.jsPlugins && !isSupportedSettingsKey(key)) {
+			skippedKeys.push(key);
+			continue;
 		}
-		transformIgnorePatterns(config, targetConfig, options);
-		transformRuleEntry(config, targetConfig, config.files !== void 0 ? oxlintConfig : void 0, options);
-		transformEnvAndGlobals(config, targetConfig, options);
-		if ("files" in targetConfig) {
-			detectNeededRulesPlugins(targetConfig);
-			detectEnvironmentByGlobals(targetConfig);
-			cleanUpOxlintConfig(targetConfig);
+		if (key === "import" || key.startsWith("import/")) {
+			skippedKeys.push(key);
+			continue;
 		}
+		let settingsValue = value;
+		if (key === "react" && settingsValue.version === "detect") {
+			options?.reporter?.addWarning("react.version \"detect\" is not supported by oxlint. Please specify an explicit version (e.g., \"18.2.0\") in your oxlint config.");
+			const { version: _, ...restReactSettings } = settingsValue;
+			settingsValue = restReactSettings;
+		}
+		const unsupportedSubKeys = UNSUPPORTED_SETTINGS_SUB_KEYS[key];
+		if (unsupportedSubKeys !== void 0) {
+			const strippedKeys = [];
+			for (const subKey of unsupportedSubKeys) if (subKey in settingsValue) {
+				strippedKeys.push(`${key}.${subKey}`);
+				const { [subKey]: _, ...rest } = settingsValue;
+				settingsValue = rest;
+			}
+			if (strippedKeys.length > 0) options?.reporter?.addWarning(`Settings not migrated (not supported by oxlint): ${strippedKeys.join(", ")}.`);
+		}
+		if (Object.keys(settingsValue).length === 0) continue;
+		filteredSettings[key] = settingsValue;
 	}
-	oxlintConfig.overrides = overrides;
-	detectNeededRulesPlugins(oxlintConfig);
-	detectEnvironmentByGlobals(oxlintConfig);
-	cleanUpOxlintConfig(oxlintConfig);
-	return oxlintConfig;
+	if (skippedKeys.length > 0) options?.reporter?.addWarning(`Settings not migrated (not supported by oxlint): ${skippedKeys.join(", ")}.`);
+	if (Object.keys(filteredSettings).length === 0) return;
+	if (targetConfig.settings === void 0) targetConfig.settings = {};
+	if (options?.merge) deepMerge(targetConfig.settings, filteredSettings);
+	else Object.assign(targetConfig.settings, filteredSettings);
 };
-const main = async (configs, oxlintConfig, options) => {
-	const resolved = await Promise.resolve(fixForJsPlugins(configs));
-	return buildConfig(Array.isArray(resolved) ? resolved : [resolved], oxlintConfig, options);
+/**
+* Warn when settings are found in an override config, since oxlint does not
+* support settings in overrides.
+*
+* @param eslintConfig - The ESLint config being processed
+* @param options - Migration options
+*/
+const warnSettingsInOverride = (eslintConfig, options) => {
+	if (eslintConfig.settings !== void 0 && eslintConfig.settings !== null && Object.keys(eslintConfig.settings).length > 0) {
+		const settingsKeys = Object.keys(eslintConfig.settings).join(", ");
+		options?.reporter?.addWarning(`Settings found in config with 'files' pattern (${settingsKeys}). Oxlint does not support settings in overrides, these settings will be skipped.`);
+	}
 };
-var src_default = main;
 
 //#endregion
-export { rules_exports as a, nurseryRules as i, preFixForJsPlugins as n, isOffValue as r, src_default as t };
+export { preFixForJsPlugins as a, cleanUpOxlintConfig as c, transformRuleEntry as d, nurseryRules as f, transformEnvAndGlobals as h, fixForJsPlugins as i, detectNeededRulesPlugins as l, detectEnvironmentByGlobals as m, warnSettingsInOverride as n, detectSameOverride as o, rules_exports as p, processConfigFiles as r, transformIgnorePatterns as s, transformSettings as t, isOffValue as u };

package/dist/src/index.d.mts

@@ -2671,6 +2671,8 @@ type OxlintConfigJsPlugins = string[];
 type OxlintConfigCategories = Partial<Record<Category, unknown>>;
 type OxlintConfigEnv = Record<string, boolean>;
 type OxlintConfigIgnorePatterns = string[];
+type OxlintSupportedSettingsKey = 'jsx-a11y' | 'next' | 'react' | 'jsdoc' | 'vitest';
+type OxlintSettings = { [K in OxlintSupportedSettingsKey]?: Record<string, unknown> } & Record<string, Record<string, unknown> | undefined>;
 type OxlintConfigOverride = {
   files: string[];
   env?: OxlintConfigEnv;
@@ -2690,6 +2692,7 @@ type OxlintConfig = {
   rules?: Partial<Linter.RulesRecord>;
   overrides?: OxlintConfigOverride[];
   ignorePatterns?: OxlintConfigIgnorePatterns;
+  settings?: OxlintSettings;
 };
 type RuleSkippedCategory = 'nursery' | 'type-aware' | 'unsupported' | 'js-plugins';
 type SkippedCategoryGroup = Record<RuleSkippedCategory, string[]>;

package/dist/src/index.mjs

@@ -1,3 +1,59 @@
-import { t as src_default } from "../src-BMWXAQvA.mjs";
+import { c as cleanUpOxlintConfig, d as transformRuleEntry, h as transformEnvAndGlobals, i as fixForJsPlugins, l as detectNeededRulesPlugins, m as detectEnvironmentByGlobals, n as warnSettingsInOverride, o as detectSameOverride, r as processConfigFiles, s as transformIgnorePatterns, t as transformSettings } from "../settings-C8UlaScv.mjs";
 
-export { src_default as default };
+//#region src/index.ts
+const buildConfig = (configs, oxlintConfig, options) => {
+	if (oxlintConfig === void 0) if (options?.merge) oxlintConfig = {
+		plugins: [
+			"oxc",
+			"typescript",
+			"unicorn",
+			"react"
+		],
+		categories: { correctness: "warn" }
+	};
+	else oxlintConfig = {
+		$schema: "./node_modules/oxlint/configuration_schema.json",
+		plugins: [],
+		categories: { correctness: "off" }
+	};
+	if (oxlintConfig.$schema === void 0 && options?.merge) oxlintConfig.$schema = "./node_modules/oxlint/configuration_schema.json";
+	if (oxlintConfig.env?.builtin === void 0) {
+		if (oxlintConfig.env === void 0) oxlintConfig.env = {};
+		oxlintConfig.env.builtin = true;
+	}
+	const overrides = options?.merge ? oxlintConfig.overrides ?? [] : [];
+	for (const config of configs) {
+		if (config.name?.startsWith("oxlint/")) continue;
+		let targetConfig;
+		if (config.files === void 0) targetConfig = oxlintConfig;
+		else {
+			const validFiles = processConfigFiles(config.files, options?.reporter);
+			if (validFiles.length === 0) continue;
+			targetConfig = { files: validFiles };
+			const [push, result] = detectSameOverride(oxlintConfig, targetConfig);
+			if (push) overrides.push(result);
+		}
+		transformIgnorePatterns(config, targetConfig, options);
+		transformRuleEntry(config, targetConfig, config.files !== void 0 ? oxlintConfig : void 0, options);
+		transformEnvAndGlobals(config, targetConfig, options);
+		if (config.files === void 0) transformSettings(config, oxlintConfig, options);
+		else warnSettingsInOverride(config, options);
+		if ("files" in targetConfig) {
+			detectNeededRulesPlugins(targetConfig);
+			detectEnvironmentByGlobals(targetConfig);
+			cleanUpOxlintConfig(targetConfig);
+		}
+	}
+	oxlintConfig.overrides = overrides;
+	detectNeededRulesPlugins(oxlintConfig);
+	detectEnvironmentByGlobals(oxlintConfig);
+	cleanUpOxlintConfig(oxlintConfig);
+	return oxlintConfig;
+};
+const main = async (configs, oxlintConfig, options) => {
+	const resolved = await Promise.resolve(fixForJsPlugins(configs));
+	return buildConfig(Array.isArray(resolved) ? resolved : [resolved], oxlintConfig, options);
+};
+
+//#endregion
+export { main as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oxlint/migrate",
-  "version": "1.43.0",
+  "version": "1.46.0",
   "description": "Generates a `.oxlintrc.json` from a existing eslint flat config",
   "keywords": [
     "eslint",
@@ -68,24 +68,20 @@
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^7.0.1",
     "eslint-plugin-react-perf": "^3.3.3",
-    "eslint-plugin-react-refresh": "^0.4.26",
+    "eslint-plugin-react-refresh": "^0.5.0",
     "eslint-plugin-regexp": "^3.0.0",
     "eslint-plugin-tsdoc": "^0.5.0",
     "eslint-plugin-unicorn": "^62.0.0",
     "husky": "^9.1.7",
-    "jiti": "^2.4.2",
     "lint-staged": "^16.1.2",
     "next": "^16.0.0",
     "oxfmt": "^0.28.0",
-    "oxlint": "^1.43.0",
+    "oxlint": "^1.46.0",
     "oxlint-tsgolint": "^0.11.3",
     "tsdown": "^0.20.0",
     "typescript-eslint": "^8.35.0",
     "vitest": "^4.0.0"
   },
-  "peerDependencies": {
-    "jiti": "*"
-  },
   "lint-staged": {
     "*": "oxfmt --no-error-on-unmatched-pattern"
   },