@polyv/eslint-config 0.5.0-beta.1 → 0.6.0-beta.2

package/README.md

@@ -2,25 +2,41 @@
 
 ## 用法
 
-### 安装配置
+### 安装
 
 ```bash
 npm install @polyv/eslint-config --save-dev
 ```
 
-### 调用配置
+此外，根据工程使用的技术栈，还需要安装以下依赖：
+
+| 依赖 | 版本要求 | 纯 JS 工程 | 纯 TS 工程 | Vue.js 工程（JS） |
+| --- | --- | --- | --- | --- |
+| eslint | >=8.0.0 | √ | √ | √ |
+| eslint-plugin-import | >= 2.0.0 | √ | √ | √ |
+| eslint-plugin-promise | >= 6.1.0 | √ | √ | √ |
+| eslint-plugin-sonarjs | >= 0.18.0 | √ | √ | √ |
+| @babel/core | >=7.19.0 | √ |  | √ |
+| @babel/eslint-parser | >=7.19.0 | √ |  | √ |
+| typescript | >=4.0.0 | | √ | |
+| @typescript-eslint/eslint-plugin | >=5.0.0 | | √ | |
+| @typescript-eslint/parser | >=5.0.0 | | √ |
+| eslint-plugin-vue | >=9.0.0 | | | √ |
+| vue-eslint-parser | >=9.0.0 | | | √ |
+| @vue/eslint-config-standard | >=7.0.0 | | | √ |
+
+### 调用
 
 创建 `.eslintrc.js`（一般在工程根目录下创建），并配置 `extends` 字段：
 
 ```javascript
 /* eslint-env node */
 
-// TypeScript 工程的配置
+// 纯 JS 工程的配置
 module.exports = {
   root: true,
   extends: [
-    './node_modules/@polyv/eslint-config/lib/for-js',
-    './node_modules/@polyv/eslint-config/lib/for-ts'
+    './node_modules/@polyv/eslint-config/lib/for-js'
   ]
 };
 ```
@@ -28,24 +44,37 @@ module.exports = {
 ```javascript
 /* eslint-env node */
 
-// Vue.js 工程（不含 TypeScript）的配置
+// 纯 TS 工程的配置
 module.exports = {
   root: true,
   extends: [
-    './node_modules/@polyv/eslint-config/lib/for-vue'
+    './node_modules/@polyv/eslint-config/lib/for-js',
+    './node_modules/@polyv/eslint-config/lib/for-ts'
   ]
 };
 ```
 
-
 ```javascript
 /* eslint-env node */
 
-// JavaScript 工程的配置
+// Vue.js 工程（JS）的配置
 module.exports = {
   root: true,
   extends: [
-    './node_modules/@polyv/eslint-config/lib/for-js'
+    './node_modules/@polyv/eslint-config/lib/for-vue'
   ]
 };
-```
+```
+
+## 注意点
+
+### 生产环境构建的差异
+
+部分规则在 `NODE_ENV` 为 `production` 时，告警级别为错误，其他情况下为警告。这些规则包括：
+
+- no-debugger
+- no-unused-vars
+- no-constant-condition
+- no-empty
+- @typescript-eslint/no-unused-vars
+- @typescript-eslint/explicit-module-boundary-types

package/lib/for-js.js

@@ -21,7 +21,8 @@ module.exports = {
   ],
   extends: [
     'eslint:recommended',
-    'plugin:sonarjs/recommended',
+    'plugin:import/recommended',
+    'plugin:sonarjs/recommended'
   ],
   rules: {
     'no-debugger': devWarnProdError,
@@ -109,6 +110,7 @@ module.exports = {
     'no-lonely-if': 'off',
     'curly': ['error', 'multi-line'],
     'wrap-iife': ['error', 'inside'],
+    'import/no-unresolved': 'off',
 
     // ES6
     'no-var': 'error',
@@ -119,17 +121,13 @@ module.exports = {
     'no-template-curly-in-string': 'off',
     'arrow-spacing': 'error',
     'no-confusing-arrow': 'error',
-    'import/order': 'off',
-    'unicorn/prefer-includes': 'off',
     'promise/prefer-await-to-then': 'error',
 
-    // Node
-    'node/no-callback-literal': 'off',
-
     // SonarJS
     'sonarjs/cognitive-complexity': ['error', 18],
     'sonarjs/no-duplicate-string': ['error', 5],
     'sonarjs/prefer-single-boolean-return': 'off',
-    'sonarjs/no-collection-size-mischeck': 'off'
+    'sonarjs/no-collection-size-mischeck': 'off',
+    'sonarjs/no-nested-template-literals': 'warn'
   }
 };

package/lib/for-ts.js

@@ -26,6 +26,8 @@ module.exports = {
       }],
       '@typescript-eslint/comma-spacing': ['error'],
       '@typescript-eslint/no-duplicate-imports': ['error'],
+      '@typescript-eslint/no-empty-function': 'off',
+      '@typescript-eslint/no-empty-interface': 'off',
       '@typescript-eslint/type-annotation-spacing': ['error', {
         after: true,
         before: false,
@@ -46,7 +48,7 @@ module.exports = {
         'classes': false,
         'variables': true
       }],
-      '@typescript-eslint/explicit-module-boundary-types': ['error']
+      '@typescript-eslint/explicit-module-boundary-types': devWarnProdError
     }
   }]
 };

package/lib/for-vue.js

@@ -35,7 +35,9 @@ module.exports = Object.assign({}, jsConfig, {
     // 为兼容以前代码而设为 warn
     'vue/custom-event-name-casing': ['warn', 'kebab-case'],
     'vue/no-mutating-props': 'warn',
-    'vue/multi-word-component-names': 'warn',
+    'vue/multi-word-component-names': ['warn', {
+      ignores: ['index', 'Index']
+    }],
     'vue/attribute-hyphenation': ['warn', 'always'],
     'vue/v-on-event-hyphenation': ['warn', 'always']
   }

package/package.json

@@ -1,30 +1,41 @@
 {
   "name": "@polyv/eslint-config",
-  "version": "0.5.0-beta.1",
+  "version": "0.6.0-beta.2",
   "description": "Standard ESLint configuration for Polyv projects.",
-  "keywords": ["polyv", "eslint", "config"],
+  "keywords": [
+    "polyv",
+    "eslint",
+    "config"
+  ],
   "homepage": "https://www.polyv.net/",
   "license": "MIT",
-  "dependencies": {
-    "@babel/eslint-parser": "^7.19.1",
-    "@typescript-eslint/eslint-plugin": "^5.51.0",
-    "@typescript-eslint/parser": "^5.51.0",
-    "@vue/eslint-config-standard": "^6.1.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-sonarjs": "^0.18.0",
-    "eslint-plugin-vue": "^9.9.0",
-    "vue-eslint-parser": "^9.1.0"
-  },
   "peerDependencies": {
     "@babel/core": ">=7.19.0",
+    "@babel/eslint-parser": ">=7.19.0",
+    "@typescript-eslint/eslint-plugin": ">=5.0.0",
+    "@typescript-eslint/parser": ">=5.0.0",
+    "@vue/eslint-config-standard": ">=7.0.0",
     "eslint": ">=8.0.0",
-    "typescript": ">=4.0.0"
+    "eslint-plugin-import": ">=2.0.0",
+    "eslint-plugin-node": ">=11.1.0",
+    "eslint-plugin-promise": ">=6.1.0",
+    "eslint-plugin-sonarjs": ">=0.18.0",
+    "eslint-plugin-vue": ">=9.0.0",
+    "typescript": ">=4.0.0",
+    "vue-eslint-parser": ">=9.0.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.19.6",
-    "eslint": "^8.33.0",
-    "typescript": "^4.9.5"
+    "@babel/core": "^7.21.4",
+    "@babel/eslint-parser": "^7.21.3",
+    "@typescript-eslint/eslint-plugin": "^5.59.1",
+    "@typescript-eslint/parser": "^5.59.1",
+    "@vue/eslint-config-standard": "^8.0.1",
+    "eslint": "^8.39.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-sonarjs": "^0.19.0",
+    "eslint-plugin-vue": "^9.11.0",
+    "typescript": "^5.0.4",
+    "vue-eslint-parser": "^9.1.1"
   }
 }