@july_cm/eslint-config 2.1.0 → 2.3.0

package/README.md

@@ -8,6 +8,14 @@ It depends on ESLint v9 or later and is only compatible with Flat Configuration.
 
 ✅ [flat configuration](https://eslint.org/docs/latest/use/configure/configuration-files-new) (new: `eslint.config.js`)
 
+## 功能 ｜ Features
+
+- ✅ 开箱即用且轻量的 JavaScript ESLint 配置
+
+- ✅ 开箱即用且轻量的 TypeScript ESLint 配置
+
+- ✅ 支持 package.json 字段的排序，尤其是 dependencies 等字段
+
 ## Installation
 
 ```sh
@@ -16,9 +24,14 @@ 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
+## 快速开始
+
+扁平化的配置，可以使用指定的编程语言配置或者直接使用推荐配置。
+
+直接使用 `recommended` 也无需担心 `.ts` 文件被 `javascript` 规则命中，本包内部已经做了规则的隔离，以保证规则和性能的稳定。
 
 ```javascript
+// eslint.config.js
 const * as config from '@july_cm/eslint-config';
 
 // only javascript
@@ -36,20 +49,41 @@ export default config.typescript;
 export default config.recommended;
 ```
 
+⚠️ 需要注意：若 `package.json` 中的 `type` 字段没有显示设置为 `module`，则文件名需要改为 `eslint.config.mjs`.
+
+## 自定义规则
+
+支持自定义规则或者配置，建议使用 ESLint 官方的函数 `defineConfig` 作为合并函数：
+
+```javascript
+// eslint.config.js
+import { recommended } from '@july_cm/eslint-config';
+import { defineConfig } from 'eslint/config';
+
+export default defineConfig(recommended, {
+  ignores: ["dist"],
+  rules: {}
+})
+```
+
 
 ## 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: '^$',
+  order: ['name', 'version', 'author', 'exports', 'types', 'main', 'module', 'scripts', 'dependencies', 'devDependencies'],
+},
+{
   pathPattern: '^(?:dev|peer|optional|bundled)?[Dd]ependencies$',
   order: { type: 'asc' },
 },
+{
+  pathPattern: 'exports',
+  order: ['types', 'require', 'import']
+}]
 ```
 
 ## With `Visual Studio Code`

package/lib/configs/javascript.js

@@ -11,6 +11,9 @@ import eslintPrettier from './prettier.js';
 const javascriptConfig = defineConfig({
   extends: [eslintJs.configs.recommended, importPlugin.flatConfigs.recommended, ...eslintPrettier],
   files: ['**/*.{js,mjs,cjs,jsx}'],
+  languageOptions: {
+    ecmaVersion: 'latest',
+  },
   rules: {
     'import/order': [
       'warn',

package/lib/configs/package.js

@@ -13,12 +13,16 @@ const packageJsonConfig = defineConfig({
       'warn',
       {
         pathPattern: '^$',
-        order: ['name', 'version', 'author', 'scripts', 'dependencies', 'devDependencies'],
+        order: ['name', 'version', 'author', 'exports', 'types', 'main', 'module', 'scripts', 'dependencies', 'devDependencies'],
       },
       {
         pathPattern: '^(?:dev|peer|optional|bundled)?[Dd]ependencies$',
         order: { type: 'asc' },
       },
+      {
+        pathPattern: 'exports',
+        order: ['types', 'require', 'import']
+      }
     ],
   },
 });

package/lib/configs/typescript.js

@@ -49,6 +49,7 @@ const typescriptConfig = defineConfig({
       'error',
       { disallowTypeAnnotations: true, prefer: 'type-imports' },
     ],
+    '@typescript-eslint/no-explicit-any': ['warn'],
   },
   settings: {
     'import/resolver': {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@july_cm/eslint-config",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "main": "./lib/index.js",
   "type": "module",
   "files": [
@@ -23,7 +23,8 @@
     "eslint": "^9.22.0",
     "release-it": "^18.1.2",
     "release-it-pnpm": "^4.6.4",
-    "typescript": "^5.8.2"
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.9"
   },
   "optionalPeerDependencies": {
     "eslint": "^9",
@@ -38,6 +39,7 @@
     "url": "https://github.com/JxJuly/eslint-config/issues"
   },
   "scripts": {
+    "test": "vitest run",
     "release": "release-it -ci"
   }
 }