@dhzh/eslint-config 0.1.4 → 0.2.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024-PRESENT Easton Zheng<https://github.com/eastonzh>
+Copyright (c) 2022-PRESENT Easton Zheng
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,45 +1,44 @@
 # @dhzh/eslint-config
 
-Fork from [@antfu/eslint-config](https://github.com/antfu/eslint-config).
+[![npm](https://img.shields.io/npm/v/@dhzh/eslint-config?color=444&label=)](https://npmjs.com/package/@antfu/eslint-config)
 
-[![npm](https://img.shields.io/npm/v/@dhzh/eslint-config?color=444&label=)](https://npmjs.com/package/@dhzh/eslint-config)
+> `Special Statement`: This project comes from [`@antfu/eslint-config`](https://github.com/antfu/eslint-config). The two are almost the same, with only some differences to meet personal needs. In order to seek convenience and prevent some conflicts between the upstream branch and my own changes after forking, I chose to copy instead of fork.
+
+Differences from [@antfu/eslint-config](./README-antfu.md):
+
+1. With semi: `semi: true`.
+2. Always arrow parens: `arrowParens: true`.
+3. Explicitly use `1tbs` as brace style: `braceStyle: '1tbs'`.
+4. Disabled antfu's top level function rule: `'antfu/top-level-function': 'off'`.
+5. Always curly: `'curly': ['error', 'all']`.
 
 ## Usage
 
-### Wizard
+### Starter Wizard
 
-```bash
-npx @dhzh/eslint-config@latest
+We provided a CLI tool to help you set up your project, or migrate from the legacy config to the new flat config with one command.
+
+```shell
+pnpm dlx @dhzh/eslint-config@latest
 ```
 
-### Install
+### Manual Install
+
+If you prefer to set up manually:
 
 ```bash
 pnpm i -D eslint @dhzh/eslint-config
 ```
 
-### Create config file
-
-With [`"type": "module"`](https://nodejs.org/api/packages.html#type) in `package.json` (recommended):
+And create `eslint.config.mjs` in your project root:
 
 ```js
-// eslint.config.js
+// eslint.config.mjs
 import dhzh from '@dhzh/eslint-config';
 
 export default dhzh();
 ```
 
-With CJS:
-
-```js
-// eslint.config.js
-const dhzh = require('@dhzh/eslint-config').default;
-
-module.exports = dhzh();
-```
-
-More details, you can see [README-antfu](./README-antfu.md).
-
 ## License
 
-[MIT](./LICENSE) License © 2024-PRESENT [Easton Zheng](https://github.com/eastonzh)
+[MIT](./LICENSE) License © 2022-PRESENT [Easton Zheng](https://github.com/eastonzh)

package/dist/cli.cjs

@@ -48,13 +48,14 @@ var import_picocolors = __toESM(require("picocolors"), 1);
 var package_default = {
   name: "@dhzh/eslint-config",
   type: "module",
-  version: "0.1.4",
-  packageManager: "pnpm@8.15.4",
+  version: "0.2.1",
+  packageManager: "pnpm@8.15.7",
   description: "Easton's ESLint config",
   author: "Easton Zheng <dhzhme@gmail.com>",
   license: "MIT",
   homepage: "https://github.com/eastonzh/eslint-config",
   keywords: [
+    "eslint",
     "eslint-config"
   ],
   exports: {
@@ -73,7 +74,8 @@ var package_default = {
   scripts: {
     build: "nr typegen && tsup --format esm,cjs --clean --dts",
     stub: "tsup --format esm",
-    dev: "tsup --format esm,cjs --watch & eslint-flat-config-viewer",
+    dev: "npx @eslint/config-inspector --config eslint.config.ts",
+    "build:inspector": "pnpm build && npx @eslint/config-inspector build",
     watch: "tsup --format esm,cjs --watch",
     lint: "eslint .",
     typegen: "esno scripts/typegen.ts",
@@ -89,7 +91,8 @@ var package_default = {
     eslint: ">=8.40.0",
     "eslint-plugin-astro": "^0.31.4",
     "eslint-plugin-format": ">=0.1.0",
-    "eslint-plugin-svelte": "^2.35.1",
+    "eslint-plugin-solid": "^0.13.2",
+    "eslint-plugin-svelte": ">=2.35.1",
     "prettier-plugin-astro": "^0.13.0",
     "prettier-plugin-slidev": "^1.0.5",
     "svelte-eslint-parser": "^0.33.1"
@@ -107,6 +110,9 @@ var package_default = {
     "eslint-plugin-format": {
       optional: true
     },
+    "eslint-plugin-solid": {
+      optional: true
+    },
     "eslint-plugin-svelte": {
       optional: true
     },
@@ -124,29 +130,29 @@ var package_default = {
     "@antfu/install-pkg": "^0.3.2",
     "@clack/prompts": "^0.7.0",
     "@stylistic/eslint-plugin": "^1.7.0",
-    "@typescript-eslint/eslint-plugin": "^7.4.0",
-    "@typescript-eslint/parser": "^7.4.0",
-    "eslint-config-flat-gitignore": "^0.1.3",
-    "eslint-flat-config-utils": "^0.1.1",
+    "@typescript-eslint/eslint-plugin": "^7.6.0",
+    "@typescript-eslint/parser": "^7.6.0",
+    "eslint-config-flat-gitignore": "^0.1.5",
+    "eslint-flat-config-utils": "^0.2.3",
     "eslint-merge-processors": "^0.1.0",
     "eslint-plugin-antfu": "^2.1.2",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-import-x": "^0.4.4",
-    "eslint-plugin-jsdoc": "^48.2.1",
-    "eslint-plugin-jsonc": "^2.14.1",
+    "eslint-plugin-import-x": "^0.5.0",
+    "eslint-plugin-jsdoc": "^48.2.3",
+    "eslint-plugin-jsonc": "^2.15.1",
     "eslint-plugin-markdown": "^4.0.1",
-    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-n": "^17.2.1",
     "eslint-plugin-no-only-tests": "^3.1.0",
-    "eslint-plugin-perfectionist": "^2.6.0",
+    "eslint-plugin-perfectionist": "^2.9.0",
     "eslint-plugin-react": "^7.34.1",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.6",
-    "eslint-plugin-toml": "^0.9.2",
-    "eslint-plugin-unicorn": "^51.0.1",
+    "eslint-plugin-toml": "^0.11.0",
+    "eslint-plugin-unicorn": "^52.0.0",
     "eslint-plugin-unused-imports": "^3.1.0",
-    "eslint-plugin-vitest": "^0.4.0",
-    "eslint-plugin-vue": "^9.24.0",
-    "eslint-plugin-yml": "^1.13.2",
+    "eslint-plugin-vitest": "^0.5.3",
+    "eslint-plugin-vue": "^9.25.0",
+    "eslint-plugin-yml": "^1.14.0",
     "eslint-processor-vue-blocks": "^0.1.1",
     globals: "^15.0.0",
     "jsonc-eslint-parser": "^2.4.0",
@@ -162,21 +168,23 @@ var package_default = {
     "@antfu/eslint-plugin-prettier": "^5.0.1-1",
     "@antfu/ni": "^0.21.12",
     "@dhzh/eslint-config": "workspace:*",
+    "@eslint/config-inspector": "^0.4.6",
     "@stylistic/eslint-plugin-migrate": "^1.7.0",
-    "@types/eslint": "^8.56.6",
+    "@types/eslint": "^8.56.9",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.11.30",
+    "@types/node": "^20.12.7",
     "@types/prompts": "^2.4.9",
     "@types/yargs": "^17.0.32",
-    "@unocss/eslint-plugin": "^0.58.7",
-    "astro-eslint-parser": "^0.16.3",
+    "@unocss/eslint-plugin": "^0.59.2",
+    "astro-eslint-parser": "^0.17.0",
     bumpp: "^9.4.0",
-    eslint: "9.0.0-rc.0",
-    "eslint-flat-config-viewer": "^0.1.14",
-    "eslint-plugin-astro": "^0.33.1",
+    "bundle-require": "^4.0.2",
+    eslint: "^9.0.0",
+    "eslint-plugin-astro": "^0.34.0",
     "eslint-plugin-format": "^0.1.0",
+    "eslint-plugin-solid": "^0.13.2",
     "eslint-plugin-svelte": "2.36.0-next.13",
-    "eslint-typegen": "^0.1.4",
+    "eslint-typegen": "^0.2.3",
     esno: "^4.7.0",
     execa: "^8.0.1",
     "fast-glob": "^3.3.2",
@@ -186,11 +194,11 @@ var package_default = {
     "prettier-plugin-slidev": "^1.0.5",
     rimraf: "^5.0.5",
     "simple-git-hooks": "^2.11.1",
-    svelte: "^4.2.12",
-    "svelte-eslint-parser": "^0.33.1",
+    svelte: "^4.2.14",
+    "svelte-eslint-parser": "^0.34.1",
     tsup: "^8.0.2",
-    typescript: "^5.4.3",
-    vitest: "^1.4.0",
+    typescript: "^5.4.5",
+    vitest: "^1.5.0",
     vue: "^3.4.21"
   },
   "simple-git-hooks": {
@@ -203,11 +211,16 @@ var package_default = {
 
 // src/cli/constants.ts
 var vscodeSettingsString = `
+  // Entry
+  "eslint.format.enable": true,
+  "eslint.ignoreUntitled": true,
+  "eslint.enable": true,
+
   // Enable the ESlint flat config support
   "eslint.experimental.useFlatConfig": true,
 
   // Disable the default formatter, use eslint instead
-  "prettier.enable": false,
+  "prettier.enable": true, // for css and others...
   "editor.formatOnSave": false,
 
   // Auto fix
@@ -244,7 +257,45 @@ var vscodeSettingsString = `
     "yaml",
     "toml",
     "astro",
-  ]
+  ],
+
+  // Enable eslint as the default formatter
+  "[javascript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[html]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[vue]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[astro]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[toml]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[yaml]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  }
 `;
 var frameworkOptions = [
   {
@@ -263,6 +314,10 @@ var frameworkOptions = [
     label: import_picocolors.default.magenta("Astro"),
     value: "astro"
   },
+  {
+    label: import_picocolors.default.cyan("Solid"),
+    value: "solid"
+  },
   {
     label: import_picocolors.default.blue("Slidev"),
     value: "slidev"
@@ -290,6 +345,9 @@ var dependenciesMap = {
   slidev: [
     "prettier-plugin-slidev"
   ],
+  solid: [
+    "eslint-plugin-solid"
+  ],
   svelte: [
     "eslint-plugin-svelte",
     "svelte-eslint-parser"
@@ -343,8 +401,9 @@ async function updatePackageJson(result) {
             "eslint-plugin-format",
             result.frameworks.includes("astro") ? "prettier-plugin-astro" : null
           ].forEach((f) => {
-            if (!f)
+            if (!f) {
               return;
+            }
             pkg.devDependencies[f] = package_default.devDependencies[f];
             addedPackages.push(f);
           });
@@ -369,8 +428,9 @@ async function updatePackageJson(result) {
       });
     }
   }
-  if (addedPackages.length)
+  if (addedPackages.length) {
     p.note(`${import_picocolors2.default.dim(addedPackages.join(", "))}`, "Added packages");
+  }
   await import_promises.default.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
   p.log.success(import_picocolors2.default.green(`Changes wrote to package.json`));
 }
@@ -398,21 +458,26 @@ async function updateEslintFiles(result) {
     const parsed = (0, import_parse_gitignore.default)(content);
     const globs = parsed.globs();
     for (const glob of globs) {
-      if (glob.type === "ignore")
+      if (glob.type === "ignore") {
         eslintIgnores.push(...glob.patterns);
-      else if (glob.type === "unignore")
+      } else if (glob.type === "unignore") {
         eslintIgnores.push(...glob.patterns.map((pattern) => `!${pattern}`));
+      }
     }
   }
   const configLines = [];
-  if (eslintIgnores.length)
+  if (eslintIgnores.length) {
     configLines.push(`ignores: ${JSON.stringify(eslintIgnores)},`);
-  if (result.extra.includes("formatter"))
+  }
+  if (result.extra.includes("formatter")) {
     configLines.push(`formatters: true,`);
-  if (result.extra.includes("unocss"))
+  }
+  if (result.extra.includes("unocss")) {
     configLines.push(`unocss: true,`);
-  for (const framework of result.frameworks)
+  }
+  for (const framework of result.frameworks) {
     configLines.push(`${framework}: true,`);
+  }
   const mainConfig = configLines.map((i) => `  ${i}`).join("\n");
   const additionalConfig = [];
   const eslintConfigContent = getEslintConfigContent(mainConfig, additionalConfig);
@@ -421,11 +486,13 @@ async function updateEslintFiles(result) {
   const files = import_node_fs.default.readdirSync(cwd);
   const legacyConfig = [];
   files.forEach((file) => {
-    if (/eslint|prettier/.test(file) && !/eslint\.config\./.test(file))
+    if (/eslint|prettier/.test(file) && !/eslint\.config\./.test(file)) {
       legacyConfig.push(file);
+    }
   });
-  if (legacyConfig.length)
+  if (legacyConfig.length) {
     p2.note(`${import_picocolors3.default.dim(legacyConfig.join(", "))}`, "You can now remove those files manually");
+  }
 }
 
 // src/cli/stages/update-vscode-settings.ts
@@ -437,12 +504,14 @@ var import_picocolors4 = __toESM(require("picocolors"), 1);
 var p3 = __toESM(require("@clack/prompts"), 1);
 async function updateVscodeSettings(result) {
   const cwd = import_node_process3.default.cwd();
-  if (!result.updateVscodeSettings)
+  if (!result.updateVscodeSettings) {
     return;
+  }
   const dotVscodePath = import_node_path3.default.join(cwd, ".vscode");
   const settingsPath = import_node_path3.default.join(dotVscodePath, "settings.json");
-  if (!import_node_fs2.default.existsSync(dotVscodePath))
+  if (!import_node_fs2.default.existsSync(dotVscodePath)) {
     await import_promises3.default.mkdir(dotVscodePath, { recursive: true });
+  }
   if (!import_node_fs2.default.existsSync(settingsPath)) {
     await import_promises3.default.writeFile(settingsPath, `{${vscodeSettingsString}}
 `, "utf-8");
@@ -476,8 +545,9 @@ async function run(options = {}) {
   if (!argSkipPrompt) {
     result = await p4.group({
       uncommittedConfirmed: () => {
-        if (argSkipPrompt || isGitClean())
+        if (argSkipPrompt || isGitClean()) {
           return Promise.resolve(true);
+        }
         return p4.confirm({
           initialValue: false,
           message: "There are uncommitted changes in the current repository, are you sure to continue?"
@@ -485,8 +555,9 @@ async function run(options = {}) {
       },
       frameworks: ({ results }) => {
         const isArgTemplateValid = typeof argTemplate === "string" && !!frameworks.includes(argTemplate);
-        if (!results.uncommittedConfirmed || isArgTemplateValid)
+        if (!results.uncommittedConfirmed || isArgTemplateValid) {
           return;
+        }
         const message = !isArgTemplateValid && argTemplate ? `"${argTemplate}" isn't a valid template. Please choose from below: ` : "Select a framework:";
         return p4.multiselect({
           message: import_picocolors5.default.reset(message),
@@ -496,8 +567,9 @@ async function run(options = {}) {
       },
       extra: ({ results }) => {
         const isArgExtraValid = argExtra?.length && !argExtra.filter((element) => !extra.includes(element)).length;
-        if (!results.uncommittedConfirmed || isArgExtraValid)
+        if (!results.uncommittedConfirmed || isArgExtraValid) {
           return;
+        }
         const message = !isArgExtraValid && argExtra ? `"${argExtra}" isn't a valid extra util. Please choose from below: ` : "Select a extra utils:";
         return p4.multiselect({
           message: import_picocolors5.default.reset(message),
@@ -506,8 +578,9 @@ async function run(options = {}) {
         });
       },
       updateVscodeSettings: ({ results }) => {
-        if (!results.uncommittedConfirmed)
+        if (!results.uncommittedConfirmed) {
           return;
+        }
         return p4.confirm({
           initialValue: true,
           message: "Update .vscode/settings.json for better VS Code experience?"
@@ -519,8 +592,9 @@ async function run(options = {}) {
         import_node_process4.default.exit(0);
       }
     });
-    if (!result.uncommittedConfirmed)
+    if (!result.uncommittedConfirmed) {
       return import_node_process4.default.exit(1);
+    }
   }
   await updatePackageJson(result);
   await updateEslintFiles(result);