@dhzh/eslint-config 0.27.0 → 1.0.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-PRESENT Lyle Zheng
+Copyright (c) 2022 Lyle 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

@@ -2,58 +2,28 @@
 
 [![npm](https://img.shields.io/npm/v/@dhzh/eslint-config?color=444&label=)](https://npmjs.com/package/@antfu/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](https://github.com/antfu/eslint-config/blob/main/README.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:
-
-- `'antfu/curly': 'off'`
-- `'curly': ['error', 'all']`
-
-6. This eslint-config will enable `ts/consistent-type-imports` rule. But it will cause [compile issue](https://github.com/typescript-eslint/typescript-eslint/issues/2559) in [nest](https://nestjs.com/) projects. So I [disabled it](https://github.com/typescript-eslint/typescript-eslint/issues/2559#issuecomment-692780580) in this config in nest framework.
-7. Support `'**/*.?([cm])js` and `'**/*.?([cm])jsx` files in react projects.
-8. Perfectionist plugin for imports sorting:
-
-```js
-[
-  'builtin',
-  'external',
-  'internal',
-  'parent',
-  'sibling',
-  'index',
-  'style',
-  'side-effect',
-  'side-effect-style',
-  'object',
-  'builtin-type',
-  'external-type',
-  'internal-type',
-  'parent-type',
-  'sibling-type',
-  'index-type',
-  'unknown',
-];
-```
-
-> Note: Temporarily close the rules of the [`Perfectionist`](https://perfectionist.dev/) plugin from version `v0.15.0`, because I haven't found a way to achieve the best balance between actual development needs and personal habits.
-
-9. React related:
-
-- `'react/no-useless-fragment': 'warn'`
-
-10. Remove spacing when useing jsx curly braces:
-
-- `'style/jsx-curly-spacing': ['error', { children: true, when: 'never' }]`
-
-11. Keep auto fix with code editors for rules: [`prefer-const`](https://eslint.org/docs/rules/prefer-const), [`unused-imports/no-unused-imports`](https://www.npmjs.com/package/eslint-plugin-unused-imports).
-
-12. Disable [`perfectionist/sort-objects`](https://perfectionist.dev/rules/sort-objects) rule.
+I use ESLint to format and lint my code:
+
+|  |  |  |
+|---|---|---|
+| [react](./src/configs/react.ts) | [`ESLint React`](https://eslint-react.xyz/) [`eslint-plugin-react-hooks`](https://www.npmjs.com/package/eslint-plugin-react-hooks) [`eslint-plugin-react-refresh`](https://github.com/ArnaudBarre/eslint-plugin-react-refresh) [`eslint-plugin-react-compiler`](https://www.npmjs.com/package/eslint-plugin-react-compiler) [`eslint-plugin-react-google-translate`](https://www.npmjs.com/package/eslint-plugin-react-google-translate) |
+| [stylistic](./src/configs/stylistic.ts) | [`ESLint Stylistic`](https://eslint.style/) [`eslint-plugin-antfu`](https://github.com/antfu/eslint-plugin-antfu) [`eslint-plugin-hyoban`](https://github.com/hyoban/eslint-plugin-hyoban) |
+| [typescript](./src/configs/typescript.ts) | [`typescript-eslint`](https://typescript-eslint.io/) |
+| [javascript](./src/configs/javascript.ts) | [`@eslint/js`](https://eslint.org/docs/latest/rules) |
+| [node](./src/configs/node.ts) | [`eslint-plugin-n`](https://github.com/eslint-community/eslint-plugin-n) |
+| [json](./src/configs/json.ts) | [`eslint-plugin-jsonc`](https://ota-meshi.github.io/eslint-plugin-jsonc/) [`eslint-plugin-package-json`](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json) [`jsonc-eslint-parser`](https://github.com/ota-meshi/jsonc-eslint-parser) |
+| [unicorn](./src/configs/unicorn.ts) | [`eslint-plugin-unicorn`](https://www.npmjs.com/package/eslint-plugin-unicorn) |
+| [imports](./src/configs/imports.ts) | [`eslint-plugin-import-x`](https://www.npmjs.com/package/eslint-plugin-import-x) [`eslint-plugin-unused-imports`](https://github.com/sweepline/eslint-plugin-unused-imports) [`eslint-plugin-simple-import-sort`](https://github.com/lydell/eslint-plugin-simple-import-sort) |
+| [formatters](./src/configs/formatters.ts) | [`eslint-plugin-format`](https://github.com/antfu/eslint-plugin-format) [`@prettier/plugin-xml`](https://github.com/prettier/plugin-xml) | html/css/graphql/xml/svg |
+| [tailwindcss](./src/configs/tailwindcss.ts) | [`eslint-plugin-tailwindcss`](https://github.com/francoismassart/eslint-plugin-tailwindcss) |
+| [unocss](./src/configs/unocss.ts) | [`@unocss/eslint-config`](https://unocss.dev/integrations/eslint) |
+| [yml](./src/configs/yml.ts) | [`eslint-plugin-yml`](https://ota-meshi.github.io/eslint-plugin-yml/) [`yaml-eslint-parser`](https://ota-meshi.github.io/yaml-eslint-parser/) |
+| [toml](./src/configs/toml.ts) | [`eslint-plugin-toml`](https://ota-meshi.github.io/eslint-plugin-toml/) [`toml-eslint-parser`](https://ota-meshi.github.io/toml-eslint-parser/) |
+| testing | [`eslint-plugin-vitest`](https://github.com/vitest-dev/eslint-plugin-vitest) [`eslint-plugin-jest`](https://github.com/jest-community/eslint-plugin-jest) [`eslint-plugin-no-only-tests`](https://github.com/levibuzolic/eslint-plugin-no-only-tests) |
+| [regexp](./src/configs/regexp.ts) | [`eslint-plugin-regexp`](https://ota-meshi.github.io/eslint-plugin-regexp/) |
+| [eslint-comments](./src/configs/eslint-comments.ts) | [`eslint-plugin-eslint-comments`](https://eslint-community.github.io/eslint-plugin-eslint-comments/) |
+| markdown | [`@eslint/markdown`](https://github.com/eslint/markdown) |
+| jsdoc | [`eslint-plugin-jsdoc`](https://github.com/gajus/eslint-plugin-jsdoc) |
 
 ## Usage
 
@@ -79,9 +49,9 @@ And create `eslint.config.mjs` in your project root:
 
 ```js
 // eslint.config.mjs
-import dhzh from '@dhzh/eslint-config';
+import { defineConfig } from '@dhzh/eslint-config';
 
-export default dhzh();
+export default defineConfig();
 ```
 
 ## License

package/bin/index.js

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-import '../dist/cli.js';
+import '../dist/cli/index.js';

package/dist/cli/index.cjs

@@ -0,0 +1,371 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// src/cli/index.ts
+var p5 = __toESM(require("@clack/prompts"), 1);
+var import_ansis5 = __toESM(require("ansis"), 1);
+var import_cac = require("cac");
+
+// package.json
+var version = "1.0.1";
+var package_default = {
+  name: "@dhzh/eslint-config",
+  type: "module",
+  version,
+  packageManager: "pnpm@10.7.0",
+  description: "Lyle's ESLint config",
+  author: {
+    name: "Lyle Zheng",
+    email: "dhzhme@gmail.com"
+  },
+  license: "MIT",
+  homepage: "https://github.com/tinywaves/eslint-config",
+  repository: {
+    type: "git",
+    url: "git+https://github.com/tinywaves/eslint-config"
+  },
+  bugs: {
+    url: "https://github.com/tinywaves/eslint-config/issues"
+  },
+  keywords: [
+    "eslint",
+    "eslint-config"
+  ],
+  sideEffects: false,
+  exports: {
+    ".": {
+      import: "./dist/index.js",
+      require: "./dist/index.cjs"
+    }
+  },
+  main: "./dist/index.js",
+  types: "./dist/index.d.ts",
+  bin: "./bin/index.js",
+  files: [
+    "bin",
+    "dist"
+  ],
+  engines: {
+    node: "^18.18.0 || ^20.9.0 || >=21.1.0"
+  },
+  scripts: {
+    build: "tsup --clean --dts",
+    "build:inspector": "pnpm run build && npx @eslint/config-inspector build",
+    dev: "pnpm run typegen && npx @eslint/config-inspector --config eslint.config.ts",
+    lint: "eslint",
+    "lint-fix": "eslint --fix .",
+    prepack: "pnpm run build",
+    prepare: "simple-git-hooks",
+    release: "bumpp && pnpm publish --access=public",
+    typecheck: "tsc --noEmit",
+    typegen: "tsx scripts/eslint-typegen.ts"
+  },
+  peerDependencies: {
+    "@prettier/plugin-xml": "^3.4.1",
+    eslint: "^9.10.0"
+  },
+  peerDependenciesMeta: {
+    "@prettier/plugin-xml": {
+      optional: true
+    }
+  },
+  dependencies: {
+    "@clack/prompts": "^0.10.0",
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.5.0",
+    "@eslint-react/eslint-plugin": "^1.48.4",
+    "@eslint/js": "^9.25.1",
+    "@stylistic/eslint-plugin": "^4.2.0",
+    "@unocss/eslint-config": "66.1.0-beta.12",
+    ansis: "^3.17.0",
+    cac: "^6.7.14",
+    "eslint-plugin-antfu": "^3.1.1",
+    "eslint-plugin-format": "^1.0.1",
+    "eslint-plugin-hyoban": "^0.6.1",
+    "eslint-plugin-import-x": "^4.10.6",
+    "eslint-plugin-jsonc": "^2.20.0",
+    "eslint-plugin-n": "^17.16.2",
+    "eslint-plugin-package-json": "^0.30.0",
+    "eslint-plugin-react-compiler": "19.1.0-rc.1",
+    "eslint-plugin-react-google-translate": "^0.1.1",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-react-refresh": "^0.4.20",
+    "eslint-plugin-regexp": "^2.7.0",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-tailwindcss": "^3.18.0",
+    "eslint-plugin-toml": "^0.12.0",
+    "eslint-plugin-unicorn": "^57.0.0",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "eslint-plugin-yml": "^1.17.0",
+    globals: "^16.0.0",
+    "jsonc-eslint-parser": "^2.4.0",
+    "local-pkg": "^1.1.1",
+    "toml-eslint-parser": "^0.10.0",
+    "typescript-eslint": "^8.30.1",
+    "yaml-eslint-parser": "^1.3.0"
+  },
+  devDependencies: {
+    "@eslint/config-inspector": "^1.0.2",
+    "@prettier/plugin-xml": "^3.4.1",
+    "@types/eslint-plugin-tailwindcss": "^3.17.0",
+    "@types/node": "^22.13.11",
+    bumpp: "^10.0.3",
+    "bundle-require": "^5.1.0",
+    eslint: "^9.25.0",
+    "eslint-typegen": "^2.1.0",
+    "lint-staged": "^15.5.0",
+    "simple-git-hooks": "^2.12.1",
+    tsup: "^8.4.0",
+    tsx: "^4.19.3",
+    typescript: "^5.8.3"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "npx lint-staged"
+  },
+  "lint-staged": {
+    "*": "eslint --fix"
+  }
+};
+
+// src/cli/run.ts
+var p4 = __toESM(require("@clack/prompts"), 1);
+var import_ansis4 = __toESM(require("ansis"), 1);
+
+// src/cli/stages/update-eslint-config.ts
+var import_promises = __toESM(require("fs/promises"), 1);
+var import_node_path = __toESM(require("path"), 1);
+var import_node_process = __toESM(require("process"), 1);
+var import_ansis = __toESM(require("ansis"), 1);
+var p = __toESM(require("@clack/prompts"), 1);
+
+// src/cli/constants.ts
+var vscodeSettingsString = `
+  // Entry
+  "eslint.format.enable": true,
+  "eslint.ignoreUntitled": true,
+  "eslint.enable": true,
+
+  // Disable the default formatter, use eslint instead
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+
+  // Auto fix
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports": "never"
+  },
+
+  // Silent the stylistic rules in you IDE, but still auto fix them
+  // "eslint.rules.customizations": [
+  //   { "rule": "style/*", "severity": "off", "fixable": true },
+  //   { "rule": "format/*", "severity": "off", "fixable": true },
+  //   { "rule": "*-indent", "severity": "off", "fixable": true },
+  //   { "rule": "*-spacing", "severity": "off", "fixable": true },
+  //   { "rule": "*-spaces", "severity": "off", "fixable": true },
+  //   { "rule": "*-order", "severity": "off", "fixable": true },
+  //   { "rule": "*-dangle", "severity": "off", "fixable": true },
+  //   { "rule": "*-newline", "severity": "off", "fixable": true },
+  //   { "rule": "*quotes", "severity": "off", "fixable": true },
+  //   { "rule": "*semi", "severity": "off", "fixable": true }
+  // ],
+
+  // Enable eslint for all supported languages
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "vue",
+    "html",
+    "markdown",
+    "json",
+    "json5",
+    "jsonc",
+    "yaml",
+    "toml",
+    "xml",
+    "css",
+    "less",
+    "scss",
+    "pcss",
+    "postcss",
+    "gql",
+    "graphql",
+    "astro",
+    "svelte"
+  ],
+
+  // Enable eslint as the default formatter
+  "[javascript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[vue]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[html]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[yaml]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[toml]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[xml]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[css]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[less]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[scss]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[pcss]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[postcss]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[gql]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[graphql]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[astro]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  }
+`;
+var eslintConfigContent = `
+import { defineConfig } from '@dhzh/eslint-config';
+
+export default defineConfig();
+`;
+
+// src/cli/stages/update-eslint-config.ts
+async function updateEslintConfig() {
+  const cwd = import_node_process.default.cwd();
+  const pathPackageJSON = import_node_path.default.join(cwd, "package.json");
+  const pkgContent = await import_promises.default.readFile(pathPackageJSON, "utf8");
+  const pkg = JSON.parse(pkgContent);
+  const configFileName = pkg.type === "module" ? "eslint.config.js" : "eslint.config.mjs";
+  const pathFlatConfig = import_node_path.default.join(cwd, configFileName);
+  await import_promises.default.writeFile(pathFlatConfig, eslintConfigContent);
+  p.log.success(import_ansis.default.green`Created ${configFileName}`);
+}
+
+// src/cli/stages/update-package-json.ts
+var import_promises2 = __toESM(require("fs/promises"), 1);
+var import_node_path2 = __toESM(require("path"), 1);
+var import_node_process2 = __toESM(require("process"), 1);
+var p2 = __toESM(require("@clack/prompts"), 1);
+var import_ansis2 = __toESM(require("ansis"), 1);
+async function updatePackageJson() {
+  const cwd = import_node_process2.default.cwd();
+  const pathPackageJSON = import_node_path2.default.join(cwd, "package.json");
+  p2.log.step(import_ansis2.default.cyan`Bumping @dhzh/eslint-config to v${version}`);
+  const pkgContent = await import_promises2.default.readFile(pathPackageJSON, "utf8");
+  const pkg = JSON.parse(pkgContent);
+  pkg.devDependencies ??= {};
+  pkg.devDependencies["@dhzh/eslint-config"] = `^${version}`;
+  pkg.devDependencies.eslint ??= package_default.devDependencies.eslint;
+  await import_promises2.default.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
+  p2.log.success(import_ansis2.default.green`Changes wrote to package.json`);
+}
+
+// src/cli/stages/update-vscode-settings.ts
+var import_node_fs = __toESM(require("fs"), 1);
+var import_promises3 = __toESM(require("fs/promises"), 1);
+var import_node_path3 = __toESM(require("path"), 1);
+var import_node_process3 = __toESM(require("process"), 1);
+var import_ansis3 = require("ansis");
+var p3 = __toESM(require("@clack/prompts"), 1);
+async function updateVscodeSettings() {
+  const cwd = import_node_process3.default.cwd();
+  const dotVscodePath = import_node_path3.default.join(cwd, ".vscode");
+  const settingsPath = import_node_path3.default.join(dotVscodePath, "settings.json");
+  if (!import_node_fs.default.existsSync(dotVscodePath)) {
+    await import_promises3.default.mkdir(dotVscodePath, { recursive: true });
+  }
+  if (import_node_fs.default.existsSync(settingsPath)) {
+    let settingsContent = await import_promises3.default.readFile(settingsPath, "utf8");
+    settingsContent = settingsContent.trim().replace(/\s*\}$/, "");
+    settingsContent += settingsContent.endsWith(",") || settingsContent.endsWith("{") ? "" : ",";
+    settingsContent += `${vscodeSettingsString}}
+`;
+    await import_promises3.default.writeFile(settingsPath, settingsContent, "utf8");
+    p3.log.success(import_ansis3.green`Updated .vscode/settings.json`);
+  } else {
+    await import_promises3.default.writeFile(settingsPath, `{${vscodeSettingsString}}
+`, "utf8");
+    p3.log.success(import_ansis3.green`Created .vscode/settings.json`);
+  }
+}
+
+// src/cli/run.ts
+async function run() {
+  await updatePackageJson();
+  await updateEslintConfig();
+  await updateVscodeSettings();
+  p4.log.success(import_ansis4.default.green`Setup completed`);
+  p4.outro(`Now you can update the dependencies by run ${import_ansis4.default.blue("pnpm i")} and run ${import_ansis4.default.blue("eslint --fix")}
+`);
+}
+
+// src/cli/index.ts
+var cli = (0, import_cac.cac)("@dhzh/eslint-config");
+cli.command("", "Run the initialization or migration").action(async () => {
+  console.log("\n");
+  p5.intro(`${import_ansis5.default.green`@dhzh/eslint-config `}${import_ansis5.default.dim`v${version}`}`);
+  try {
+    await run();
+  } catch (error) {
+    p5.log.error(import_ansis5.default.inverse.red(" Failed to migrate "));
+    p5.log.error(import_ansis5.default.red`✘ ${String(error)}`);
+    throw error;
+  }
+});
+cli.help();
+cli.version(version);
+cli.parse();