@july_cm/eslint-config 1.0.0 → 2.0.0

package/README.md

@@ -0,0 +1,89 @@
+# @july_cm/eslint-config
+
+This is my common ESlint configuration.
+
+It depends on ESLint v9 or later and is only compatible with Flat Configuration.
+
+❌ [legacy configuration](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated) (legacy: `.eslintrc*`)
+
+✅ [flat configuration](https://eslint.org/docs/latest/use/configure/configuration-files-new) (new: `eslint.config.js`)
+
+## Installation
+
+```sh
+npm install --save-dev eslint @july_cm/eslint-config
+```
+
+`@july_cm/eslint-config` does not install ESLint for you. You must install these yourself.
+
+## Language support
+
+```javascript
+const * as config from '@july_cm/eslint-config';
+
+// only javascript
+export default config.javascript;
+
+// only typescript
+export default config.typescript;
+
+/**
+ * recommended
+ * - javascript
+ * - typescript
+ * - package.json
+ */
+export default config.recommended;
+```
+
+
+## Abort `package.json` key order
+
+The sorting functionality is implemented based on [eslint-plugin-jsonc](https://github.com/ota-meshi/eslint-plugin-jsonc) and [prettier](https://github.com/prettier/prettier).
+
+```javascript
+// root keys order
+const order = ['name', 'version', 'author', 'scripts', 'dependencies', 'devDependencies'];
+
+// dependencies package order
+const pkg = {
+  pathPattern: '^(?:dev|peer|optional|bundled)?[Dd]ependencies$',
+  order: { type: 'asc' },
+},
+```
+
+## With `Visual Studio Code`
+
+1. Install [VS Code ESLint extension](https://github.com/microsoft/vscode-eslint).
+
+    Check if there are other plugins set as the default formatter in the editor. If so, they need to be removed or replaced with ESLint:
+
+    ```json
+    {
+      "editor.defaultFormatter": "dbaeumer.vscode-eslint",
+    }
+    ```
+
+    If the Prettier extension is also active in this workspace, it should be disabled. This is because both will conflict with each other, leading to formatting issues.
+
+    `@july_cm/eslint-config` has already integrated `eslint-plugin-prettier`, ensuring that both can work simultaneously without conflict.
+
+
+2. Fix on save
+
+    ```json
+    {
+      "editor.codeActionsOnSave": {
+        "source.fixAll.eslint": "explicit"
+      }
+    }
+    ```
+
+3. Debug
+
+    Open VSCode Command Panel(Ctrl + Shift + P / Cmd + Shift + P) and run:
+
+    ```
+    ESLint: Show Output Channel
+    ```
+    Fix errors if they exist.

package/lib/configs/javascript.js

@@ -0,0 +1,55 @@
+import eslintJs from '@eslint/js';
+import { defineConfig } from 'eslint/config';
+import importPlugin from 'eslint-plugin-import';
+
+import eslintPrettier from './prettier.js';
+
+/**
+ * defineConfig 会 flat 一层 extends，并且将 files 字段赋值给所有 extends
+ * 可以借助这个函数为所有插件添加 files 约束，防止语言之间的污染
+ */
+const javascriptConfig = defineConfig({
+  extends: [eslintJs.configs.recommended, importPlugin.flatConfigs.recommended, ...eslintPrettier],
+  files: ['**/*.{js,mjs,cjs,jsx}'],
+  rules: {
+    'import/order': [
+      'warn',
+      {
+        groups: ['builtin', 'external', 'internal', ['parent', 'sibling'], 'object', 'type', 'index'],
+        'newlines-between': 'always',
+        pathGroupsExcludedImportTypes: ['builtin'],
+        alphabetize: { order: 'asc', caseInsensitive: true },
+        pathGroups: [
+          {
+            pattern: 'react**',
+            group: 'external',
+            position: 'before',
+          },
+          {
+            pattern: '{@/**,@**}',
+            group: 'internal',
+            position: 'before',
+          },
+          {
+            pattern: '**/*.{scss,json,svg,css,less}',
+            group: 'index',
+            position: 'after',
+          },
+        ],
+      },
+    ],
+  },
+  settings: {
+    'import/resolver': {
+      node: true,
+      /**
+       * https://github.com/import-js/eslint-plugin-import/issues/3140
+       * eslint-plugin-import-node 解析器不支持 export 字段，所以不得不使用 eslint-plugin-import-typescript
+       */
+      typescript: true,
+    },
+  },
+});
+
+export { javascriptConfig };
+export default javascriptConfig;

package/lib/configs/package.js

@@ -0,0 +1,26 @@
+import { defineConfig } from 'eslint/config';
+import eslintPluginJsonc from 'eslint-plugin-jsonc';
+
+/**
+ * defineConfig 会 flat 一层 extends，并且将 files 字段赋值给所有 extends
+ * 可以借助这个函数为所有插件添加 files 约束，防止语言之间的污染
+ */
+const packageJsonConfig = defineConfig({
+  extends: [...eslintPluginJsonc.configs['flat/prettier']],
+  rules: {
+    'jsonc/sort-keys': [
+      'warn',
+      {
+        pathPattern: '^$',
+        order: ['name', 'version', 'author', 'scripts', 'dependencies', 'devDependencies'],
+      },
+      {
+        pathPattern: '^(?:dev|peer|optional|bundled)?[Dd]ependencies$',
+        order: { type: 'asc' },
+      },
+    ],
+  },
+});
+
+export { packageJsonConfig };
+export default packageJsonConfig;

package/lib/configs/prettier.js

@@ -0,0 +1,26 @@
+import recommended from 'eslint-plugin-prettier/recommended';
+
+const prettierConfig = [
+  recommended,
+  {
+    rules: {
+      'prettier/prettier': [
+        'warn',
+        {
+          // 优先使用单引号
+          singleQuote: true,
+          printWidth: 110,
+          // 需要分号
+          semi: true,
+          // 仅在 es5 中有效的结构尾随逗号
+          trailingComma: 'es5',
+          // 不读取 prettier 配置文件，统一走 eslint 配置
+          usePrettierrc: false,
+        },
+      ],
+    },
+  },
+];
+
+export { prettierConfig };
+export default prettierConfig;

package/lib/configs/typescript.js

@@ -0,0 +1,58 @@
+import eslintJs from '@eslint/js';
+import { defineConfig } from 'eslint/config';
+import eslintPluginImport from 'eslint-plugin-import';
+import tsEslint from 'typescript-eslint';
+
+import eslintPrettier from './prettier.js';
+/**
+ * defineConfig 会 flat 一层 extends，并且将 files 字段赋值给所有 extends
+ * 可以借助这个函数为所有插件添加 files 约束，防止语言之间的污染
+ */
+const typescriptConfig = defineConfig({
+  extends: [
+    eslintJs.configs.recommended,
+    ...tsEslint.configs.recommended,
+    ...tsEslint.configs.stylistic,
+    eslintPluginImport.flatConfigs.recommended,
+    eslintPluginImport.flatConfigs.typescript,
+    ...eslintPrettier,
+  ],
+  files: ['**/*.{ts,tsx}'],
+  rules: {
+    'import/order': [
+      'warn',
+      {
+        groups: ['builtin', 'external', 'internal', ['parent', 'sibling'], 'object', 'type', 'index'],
+        'newlines-between': 'always',
+        pathGroupsExcludedImportTypes: ['builtin'],
+        alphabetize: { order: 'asc', caseInsensitive: true },
+        pathGroups: [
+          {
+            pattern: 'react**',
+            group: 'external',
+            position: 'before',
+          },
+          {
+            pattern: '{@/**,@**}',
+            group: 'internal',
+            position: 'before',
+          },
+          {
+            pattern: '**/*.{scss,json,svg,css,less}',
+            group: 'index',
+            position: 'after',
+          },
+        ],
+      },
+    ],
+  },
+  settings: {
+    'import/resolver': {
+      node: true,
+      typescript: true,
+    },
+  },
+});
+
+export { typescriptConfig };
+export default typescriptConfig;

package/lib/index.js

@@ -0,0 +1,17 @@
+import { defineConfig } from 'eslint/config';
+
+import { javascriptConfig } from './configs/javascript.js';
+import { packageJsonConfig } from './configs/package.js';
+import { typescriptConfig } from './configs/typescript.js';
+
+export const recommended = defineConfig(javascriptConfig, typescriptConfig, packageJsonConfig);
+export const javascript = javascriptConfig;
+export const typescript = typescriptConfig;
+export const packageJson = packageJsonConfig;
+
+export default {
+  recommended,
+  javascript,
+  typescript,
+  packageJson,
+};

package/package.json

@@ -1,24 +1,41 @@
 {
   "name": "@july_cm/eslint-config",
-  "version": "1.0.0",
-  "main": "index.js",
-  "author": "",
-  "license": "ISC",
+  "version": "2.0.0",
+  "main": "./lib/index.js",
+  "type": "module",
+  "files": [
+    "README.md",
+    "lib"
+  ],
+  "author": "July",
+  "dependencies": {
+    "@eslint/js": "^9.22.0",
+    "eslint-config-prettier": "^10.1.1",
+    "eslint-import-resolver-node": "^0.3.9",
+    "eslint-import-resolver-typescript": "^3.8.6",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-jsonc": "^2.19.1",
+    "eslint-plugin-prettier": "^5.2.3",
+    "typescript-eslint": "^8.26.1"
+  },
   "devDependencies": {
-    "eslint": "^7.32.0"
+    "@release-it/conventional-changelog": "^10.0.0",
+    "eslint": "^9.22.0",
+    "release-it": "^18.1.2",
+    "release-it-pnpm": "^4.6.4"
   },
-  "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.29.2",
-    "@typescript-eslint/parser": "^4.29.2",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^3.4.1",
-    "eslint-plugin-react": "^7.24.0",
-    "prettier": "^2.3.2"
+  "optionalPeerDependencies": {
+    "eslint": "^9"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Crownprime/eslint-config.git"
+    "url": "https://github.com/JxJuly/eslint-config.git"
+  },
+  "homepage": "https://github.com/JxJuly/eslint-config/blob/main/README.md",
+  "bugs": {
+    "url": "https://github.com/JxJuly/eslint-config/issues"
   },
-  "homepage": "https://github.com/Crownprime/eslint-config#readme",
-  "description": ""
-}
+  "scripts": {
+    "release": "release-it -ci"
+  }
+}

package/index.js

@@ -1,19 +0,0 @@
-module.export = {
-  "parser": "@typescript-eslint/parser",
-  "extends": ["plugin:@typescript-eslint/recommended", "prettier"],
-  "plugins": ["@typescript-eslint", "react", "prettier"],
-  "rules": {
-    "@typescript-eslint/explicit-module-boundary-types": 0,
-    "prettier/prettier": ["error", {
-      "printWidth": 80,
-      "tabWidth": 2,
-      "useTabs": false,
-      "semi": false,
-      "singleQuote": true,
-      "trailingComma": "all",
-      "bracketSpacing": true,
-      "jsxBracketSameLine": false,
-      "arrowParens": "avoid"
-    }]
-  }
-}