@polyv/eslint-config 0.6.0-beta.5 → 0.7.0

package/.nvmrc

@@ -0,0 +1 @@
+20

package/README.md

@@ -1,41 +1,19 @@
 # 保利威前端工程 ESLint 通用配置
 
-## 用法
+## 安装和使用
 
-### 安装
+确保 Node.js 版本符合 **^20.10.0**（未测试其他版本的可用性），运行 npm 命令安装：
 
 ```bash
 npm install @polyv/eslint-config --save-dev
 ```
 
-此外，根据工程使用的技术栈，还需要安装以下依赖：
-
-| 依赖 | 版本要求 | 纯 JS 工程 | 纯 TS 工程 | Vue.js 工程（JS） |
-| --- | --- | --- | --- | --- |
-| eslint | >=8.0.0 | √ | √ | √ |
-| eslint-config-standard | >=17.0.0 | √ | √ | √ |
-| eslint-plugin-n | >=15.7.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-import-resolver-typescript | >=3.5.0 | | √ | |
-| eslint-plugin-vue | >=9.0.0 | | | √ |
-| vue-eslint-parser | >=9.0.0 | | | √ |
-| @vue/eslint-config-standard | >=8.0.0 | | | √ |
-
-### 调用
-
-创建 `.eslintrc.js`（一般在工程根目录下创建），并配置 `extends` 字段：
+在项目中创建 `.eslintrc.js`（一般在根目录下创建），根据工程的开发语言和框架配置 `extends` 字段：
 
 ```javascript
 /* eslint-env node */
 
-// 纯 JS 工程的配置
+// 纯 JavaScript 工程的配置
 module.exports = {
   root: true,
   extends: [
@@ -47,7 +25,7 @@ module.exports = {
 ```javascript
 /* eslint-env node */
 
-// 纯 TS 工程的配置
+// 纯 TypeScript 工程的配置
 module.exports = {
   root: true,
   extends: [
@@ -60,24 +38,37 @@ module.exports = {
 ```javascript
 /* eslint-env node */
 
-// Vue.js 工程（JS）的配置
+// Vue.js 2.x 工程（JavaScript）的配置
 module.exports = {
   root: true,
   extends: [
-    './node_modules/@polyv/eslint-config/lib/for-vue'
+    './node_modules/@polyv/eslint-config/lib/for-vue2-js'
   ]
 };
 ```
 
 ## 注意点
 
+### 严格模式
+
+部分规则在严格模式下（环境变量 `STRICT_LINT` 不为 `false` 时），告警级别为错误，其他情况为警告。这些规则包括：
+
+- sonarjs/no-nested-template-literals
+- @typescript-eslint/naming-convention
+- vue/custom-event-name-casing
+- vue/no-mutating-props
+- vue/multi-word-component-names
+- vue/attribute-hyphenation
+- vue/v-on-event-hyphenation
+
 ### 生产环境构建的差异
 
-部分规则在 `NODE_ENV` 为 `production` 时，告警级别为错误，其他情况下为警告。这些规则包括：
+部分规则在环境变量 `NODE_ENV` 为 `production` 时，告警级别为错误，其他情况下为警告。这些规则包括：
 
 - no-debugger
 - no-unused-vars
 - no-constant-condition
 - no-empty
+- sonarjs/no-duplicate-string
 - @typescript-eslint/no-unused-vars
 - @typescript-eslint/explicit-module-boundary-types

package/lib/for-js.js

@@ -2,7 +2,10 @@
  * JavaScript 验证规则（基础规则）。
  */
 
-const { devWarnProdError } = require('./util');
+const {
+  devWarnProdError,
+  strictErrorOtherwiseWarn
+} = require('./util');
 
 module.exports = {
   parser: '@babel/eslint-parser',
@@ -25,9 +28,27 @@ module.exports = {
     'plugin:sonarjs/recommended'
   ],
   rules: {
+    semi: ['error', 'always'],
+    'space-before-function-paren': ['error', {
+      anonymous: 'never',
+      named: 'never',
+      asyncArrow: 'always'
+    }],
+    'operator-linebreak': ['error', 'after', {
+      overrides: {
+        '?': 'before',
+        ':': 'before'
+      }
+    }],
+    'comma-dangle': ['error', 'only-multiline'],
+    'no-trailing-spaces': ['error', { ignoreComments: true }],
+    'no-multiple-empty-lines': ['error', { max: 2 }],
+    'wrap-iife': ['error', 'inside'],
+    'no-confusing-arrow': 'error',
+    'padded-blocks': 'off',
+
+    camelcase: 'error',
     'no-debugger': devWarnProdError,
-    'semi': ['error', 'always'],
-    'camelcase': 'error',
     'no-unused-vars': [devWarnProdError, {
       vars: 'all',
       args: 'after-used',
@@ -39,32 +60,25 @@ module.exports = {
       classes: false,
       variables: true
     }],
-    'space-before-function-paren': ['error', {
-      anonymous: 'never',
-      named: 'never',
-      asyncArrow: 'always'
-    }],
-    'operator-linebreak': ['error', 'after'],
-    'padded-blocks': 'off',
-    'comma-dangle': ['error', 'only-multiline'],
     'no-loop-func': 'error',
     'no-script-url': 'error',
     'no-new': 'off',
     'no-constant-condition': devWarnProdError,
-    'no-empty': [devWarnProdError, { 'allowEmptyCatch': true }],
+    'no-empty': [devWarnProdError, { allowEmptyCatch: true }],
     'no-lonely-if': 'off',
-    'wrap-iife': ['error', 'inside'],
     'no-var': 'error',
-    'prefer-promise-reject-errors': 'error',
     'no-template-curly-in-string': 'off',
-    'no-confusing-arrow': 'error',
+    'prefer-promise-reject-errors': 'error',
+
     'import/no-unresolved': 'off',
     'import/no-duplicates': 'error',
-    'promise/prefer-await-to-then': 'error',
-    'sonarjs/cognitive-complexity': ['error', 18],
-    'sonarjs/no-duplicate-string': ['error', 5],
+
+    'promise/prefer-await-to-then': 'warn',
+
+    'sonarjs/cognitive-complexity': ['error', 20],
+    'sonarjs/no-duplicate-string': [devWarnProdError, { threshold: 5 }],
     'sonarjs/prefer-single-boolean-return': 'off',
     'sonarjs/no-collection-size-mischeck': 'off',
-    'sonarjs/no-nested-template-literals': 'warn'
+    'sonarjs/no-nested-template-literals': strictErrorOtherwiseWarn
   }
 };

package/lib/for-ts.js

@@ -2,7 +2,10 @@
  * TypeScript 工程的附加验证规则。
  */
 
-const { devWarnProdError } = require('./util');
+const {
+  devWarnProdError,
+  strictErrorOtherwiseWarn
+} = require('./util');
 
 module.exports = {
   overrides: [{
@@ -12,12 +15,12 @@ module.exports = {
       'plugin:import/typescript'
     ],
     rules: {
-      'semi': 'off',
+      semi: 'off',
       '@typescript-eslint/semi': ['error', 'always'],
 
-      'indent': 'off',
+      indent: 'off',
       '@typescript-eslint/indent': ['error', 2, {
-        'SwitchCase': 1
+        SwitchCase: 1
       }],
 
       'comma-spacing': 'off',
@@ -28,9 +31,9 @@ module.exports = {
 
       'no-use-before-define': 'off',
       '@typescript-eslint/no-use-before-define': ['error', {
-        'functions': false,
-        'classes': false,
-        'variables': true
+        functions: false,
+        classes: false,
+        variables: true
       }],
 
       'no-unused-vars': 'off',
@@ -51,6 +54,7 @@ module.exports = {
         asyncArrow: 'always'
       }],
 
+      '@typescript-eslint/no-explicit-any': 'warn',
       '@typescript-eslint/no-empty-function': 'off',
       '@typescript-eslint/no-empty-interface': 'off',
       '@typescript-eslint/type-annotation-spacing': ['error', {
@@ -64,7 +68,7 @@ module.exports = {
         }
       }],
       '@typescript-eslint/explicit-module-boundary-types': devWarnProdError,
-      '@typescript-eslint/naming-convention': ['warn', {
+      '@typescript-eslint/naming-convention': [strictErrorOtherwiseWarn, {
         selector: 'enumMember',
         format: ['UPPER_CASE']
       }, {

package/lib/{for-vue.js → for-vue2-js.js}

@@ -2,6 +2,7 @@
  * Vue.js 工程的验证规则。
  */
 
+const { strictErrorOtherwiseWarn } = require('./util');
 const jsConfig = require('./for-js');
 
 module.exports = Object.assign({}, jsConfig, {
@@ -23,7 +24,9 @@ module.exports = Object.assign({}, jsConfig, {
         void: 'always',
         normal: 'never',
         component: 'always'
-      }
+      },
+      svg: 'always',
+      math: 'always'
     }],
     'vue/no-v-html': 'off',
     'vue/max-attributes-per-line': ['error', {
@@ -31,14 +34,12 @@ module.exports = Object.assign({}, jsConfig, {
       multiline: 1
     }],
     'vue/singleline-html-element-content-newline': 'off',
-
-    // 为兼容以前代码而设为 warn
-    'vue/custom-event-name-casing': ['warn', 'kebab-case'],
-    'vue/no-mutating-props': 'warn',
-    'vue/multi-word-component-names': ['warn', {
-      ignores: ['index', 'Index']
+    'vue/custom-event-name-casing': [strictErrorOtherwiseWarn, 'kebab-case'],
+    'vue/no-mutating-props': strictErrorOtherwiseWarn,
+    'vue/multi-word-component-names': [strictErrorOtherwiseWarn, {
+      ignores: ['index', 'Index', 'default', 'Default']
     }],
-    'vue/attribute-hyphenation': ['warn', 'always'],
-    'vue/v-on-event-hyphenation': ['warn', 'always']
+    'vue/attribute-hyphenation': [strictErrorOtherwiseWarn, 'always'],
+    'vue/v-on-event-hyphenation': [strictErrorOtherwiseWarn, 'always']
   }
 });

package/lib/util.js

@@ -1 +1,7 @@
-exports.devWarnProdError = process.env.NODE_ENV === 'production' ? 'error' : 'warn';
+exports.devWarnProdError = process.env.NODE_ENV === 'production'
+  ? 'error'
+  : 'warn';
+
+exports.strictErrorOtherwiseWarn = process.env.STRICT_LINT !== 'false'
+  ? 'error'
+  : 'warn';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polyv/eslint-config",
-  "version": "0.6.0-beta.5",
+  "version": "0.7.0",
   "description": "Standard ESLint configuration for Polyv projects.",
   "keywords": [
     "polyv",
@@ -9,39 +9,25 @@
   ],
   "homepage": "https://www.polyv.net/",
   "license": "MIT",
-  "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": ">=8.0.0",
-    "eslint": ">=8.0.0",
-    "eslint-config-standard": "17.0.0",
-    "eslint-import-resolver-typescript": ">=3.5.0",
-    "eslint-plugin-import": ">=2.0.0",
-    "eslint-plugin-n": ">=15.7.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"
+  "engines": {
+    "node": "^20.10.0"
   },
-  "devDependencies": {
-    "@babel/core": "^7.21.4",
-    "@babel/eslint-parser": "^7.21.3",
-    "@typescript-eslint/eslint-plugin": "^5.59.2",
-    "@typescript-eslint/parser": "^5.59.1",
+  "dependencies": {
+    "@babel/core": "^7.24.9",
+    "@babel/eslint-parser": "^7.24.8",
+    "@typescript-eslint/eslint-plugin": "^7.16.1",
+    "@typescript-eslint/parser": "^7.16.1",
     "@vue/eslint-config-standard": "^8.0.1",
-    "eslint": "^8.39.0",
-    "eslint-config-standard": "^17.0.0",
-    "eslint-import-resolver-typescript": "^3.5.5",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-n": "^15.7.0",
-    "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"
+    "eslint": "^8.57.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-promise": "^6.6.0",
+    "eslint-plugin-sonarjs": "^0.25.1",
+    "eslint-plugin-vue": "^9.27.0",
+    "typescript": "^5.5.3",
+    "vue-eslint-parser": "^9.4.3"
   },
   "scripts": {
     "print-config": "eslint --print-config ./lib/for-vue.js > config.txt"