@july_cm/eslint-config 0.0.2

package/README.md

@@ -0,0 +1,88 @@
+# @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 { javascriptConfig, typescriptConfig, packageJsonConfig } from '@july_cm/eslint-config';
+
+// only javascript
+export default javascriptConfig;
+
+// only typescript
+export default typescriptConfig;
+
+// recommended
+export default [
+  ...javascriptConfig,
+  ...typescriptConfig,
+  ...packageJsonConfig
+]
+```
+
+
+## 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/config-merge.js

@@ -0,0 +1,5 @@
+const configMerge = (configs, config) => {
+  return configs.map((conf) => ({ ...conf, ...config }));
+};
+
+export { configMerge };

package/lib/configs/javascript.js

@@ -0,0 +1,13 @@
+import eslintJs from '@eslint/js';
+
+import { configMerge } from './config-merge.js';
+import eslintPrettier from './prettier.js';
+
+const configs = [eslintJs.configs.recommended, ...eslintPrettier];
+
+const javascriptConfig = configMerge(configs, {
+  files: ['**/*.{js,mjs,cjs,jsx}'],
+});
+
+export { javascriptConfig };
+export default javascriptConfig;

package/lib/configs/package.js

@@ -0,0 +1,29 @@
+import eslintPluginJsonc from 'eslint-plugin-jsonc';
+
+import { configMerge } from './config-merge.js';
+
+const configs = [
+  ...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' },
+        },
+      ],
+    },
+  },
+];
+
+const packageJsonConfig = configMerge(configs, {
+  files: ['package.json'],
+});
+
+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,53 @@
+import eslintJs from '@eslint/js';
+
+import tsEslint from 'typescript-eslint';
+import eslintPluginImportX from 'eslint-plugin-import-x';
+import eslintPrettier from './prettier.js';
+
+import { configMerge } from './config-merge.js';
+
+const configs = [
+  eslintJs.configs.recommended,
+  ...tsEslint.configs.recommended,
+  ...tsEslint.configs.stylistic,
+  ...eslintPrettier,
+  eslintPluginImportX.flatConfigs.recommended,
+  eslintPluginImportX.flatConfigs.typescript,
+  {
+    rules: {
+      'import-x/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}',
+              group: 'index',
+              position: 'after',
+            },
+          ],
+        },
+      ],
+    },
+  },
+];
+
+const typescriptConfig = configMerge(configs, {
+  files: ['**/*.{ts,tsx}'],
+});
+
+export { typescriptConfig };
+export default typescriptConfig;

package/lib/index.js

@@ -0,0 +1,3 @@
+export { packageJsonConfig } from './configs/package.js';
+export { javascriptConfig } from './configs/javascript.js';
+export { typescriptConfig } from './configs/typescript.js';

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@july_cm/eslint-config",
+  "version": "0.0.2",
+  "main": "./lib/index.js",
+  "type": "module",
+  "files": ["README.md", "lib"],
+  "dependencies": {
+    "@eslint/js": "^9.22.0",
+    "eslint-config-prettier": "^10.1.1",
+    "eslint-plugin-import-x": "^4.6.1",
+    "eslint-plugin-jsonc": "^2.19.1",
+    "eslint-plugin-prettier": "^5.2.3",
+    "typescript-eslint": "^8.26.1"
+  },
+  "devDependencies": {
+    "eslint": "^9.22.0"
+  },
+  "optionalPeerDependencies": {
+    "eslint": "^9"
+  }
+}