@oxlint/migrate 0.0.3 → 0.0.5

package/README.md

@@ -1,14 +1,21 @@
 # oxlint-migrate
 
-Generates a `.oxlintrc.json` from a existing eslint v9 configuration
+![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)
+
+Generates a `.oxlintrc.json` from a existing eslint flat config.
 
 🚧 Still under development
 
 ## Usage
 
-`npx oxlint-migrate <optional-eslint-v9-config-path>`
+```shell
+pnpm install @oxlint/migrate
+npx oxlint-migrate <optional-eslint-flat-config-path>
+```
 
-When no config file provided, we look at the default eslint config filenames in the current directory.
+When no config file provided, the script searches for the default eslint config filenames in the current directory.
 
 ### User Flow
 

package/dist/bin/oxlint-migrate.mjs

@@ -5,26 +5,27 @@ import { existsSync, renameSync, writeFileSync } from "fs";
 import main from "../src/index.mjs";
 import path from "path";
 import packageJson from "../package.json.mjs";
-program.name("oxlint-migrate").version(packageJson.version).argument("<eslint-config>", "The path to the eslint v9 config file", "");
-program.parse();
-let [filePath] = program.args;
-let cwd = process.cwd();
-if (filePath === "") {
-  filePath = getAutodetectedEslintConfigName(cwd) ?? "";
-  if (filePath === "") {
-    program.error(`could not autodetect eslint config file`);
+import { pathToFileURL } from "node:url";
+program.name("oxlint-migrate").version(packageJson.version).argument("[eslint-config]", "The path to the eslint v9 config file").action(async (filePath) => {
+  let cwd = process.cwd();
+  if (filePath === void 0) {
+    filePath = getAutodetectedEslintConfigName(cwd);
+    if (filePath === void 0) {
+      program.error(`could not autodetect eslint config file`);
+    }
+  } else {
+    filePath = path.join(cwd, filePath);
   }
-} else {
-  filePath = path.join(cwd, filePath);
-}
-if (!existsSync(filePath)) {
-  program.error(`eslint config file not found: ${filePath}`);
-} else {
-  const eslintConfigs = await import(filePath);
-  const oxlintConfig = "default" in eslintConfigs ? await main(eslintConfigs.default, console.warn) : await main(eslintConfigs, console.warn);
-  const oxlintFilePath = path.join(cwd, ".oxlintrc.json");
-  if (existsSync(oxlintFilePath)) {
-    renameSync(oxlintFilePath, `${oxlintFilePath}.bak`);
+  if (!existsSync(filePath)) {
+    program.error(`eslint config file not found: ${filePath}`);
+  } else {
+    const eslintConfigs = await import(pathToFileURL(filePath).toString());
+    const oxlintConfig = "default" in eslintConfigs ? await main(eslintConfigs.default, console.warn) : await main(eslintConfigs, console.warn);
+    const oxlintFilePath = path.join(cwd, ".oxlintrc.json");
+    if (existsSync(oxlintFilePath)) {
+      renameSync(oxlintFilePath, `${oxlintFilePath}.bak`);
+    }
+    writeFileSync(oxlintFilePath, JSON.stringify(oxlintConfig, null, 2));
   }
-  writeFileSync(oxlintFilePath, JSON.stringify(oxlintConfig, null, 2));
-}
+});
+program.parse();

package/dist/package.json.mjs

@@ -1,4 +1,4 @@
-const version = "0.0.3";
+const version = "0.0.5";
 const packageJson = {
   version
 };

package/dist/src/cleanup.mjs

@@ -1,4 +1,5 @@
-import { removeGlobalsWithAreCoveredByEnv, transformBoolGlobalToString, ES_VERSIONS } from "./env_globals.mjs";
+import { removeGlobalsWithAreCoveredByEnv, transformBoolGlobalToString, ES_VERSIONS, cleanUpUselessOverridesEnv } from "./env_globals.mjs";
+import { cleanUpUselessOverridesRules, cleanUpUselessOverridesPlugins } from "./plugins_rules.mjs";
 const isEqualDeep = (a, b) => {
   if (a === b) {
     return true;
@@ -11,8 +12,6 @@ const isEqualDeep = (a, b) => {
 const TS_ESLINT_DEFAULT_OVERRIDE = {
   files: ["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.cts"],
   rules: {
-    "constructor-super": "off",
-    "getter-return": "off",
     "no-class-assign": "off",
     "no-const-assign": "off",
     "no-dupe-class-members": "off",
@@ -24,13 +23,12 @@ const TS_ESLINT_DEFAULT_OVERRIDE = {
     "no-redeclare": "off",
     "no-setter-return": "off",
     "no-this-before-super": "off",
-    "no-undef": "off",
-    "no-unreachable": "off",
     "no-unsafe-negation": "off",
     "no-var": "error",
     "prefer-rest-params": "error",
     "prefer-spread": "error"
-  }
+  },
+  plugins: []
 };
 const cleanUpDefaultTypeScriptOverridesForEslint = (config) => {
   if (config.overrides === void 0) {
@@ -44,47 +42,28 @@ const cleanUpDefaultTypeScriptOverridesForEslint = (config) => {
     }
   }
   indexesToDelete.forEach((index) => delete config.overrides[index]);
+  config.overrides = config.overrides.filter(
+    (overrides) => Object.keys(overrides).length > 0
+  );
   if (Object.keys(config.overrides).length === 0) {
     delete config.overrides;
   }
 };
 const cleanUpUselessOverridesEntries = (config) => {
+  cleanUpUselessOverridesRules(config);
+  cleanUpUselessOverridesPlugins(config);
+  cleanUpUselessOverridesEnv(config);
   if (config.overrides === void 0) {
     return;
   }
+  for (const overrideIndex in config.overrides) {
+    if (Object.keys(config.overrides[overrideIndex]).length === 1) {
+      delete config.overrides[overrideIndex];
+    }
+  }
   config.overrides = config.overrides.filter(
     (overrides) => Object.keys(overrides).length > 0
   );
-  if (config.plugins !== void 0) {
-    for (const override of config.overrides) {
-      if (override.plugins === void 0) {
-        continue;
-      }
-      override.plugins = override.plugins.filter(
-        (overridePlugin) => !config.plugins.includes(overridePlugin)
-      );
-      if (override.plugins.length === 0) {
-        delete override.plugins;
-      }
-    }
-  }
-  if (config.env !== void 0) {
-    for (const override of config.overrides) {
-      if (override.env === void 0) {
-        continue;
-      }
-      for (const [overrideEnv, overrideEnvConfig] of Object.entries(
-        override.env
-      )) {
-        if (overrideEnv in config.env && config.env[overrideEnv] === overrideEnvConfig) {
-          delete override.env[overrideEnv];
-        }
-      }
-      if (Object.keys(override.env).length === 0) {
-        delete override.env;
-      }
-    }
-  }
   if (config.overrides.length === 0) {
     delete config.overrides;
   }
@@ -108,17 +87,7 @@ const cleanUpOxlintConfig = (config) => {
       }
     }
   }
-  if (config.rules !== void 0 && Object.keys(config.rules).length === 0) {
-    delete config.rules;
-  }
-  if ("files" in config) {
-    if (config.plugins !== void 0 && Object.keys(config.plugins).length === 0) {
-      delete config.plugins;
-    }
-    if (Object.keys(config).length === 1) {
-      delete config.files;
-    }
-  } else {
+  if (!("files" in config)) {
     cleanUpDefaultTypeScriptOverridesForEslint(config);
     cleanUpUselessOverridesEntries(config);
   }

package/dist/src/env_globals.d.ts

@@ -1,7 +1,8 @@
-import { OxlintConfigOrOverride, Reporter } from './types.js';
+import { OxlintConfig, OxlintConfigOrOverride, Reporter } from './types.js';
 import { Linter } from 'eslint';
 export declare const ES_VERSIONS: number[];
 export declare const removeGlobalsWithAreCoveredByEnv: (config: OxlintConfigOrOverride) => void;
 export declare const transformBoolGlobalToString: (config: OxlintConfigOrOverride) => void;
 export declare const detectEnvironmentByGlobals: (config: OxlintConfigOrOverride) => void;
 export declare const transformEnvAndGlobals: (eslintConfig: Linter.Config, targetConfig: OxlintConfigOrOverride, reporter?: Reporter) => void;
+export declare const cleanUpUselessOverridesEnv: (config: OxlintConfig) => void;

package/dist/src/env_globals.mjs

@@ -67,10 +67,10 @@ const transformBoolGlobalToString = (config) => {
     return;
   }
   for (const [entry, value] of Object.entries(config.globals)) {
-    if (value === false) {
+    if (value === false || value === "readable") {
       config.globals[entry] = "readonly";
-    } else if (value === true) {
-      config.globals[entry] = "writable";
+    } else if (value === true || value === "writable") {
+      config.globals[entry] = "writeable";
     }
   }
 };
@@ -129,8 +129,29 @@ const transformEnvAndGlobals = (eslintConfig, targetConfig, reporter) => {
     }
   }
 };
+const cleanUpUselessOverridesEnv = (config) => {
+  if (config.env === void 0 || config.overrides === void 0) {
+    return;
+  }
+  for (const override of config.overrides) {
+    if (override.env === void 0) {
+      continue;
+    }
+    for (const [overrideEnv, overrideEnvConfig] of Object.entries(
+      override.env
+    )) {
+      if (overrideEnv in config.env && config.env[overrideEnv] === overrideEnvConfig) {
+        delete override.env[overrideEnv];
+      }
+    }
+    if (Object.keys(override.env).length === 0) {
+      delete override.env;
+    }
+  }
+};
 export {
   ES_VERSIONS,
+  cleanUpUselessOverridesEnv,
   detectEnvironmentByGlobals,
   removeGlobalsWithAreCoveredByEnv,
   transformBoolGlobalToString,

package/dist/src/generated/rules.d.ts

@@ -1,2 +1,3 @@
 declare const rules: string[];
+export declare const nurseryRules: string[];
 export default rules;

package/dist/src/generated/rules.mjs

@@ -6,9 +6,11 @@ const rules = [
   "default-param-last",
   "eqeqeq",
   "for-direction",
+  "func-style",
   "func-names",
   "getter-return",
   "guard-for-in",
+  "init-declarations",
   "max-classes-per-file",
   "max-lines",
   "max-params",
@@ -479,6 +481,7 @@ const rules = [
   "vitest/prefer-to-be-truthy",
   "vitest/require-local-test-context-for-concurrent-snapshots",
   "@typescript-eslint/default-param-last",
+  "@typescript-eslint/init-declarations",
   "@typescript-eslint/max-params",
   "@typescript-eslint/no-restricted-imports",
   "@typescript-eslint/no-array-constructor",
@@ -507,6 +510,7 @@ const rules = [
   "vitest/no-interpolation-in-snapshots",
   "vitest/no-restricted-jest-methods",
   "vitest/no-restricted-matchers",
+  "vitest/no-standalone-expect",
   "vitest/no-test-prefixes",
   "vitest/no-test-return-statement",
   "vitest/prefer-each",
@@ -515,6 +519,7 @@ const rules = [
   "vitest/prefer-expect-resolves",
   "vitest/prefer-hooks-in-order",
   "vitest/prefer-hooks-on-top",
+  "vitest/prefer-lowercase-title",
   "vitest/prefer-mock-promise-shorthand",
   "vitest/prefer-strict-equal",
   "vitest/prefer-to-have-length",
@@ -524,6 +529,22 @@ const rules = [
   "vitest/valid-describe-callback",
   "vitest/valid-expect"
 ];
+const nurseryRules = [
+  "constructor-super",
+  "getter-return",
+  "no-restricted-imports",
+  "no-undef",
+  "no-unreachable",
+  "import/export",
+  "import/named",
+  "oxc/no-map-spread",
+  "promise/no-return-in-finally",
+  "react-hooks/exhaustive-deps",
+  "react/require-render-return",
+  "@typescript-eslint/consistent-type-imports",
+  "@typescript-eslint/no-restricted-imports"
+];
 export {
-  rules as default
+  rules as default,
+  nurseryRules
 };

package/dist/src/ignorePatterns.d.ts

@@ -1,3 +1,3 @@
 import { Linter } from 'eslint';
 import { OxlintConfigOrOverride, Reporter } from './types.js';
-export declare const transformIgnorePatterns: (eslintConfig: Linter.Config, targetConfig: OxlintConfigOrOverride, reporter: Reporter) => void;
+export declare const transformIgnorePatterns: (eslintConfig: Linter.Config, targetConfig: OxlintConfigOrOverride, reporter?: Reporter) => void;

package/dist/src/index.mjs

@@ -46,7 +46,7 @@ const buildConfig = (configs, reporter) => {
   cleanUpOxlintConfig(oxlintConfig);
   return oxlintConfig;
 };
-const main = async (configs, reporter = void 0) => {
+const main = async (configs, reporter) => {
   const resolved = await Promise.resolve(configs);
   return Array.isArray(resolved) ? buildConfig(resolved, reporter) : buildConfig([resolved], reporter);
 };

package/dist/src/plugin_rules.test.d.ts

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

package/dist/src/plugins_rules.d.ts

@@ -1,4 +1,6 @@
 import { Linter } from 'eslint';
-import { OxlintConfigOrOverride, Reporter } from './types.js';
-export declare const transformRuleEntry: (eslintConfig: Linter.Config, targetConfig: OxlintConfigOrOverride, reporter: Reporter) => void;
+import { OxlintConfig, OxlintConfigOrOverride, Reporter } from './types.js';
+export declare const transformRuleEntry: (eslintConfig: Linter.Config, targetConfig: OxlintConfigOrOverride, reporter?: Reporter) => void;
 export declare const detectNeededRulesPlugins: (targetConfig: OxlintConfigOrOverride, reporter?: Reporter) => void;
+export declare const cleanUpUselessOverridesPlugins: (config: OxlintConfig) => void;
+export declare const cleanUpUselessOverridesRules: (config: OxlintConfig) => void;

package/dist/src/plugins_rules.mjs

@@ -1,4 +1,4 @@
-import rules from "./generated/rules.mjs";
+import rules, { nurseryRules } from "./generated/rules.mjs";
 import { rulesPrefixesForPlugins } from "./constants.mjs";
 const isValueInSet = (value, validSet) => validSet.includes(value) || Array.isArray(value) && validSet.includes(value[0]);
 const isActiveValue = (value) => isValueInSet(value, ["error", "warn", 1, 2]);
@@ -11,6 +11,10 @@ const transformRuleEntry = (eslintConfig, targetConfig, reporter) => {
   }
   for (const [rule, config] of Object.entries(eslintConfig.rules)) {
     if (rules.includes(rule)) {
+      if (nurseryRules.includes(rule)) {
+        reporter !== void 0 && reporter(`unsupported rule, but in development: ${rule}`);
+        continue;
+      }
       targetConfig.rules[rule] = config;
     } else {
       if (isActiveValue(config)) {
@@ -44,7 +48,45 @@ const detectNeededRulesPlugins = (targetConfig, reporter) => {
     }
   }
 };
+const cleanUpUselessOverridesPlugins = (config) => {
+  if (config.overrides === void 0) {
+    return;
+  }
+  if (config.plugins !== void 0) {
+    for (const override of config.overrides) {
+      if (override.plugins === void 0) {
+        continue;
+      }
+      override.plugins = override.plugins.filter(
+        (overridePlugin) => !config.plugins.includes(overridePlugin)
+      );
+      if (override.plugins.length === 0) {
+        delete override.plugins;
+      }
+    }
+  }
+};
+const cleanUpUselessOverridesRules = (config) => {
+  if (config.rules === void 0 || config.overrides === void 0) {
+    return;
+  }
+  for (const override of config.overrides) {
+    if (override.rules === void 0) {
+      continue;
+    }
+    for (const [rule, settings] of Object.entries(override.rules)) {
+      if (config.rules[rule] === settings) {
+        delete override.rules[rule];
+      }
+    }
+    if (Object.keys(override.rules).length === 0) {
+      delete override.rules;
+    }
+  }
+};
 export {
+  cleanUpUselessOverridesPlugins,
+  cleanUpUselessOverridesRules,
   detectNeededRulesPlugins,
   transformRuleEntry
 };

package/dist/src/types.d.ts

@@ -21,5 +21,5 @@ export type OxlintConfig = {
     ignorePatterns?: OxlintConfigIgnorePatterns;
 };
 export type OxlintConfigOrOverride = OxlintConfig | OxlintConfigOverride;
-export type Reporter = ((warning: string) => void) | undefined;
+export type Reporter = (warning: string) => void;
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oxlint/migrate",
-  "version": "0.0.3",
-  "description": "Generates a `.oxlintrc.json` from a existing eslint v9 configuration",
+  "version": "0.0.5",
+  "description": "Generates a `.oxlintrc.json` from a existing eslint flat config",
   "type": "module",
   "bin": {
     "oxlint-migrate": "./dist/bin/oxlint-migrate.mjs"
@@ -17,7 +17,7 @@
     "type-check": "tsc --noEmit",
     "test": "vitest",
     "build": "vite build",
-    "manual-test": "pnpm build; chmod +x dist/bin/oxlint-migrate.mjs; npx . integration_test/projects/autoprefixer.eslint.config.mjs"
+    "manual-test": "pnpm build; chmod +x dist/bin/oxlint-migrate.mjs; npx ."
   },
   "files": [
     "dist/*",
@@ -33,21 +33,24 @@
   "license": "MIT",
   "devDependencies": {
     "@antfu/eslint-config": "^4.2.0",
-    "@logux/eslint-config": "^53.5.1",
+    "@eslint/js": "^9.20.0",
+    "@logux/eslint-config": "^54.0.0",
     "@oxc-node/core": "^0.0.19",
-    "@stylistic/eslint-plugin-ts": "^3.1.0",
+    "@stylistic/eslint-plugin-ts": "^4.0.0",
     "@types/eslint-config-prettier": "^6.11.3",
     "@types/node": "^22.13.4",
     "@vitest/coverage-v8": "^3.0.5",
     "eslint": "^9.20.1",
     "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-header": "^3.1.1",
+    "eslint-plugin-jsdoc": "^50.6.3",
     "eslint-plugin-local": "^6.0.0",
     "eslint-plugin-oxlint": "^0.15.10",
     "eslint-plugin-regexp": "^2.7.0",
+    "eslint-plugin-unicorn": "^57.0.0",
     "husky": "^9.1.7",
     "lint-staged": "^15.4.3",
-    "oxlint": "^0.15.10",
+    "oxlint": "^0.15.11",
     "prettier": "^3.5.1",
     "typescript": "^5.7.3",
     "typescript-eslint": "^8.24.0",
@@ -62,8 +65,5 @@
     "commander": "^13.1.0",
     "globals": "^15.15.0"
   },
-  "peerDependencies": {
-    "eslint": "^9"
-  },
-  "packageManager": "pnpm@9.15.0"
+  "packageManager": "pnpm@10.4.1"
 }