@july_cm/eslint-config 2.4.0 → 2.4.1

package/README.md

@@ -1,5 +1,7 @@
 # @july_cm/eslint-config
 
+[简体中文](./README.zh-CN.md) | English
+
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
 [![NPM Version](https://img.shields.io/npm/v/%40july_cm%2Feslint-config)](https://www.npmjs.com/package/@july_cm/eslint-config)
 [![codecov](https://codecov.io/gh/JxJuly/eslint-config/branch/main/graph/badge.svg?token=T1E32RHZB7)](https://codecov.io/gh/JxJuly/eslint-config)
@@ -12,17 +14,17 @@ 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
+## Features
 
-- ✅ 开箱即用且轻量的 JavaScript ESLint 配置
+- ✅ Out-of-the-box and lightweight JavaScript ESLint configuration
 
-- ✅ 开箱即用且轻量的 TypeScript ESLint 配置
+- ✅ Out-of-the-box and lightweight TypeScript ESLint configuration
 
-- ✅ 开箱即用且轻量的 CSS ESLint 配置
+- ✅ Out-of-the-box and lightweight CSS ESLint configuration
 
-- ✅ 支持 package.json 字段的排序，尤其是 dependencies 等字段
+- ✅ Support for package.json field sorting, especially dependencies and other fields
 
-- ✅ 搭配 prettier 规则的代码风格检查
+- ✅ Code style checking with Prettier rules
 
 ## Installation
 
@@ -32,11 +34,11 @@ npm install --save-dev eslint @july_cm/eslint-config
 
 `@july_cm/eslint-config` does not install ESLint for you. You must install these yourself.
 
-## 快速开始
+## Quick Start
 
-扁平化的配置，可以使用指定的编程语言配置或者直接使用推荐配置。
+Flat configuration allows you to use specific programming language configurations or directly use the recommended configuration.
 
-直接使用 `recommended` 也无需担心 `.ts` 文件被 `javascript` 规则命中，本包内部已经做了规则的隔离，以保证规则和性能的稳定。
+When using `recommended` directly, you don't need to worry about `.ts` files being matched by `javascript` rules. This package has internally isolated the rules to ensure stable rules and performance.
 
 ```javascript
 // eslint.config.js
@@ -57,11 +59,11 @@ export default config.typescript;
 export default config.recommended;
 ```
 
-⚠️ 需要注意：若 `package.json` 中的 `type` 字段没有显示设置为 `module`，则文件名需要改为 `eslint.config.mjs`.
+⚠️ Note: If the `type` field in `package.json` is not explicitly set to `module`, the filename needs to be changed to `eslint.config.mjs`.
 
-## 自定义规则
+## Custom Rules
 
-支持自定义规则或者配置，建议使用 ESLint 官方的函数 `defineConfig` 作为合并函数：
+Custom rules or configurations are supported. It is recommended to use ESLint's official `defineConfig` function as the merge function:
 
 ```javascript
 // eslint.config.js
@@ -117,7 +119,9 @@ The sorting functionality is implemented based on [eslint-plugin-jsonc](https://
     {
       "editor.codeActionsOnSave": {
         "source.fixAll.eslint": "explicit"
-      }
+      },
+      // ESLint does not validate css, json, jsonc by default, needs to be added manually
+      "eslint.validate": ["css", "json", "jsonc", "javascript", "javascriptreact", "typescript", "typescriptreact"]
     }
     ```
 

package/README.zh-CN.md

@@ -0,0 +1,135 @@
+# @july_cm/eslint-config
+
+简体中文 | [English](./README.md)
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![NPM Version](https://img.shields.io/npm/v/%40july_cm%2Feslint-config)](https://www.npmjs.com/package/@july_cm/eslint-config)
+[![codecov](https://codecov.io/gh/JxJuly/eslint-config/branch/main/graph/badge.svg?token=T1E32RHZB7)](https://codecov.io/gh/JxJuly/eslint-config)
+
+这是我的通用 ESLint 配置。
+
+它依赖于 ESLint v9 或更高版本，并且仅兼容扁平化配置。
+
+❌ [传统配置](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated) (legacy: `.eslintrc*`)
+
+✅ [扁平化配置](https://eslint.org/docs/latest/use/configure/configuration-files-new) (new: `eslint.config.js`)
+
+## 功能
+
+- ✅ 开箱即用且轻量的 JavaScript ESLint 配置
+
+- ✅ 开箱即用且轻量的 TypeScript ESLint 配置
+
+- ✅ 开箱即用且轻量的 CSS ESLint 配置
+
+- ✅ 支持 package.json 字段的排序，尤其是 dependencies 等字段
+
+- ✅ 搭配 Prettier 规则的代码风格检查
+
+## 安装
+
+```sh
+npm install --save-dev eslint @july_cm/eslint-config
+```
+
+`@july_cm/eslint-config` 不会为你安装 ESLint，你必须自己安装。
+
+## 快速开始
+
+扁平化的配置，可以使用指定的编程语言配置或者直接使用推荐配置。
+
+直接使用 `recommended` 也无需担心 `.ts` 文件被 `javascript` 规则命中，本包内部已经做了规则的隔离，以保证规则和性能的稳定。
+
+```javascript
+// eslint.config.js
+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;
+```
+
+⚠️ 需要注意：若 `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: {}
+})
+```
+
+
+## 中止 `package.json` 键排序
+
+排序功能基于 [eslint-plugin-jsonc](https://github.com/ota-meshi/eslint-plugin-jsonc) 和 [prettier](https://github.com/prettier/prettier) 实现。
+
+```javascript
+[{
+  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']
+}]
+```
+
+## 配合 `Visual Studio Code` 使用
+
+1. 安装 [VS Code ESLint 扩展](https://github.com/microsoft/vscode-eslint)。
+
+    检查编辑器中是否有其他插件被设置为默认格式化程序。如果有，需要将它们移除或替换为 ESLint：
+
+    ```json
+    {
+      "editor.defaultFormatter": "dbaeumer.vscode-eslint",
+    }
+    ```
+
+    如果 Prettier 扩展在此工作区中也处于活动状态，应该禁用它。这是因为两者会相互冲突，导致格式化问题。
+
+    `@july_cm/eslint-config` 已经集成了 `eslint-plugin-prettier`，确保两者可以同时工作而不会冲突。
+
+
+2. 保存时自动修复
+
+    ```json
+    {
+      "editor.codeActionsOnSave": {
+        "source.fixAll.eslint": "explicit"
+      },
+      // ESLint 默认不对 css, json, jsonc 进行校验，需要手动添加
+      "eslint.validate": ["css", "json", "jsonc", "javascript", "javascriptreact", "typescript", "typescriptreact"]
+    }
+    ```
+
+3. 调试
+
+    打开 VSCode 命令面板（Ctrl + Shift + P / Cmd + Shift + P）并运行：
+
+    ```
+    ESLint: Show Output Channel
+    ```
+    如果存在错误，请修复它们。

package/lib/index.cjs

@@ -122,7 +122,8 @@ const packageJsonConfig = config.defineConfig({
       },
       {
         pathPattern: "exports",
-        order: ["types", "require", "import"]
+        // Prefer ESM (import) before CommonJS (require)
+        order: ["types", "import", "require"]
       }
     ]
   }
@@ -130,7 +131,6 @@ const packageJsonConfig = config.defineConfig({
 const typescriptConfig = config.defineConfig({
   extends: [
     eslintJs.configs.recommended,
-    // @ts-expect-error - https://github.com/eslint/rewrite/issues/234
     typescriptEslint.configs.stylistic,
     eslintPluginImport.flatConfigs.recommended,
     eslintPluginImport.flatConfigs.typescript,

package/lib/index.mjs

@@ -120,7 +120,8 @@ const packageJsonConfig = defineConfig({
       },
       {
         pathPattern: "exports",
-        order: ["types", "require", "import"]
+        // Prefer ESM (import) before CommonJS (require)
+        order: ["types", "import", "require"]
       }
     ]
   }
@@ -128,7 +129,6 @@ const packageJsonConfig = defineConfig({
 const typescriptConfig = defineConfig({
   extends: [
     eslintJs.configs.recommended,
-    // @ts-expect-error - https://github.com/eslint/rewrite/issues/234
     configs.stylistic,
     eslintPluginImport.flatConfigs.recommended,
     eslintPluginImport.flatConfigs.typescript,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@july_cm/eslint-config",
-  "version": "2.4.0",
+  "version": "2.4.1",
   "author": "July",
   "exports": {
     ".": {
@@ -22,24 +22,24 @@
     "release": "release-it -ci"
   },
   "dependencies": {
-    "@eslint/css": "^0.10.0",
-    "@eslint/js": "^9.33.0",
+    "@eslint/css": "^0.14.1",
+    "@eslint/js": "^9.39.1",
     "eslint-config-prettier": "^10.1.8",
     "eslint-import-resolver-node": "^0.3.9",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-jsonc": "^2.20.1",
+    "eslint-plugin-jsonc": "^2.21.0",
     "eslint-plugin-prettier": "^5.5.4",
-    "typescript-eslint": "^8.39.1"
+    "typescript-eslint": "^8.49.0"
   },
   "devDependencies": {
-    "@release-it/conventional-changelog": "^10.0.1",
-    "@vitest/coverage-v8": "^3.2.4",
-    "eslint": "^9.33.0",
-    "release-it": "^19.0.4",
-    "typescript": "^5.9.2",
-    "vite": "^7.1.2",
-    "vitest": "^3.2.4"
+    "@release-it/conventional-changelog": "^10.0.3",
+    "@vitest/coverage-v8": "^4.0.15",
+    "eslint": "^9.39.1",
+    "release-it": "^19.1.0",
+    "typescript": "^5.9.3",
+    "vite": "^7.2.7",
+    "vitest": "^4.0.15"
   },
   "optionalPeerDependencies": {
     "eslint": "^9",