@antfu/eslint-config 1.2.1 → 2.1.0

package/README.md

@@ -32,7 +32,7 @@ With [`"type": "module"`](https://nodejs.org/api/packages.html#type) in `package
 // eslint.config.js
 import antfu from '@antfu/eslint-config'
 
-export default antfu()
+export default await antfu()
 ```
 
 With CJS:
@@ -87,13 +87,13 @@ For example:
 
 ### Migration
 
-We provided an experimental cli tool to help you migrate from the legacy config to the new flat config.
+We provided an experimental CLI tool to help you migrate from the legacy config to the new flat config.
 
 ```bash
-npx @antfu/eslint-config migrate
+npx @antfu/eslint-config@latest
 ```
 
-Before running the migration, make sure to commit your changes first.
+Before running the migration, make sure to commit your unsaved changes first.
 
 ## VS Code support (auto fix)
 
@@ -155,7 +155,7 @@ Normally you only need to import the `antfu` preset:
 // eslint.config.js
 import antfu from '@antfu/eslint-config'
 
-export default antfu()
+export default await antfu()
 ```
 
 And that's it! Or you can configure each integration individually, for example:
@@ -164,7 +164,7 @@ And that's it! Or you can configure each integration individually, for example:
 // eslint.config.js
 import antfu from '@antfu/eslint-config'
 
-export default antfu({
+export default await antfu({
   // Enable stylistic formatting rules
   // stylistic: true,
 
@@ -196,7 +196,7 @@ The `antfu` factory function also accepts any number of arbitrary custom config
 // eslint.config.js
 import antfu from '@antfu/eslint-config'
 
-export default antfu(
+export default await antfu(
   {
     // Configures for antfu's config
   },
@@ -223,6 +223,7 @@ We don't recommend using this style in general usages, as there are shared optio
 ```js
 // eslint.config.js
 import {
+  combine,
   comments,
   ignores,
   imports,
@@ -240,21 +241,21 @@ import {
   yaml,
 } from '@antfu/eslint-config'
 
-export default [
-  ...ignores(),
-  ...javascript(/* Options */),
-  ...comments(),
-  ...node(),
-  ...jsdoc(),
-  ...imports(),
-  ...unicorn(),
-  ...typescript(/* Options */),
-  ...stylistic(),
-  ...vue(),
-  ...jsonc(),
-  ...yaml(),
-  ...markdown(),
-]
+export default await combine(
+  ignores(),
+  javascript(/* Options */),
+  comments(),
+  node(),
+  jsdoc(),
+  imports(),
+  unicorn(),
+  typescript(/* Options */),
+  stylistic(),
+  vue(),
+  jsonc(),
+  yaml(),
+  markdown(),
+)
 ```
 
 </details>
@@ -293,7 +294,7 @@ Certain rules would only be enabled in specific files, for example, `ts/*` rules
 // eslint.config.js
 import antfu from '@antfu/eslint-config'
 
-export default antfu(
+export default await antfu(
   { vue: true, typescript: true },
   {
     // Remember to specify the file glob here, otherwise it might cause the vue plugin to handle non-vue files
@@ -311,7 +312,7 @@ export default antfu(
 )
 ```
 
-We also provided an `overrides` options to make it easier:
+We also provided a `overrides` options to make it easier:
 
 ```js
 // eslint.config.js
@@ -331,6 +332,29 @@ export default antfu({
 })
 ```
 
+### Optional Configs
+
+#### React
+
+We do include configs for React. But due to the install size of React plugins we didn't include the dependencies by default.
+
+To enable React support, need to explicitly turn it on:
+
+```js
+// eslint.config.js
+import antfu from '@antfu/eslint-config'
+
+export default antfu({
+  react: true,
+})
+```
+
+Running `npx eslint` should prompt you to install the required dependencies, otherwise you can install them manually:
+
+```bash
+npm i -D eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-react-refresh
+```
+
 ### Optional Rules
 
 This config also provides some optional plugins/rules for extended usages.

package/dist/cli.cjs

@@ -46,13 +46,40 @@ var import_parse_gitignore = __toESM(require("parse-gitignore"), 1);
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "1.2.1";
+var version = "2.1.0";
+var devDependencies = {
+  "@antfu/eslint-config": "workspace:*",
+  "@antfu/ni": "^0.21.10",
+  "@stylistic/eslint-plugin-migrate": "^1.4.0",
+  "@types/eslint": "^8.44.7",
+  "@types/fs-extra": "^11.0.4",
+  "@types/node": "^20.9.4",
+  "@types/prompts": "^2.4.9",
+  "@types/yargs": "^17.0.32",
+  bumpp: "^9.2.0",
+  eslint: "^8.54.0",
+  "eslint-flat-config-viewer": "^0.1.3",
+  "eslint-plugin-react": "^7.33.2",
+  "eslint-plugin-react-hooks": "^4.6.0",
+  "eslint-plugin-react-refresh": "^0.4.4",
+  esno: "^4.0.0",
+  execa: "^8.0.1",
+  "fast-glob": "^3.3.2",
+  "fs-extra": "^11.1.1",
+  "lint-staged": "^15.1.0",
+  rimraf: "^5.0.5",
+  "simple-git-hooks": "^2.9.0",
+  tsup: "^8.0.1",
+  typescript: "^5.3.2",
+  vitest: "^0.34.6"
+};
 
 // src/cli/constants.ts
 var ARROW = import_picocolors.default.cyan("\u2192");
 var CHECK = import_picocolors.default.green("\u2714");
 var CROSS = import_picocolors.default.red("\u2718");
 var WARN = import_picocolors.default.yellow("\u2139");
+var eslintVersion = devDependencies.eslint;
 var vscodeSettingsString = `
   // Enable the ESlint flat config support
   "eslint.experimental.useFlatConfig": true,
@@ -107,9 +134,9 @@ function isGitClean() {
 }
 
 // src/cli/run.ts
-var SKIP_PROMPT = !!import_node_process.default.env.SKIP_PROMPT;
-var SKIP_GIT_CHECK = !!import_node_process.default.env.SKIP_GIT_CHECK;
-async function run() {
+async function run(options = {}) {
+  const SKIP_PROMPT = !!import_node_process.default.env.SKIP_PROMPT || options.yes;
+  const SKIP_GIT_CHECK = !!import_node_process.default.env.SKIP_GIT_CHECK;
   const cwd = import_node_process.default.cwd();
   const pathFlatConfig = import_node_path.default.join(cwd, "eslint.config.js");
   const pathPackageJSON = import_node_path.default.join(cwd, "package.json");
@@ -125,6 +152,8 @@ async function run() {
   const pkg = JSON.parse(pkgContent);
   pkg.devDependencies ?? (pkg.devDependencies = {});
   pkg.devDependencies["@antfu/eslint-config"] = `^${version}`;
+  if (!pkg.devDependencies.eslint)
+    pkg.devDependencies.eslint = eslintVersion;
   await import_promises.default.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
   console.log(import_picocolors2.default.green(`${CHECK} changes wrote to package.json`));
   const eslintIgnores = [];
@@ -221,22 +250,19 @@ function header() {
 ${import_picocolors3.default.green(`@antfu/eslint-config `)}${import_picocolors3.default.dim(`v${version}`)}`);
 }
 var instance = (0, import_yargs.default)((0, import_helpers.hideBin)(import_node_process2.default.argv)).scriptName("@antfu/eslint-config").usage("").command(
-  "migrate",
-  "Migrate from legacy config to new flat config",
-  (args) => args.help(),
-  async (_args) => {
+  "*",
+  "Run the initialization or migration",
+  (args) => args.option("yes", { alias: "y", description: "Skip prompts and use default values", type: "boolean" }).help(),
+  async (args) => {
     header();
     console.log();
     try {
-      await run();
+      await run(args);
     } catch (error) {
       console.error(import_picocolors3.default.inverse(import_picocolors3.default.red(" Failed to migrate ")));
       console.error(import_picocolors3.default.red(`${CROSS} ${String(error)}`));
       import_node_process2.default.exit(1);
     }
   }
-).command("*", false, (args) => args, () => {
-  header();
-  instance.showHelp();
-}).showHelpOnFail(false).alias("h", "help").version("version", version).alias("v", "version");
+).showHelpOnFail(false).alias("h", "help").version("version", version).alias("v", "version");
 instance.help().argv;

package/dist/cli.js

@@ -17,13 +17,40 @@ import parse from "parse-gitignore";
 import c from "picocolors";
 
 // package.json
-var version = "1.2.1";
+var version = "2.1.0";
+var devDependencies = {
+  "@antfu/eslint-config": "workspace:*",
+  "@antfu/ni": "^0.21.10",
+  "@stylistic/eslint-plugin-migrate": "^1.4.0",
+  "@types/eslint": "^8.44.7",
+  "@types/fs-extra": "^11.0.4",
+  "@types/node": "^20.9.4",
+  "@types/prompts": "^2.4.9",
+  "@types/yargs": "^17.0.32",
+  bumpp: "^9.2.0",
+  eslint: "^8.54.0",
+  "eslint-flat-config-viewer": "^0.1.3",
+  "eslint-plugin-react": "^7.33.2",
+  "eslint-plugin-react-hooks": "^4.6.0",
+  "eslint-plugin-react-refresh": "^0.4.4",
+  esno: "^4.0.0",
+  execa: "^8.0.1",
+  "fast-glob": "^3.3.2",
+  "fs-extra": "^11.1.1",
+  "lint-staged": "^15.1.0",
+  rimraf: "^5.0.5",
+  "simple-git-hooks": "^2.9.0",
+  tsup: "^8.0.1",
+  typescript: "^5.3.2",
+  vitest: "^0.34.6"
+};
 
 // src/cli/constants.ts
 var ARROW = c.cyan("\u2192");
 var CHECK = c.green("\u2714");
 var CROSS = c.red("\u2718");
 var WARN = c.yellow("\u2139");
+var eslintVersion = devDependencies.eslint;
 var vscodeSettingsString = `
   // Enable the ESlint flat config support
   "eslint.experimental.useFlatConfig": true,
@@ -78,9 +105,9 @@ function isGitClean() {
 }
 
 // src/cli/run.ts
-var SKIP_PROMPT = !!process.env.SKIP_PROMPT;
-var SKIP_GIT_CHECK = !!process.env.SKIP_GIT_CHECK;
-async function run() {
+async function run(options = {}) {
+  const SKIP_PROMPT = !!process.env.SKIP_PROMPT || options.yes;
+  const SKIP_GIT_CHECK = !!process.env.SKIP_GIT_CHECK;
   const cwd = process.cwd();
   const pathFlatConfig = path.join(cwd, "eslint.config.js");
   const pathPackageJSON = path.join(cwd, "package.json");
@@ -96,6 +123,8 @@ async function run() {
   const pkg = JSON.parse(pkgContent);
   pkg.devDependencies ?? (pkg.devDependencies = {});
   pkg.devDependencies["@antfu/eslint-config"] = `^${version}`;
+  if (!pkg.devDependencies.eslint)
+    pkg.devDependencies.eslint = eslintVersion;
   await fsp.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
   console.log(c2.green(`${CHECK} changes wrote to package.json`));
   const eslintIgnores = [];
@@ -192,22 +221,19 @@ function header() {
 ${c3.green(`@antfu/eslint-config `)}${c3.dim(`v${version}`)}`);
 }
 var instance = yargs(hideBin(process2.argv)).scriptName("@antfu/eslint-config").usage("").command(
-  "migrate",
-  "Migrate from legacy config to new flat config",
-  (args) => args.help(),
-  async (_args) => {
+  "*",
+  "Run the initialization or migration",
+  (args) => args.option("yes", { alias: "y", description: "Skip prompts and use default values", type: "boolean" }).help(),
+  async (args) => {
     header();
     console.log();
     try {
-      await run();
+      await run(args);
     } catch (error) {
       console.error(c3.inverse(c3.red(" Failed to migrate ")));
       console.error(c3.red(`${CROSS} ${String(error)}`));
       process2.exit(1);
     }
   }
-).command("*", false, (args) => args, () => {
-  header();
-  instance.showHelp();
-}).showHelpOnFail(false).alias("h", "help").version("version", version).alias("v", "version");
+).showHelpOnFail(false).alias("h", "help").version("version", version).alias("v", "version");
 instance.help().argv;