@polyv/eslint-config 0.3.0

package/.editorconfig

@@ -0,0 +1,5 @@
+[*.{js,jsx,ts,tsx,mjs,vue,css,scss,html,json,md,txt}]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true

package/.eslintrc.js

@@ -0,0 +1,3 @@
+const config = require('./lib/for-js');
+config.env.node = true;
+module.exports = config;

package/.gitattributes

@@ -0,0 +1,12 @@
+*.js eol=lf
+*.jsx eol=lf
+*.ts eol=lf
+*.tsx eol=lf
+*.mjs eol=lf
+*.vue eol=lf
+*.css eol=lf
+*.scss eol=lf
+*.html eol=lf
+*.json eol=lf
+*.txt eol=lf
+*.md eol=lf

package/README.md

@@ -0,0 +1,51 @@
+# 保利威前端工程 ESLint 通用配置
+
+## 用法
+
+### 安装配置
+
+```bash
+npm install @polyv/eslint-config --save-dev
+```
+
+### 调用配置
+
+创建 `.eslintrc.js`（一般在工程根目录下创建），并配置 `extends` 字段：
+
+```javascript
+/* eslint-env node */
+
+// TypeScript 工程的配置
+module.exports = {
+  root: true,
+  extends: [
+    './node_modules/@polyv/eslint-config/lib/for-js',
+    './node_modules/@polyv/eslint-config/lib/for-ts'
+  ]
+};
+```
+
+```javascript
+/* eslint-env node */
+
+// Vue.js 工程（不含 TypeScript）的配置
+module.exports = {
+  root: true,
+  extends: [
+    './node_modules/@polyv/eslint-config/lib/for-vue'
+  ]
+};
+```
+
+
+```javascript
+/* eslint-env node */
+
+// JavaScript 工程的配置
+module.exports = {
+  root: true,
+  extends: [
+    './node_modules/@polyv/eslint-config/lib/for-js'
+  ]
+};
+```

package/lib/for-js.js

@@ -0,0 +1,141 @@
+/**
+ * JavaScript 验证规则（基础规则）。
+ */
+
+const { devWarnProdError } = require('./util');
+
+module.exports = {
+  parser: '@babel/eslint-parser',
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+    requireConfigFile: false
+  },
+  env: {
+    browser: true,
+    es6: true
+  },
+  plugins: [
+    'promise',
+    'sonarjs'
+  ],
+  extends: [
+    'eslint:recommended',
+    'plugin:sonarjs/recommended',
+  ],
+  // add your custom rules here
+  rules: {
+    // 调试
+    'no-console': [
+      devWarnProdError,
+      { 'allow': ['info', 'warn', 'error', 'time', 'timeEnd'] }
+    ],
+    'no-debugger': devWarnProdError,
+
+    // 基本
+    'semi': ['error', 'always'],
+    'indent': ['error', 2, {
+      'SwitchCase': 1
+    }],
+    'brace-style': ['error', '1tbs', {
+      'allowSingleLine': true
+    }],
+    'quotes': ['error', 'single'],
+
+    // 变量
+    'new-cap': 'error',
+    'camelcase': 'error',
+    'no-use-before-define': ['error', {
+      functions: false,
+      classes: false,
+      variables: true
+    }],
+    'no-unused-vars': [devWarnProdError, {
+      vars: 'all',
+      args: 'after-used'
+    }],
+
+    // 空白与换行
+    'semi-spacing': 'error',
+    'array-bracket-spacing': ['error', 'never'],
+    'block-spacing': ['error', 'always'],
+    'computed-property-spacing': 'error',
+    'comma-spacing': 'error',
+    'func-call-spacing': 'error',
+    'key-spacing': 'error',
+    'keyword-spacing': 'error',
+    'no-trailing-spaces': 'error',
+    'no-whitespace-before-property': 'error',
+    'space-before-blocks': 'error',
+    'space-before-function-paren': ['error', {
+      anonymous: 'never',
+      named: 'never',
+      asyncArrow: 'always'
+    }],
+    'space-in-parens': 'error',
+    'space-infix-ops': 'error',
+    'space-unary-ops': 'error',
+    'spaced-comment': ['error', 'always', {
+      'block': {
+        'markers': ['!'],
+        'balanced': true
+      }
+    }],
+    'object-curly-spacing': ['error', 'always'],
+    'object-property-newline': ['error', {
+      allowAllPropertiesOnSameLine: true
+    }],
+    'operator-linebreak': ['error', 'after'],
+    'eol-last': ['error', 'always'],
+    'padded-blocks': 'off',
+
+    // 逗号
+    'comma-dangle': ['error', 'only-multiline'],
+    'comma-style': 'error',
+
+    // 其他
+    'no-extra-bind': 'error',
+    'no-extra-label': 'error',
+    'no-floating-decimal': 'error',
+    'no-implied-eval': 'error',
+    'no-iterator': 'error',
+    'no-loop-func': 'error',
+    'no-multi-spaces': 'error',
+    'no-proto': 'error',
+    'no-script-url': 'error',
+    'no-throw-literal': 'error',
+    'no-useless-call': 'error',
+    'no-new': 'off',
+    'no-with': 'error',
+    'no-constant-condition': devWarnProdError,
+    'no-cond-assign': ['error', 'except-parens'],
+    'no-empty': [devWarnProdError, {
+      'allowEmptyCatch': true
+    }],
+    'no-lonely-if': 'off',
+    'curly': ['error', 'multi-line'],
+    'wrap-iife': ['error', 'inside'],
+
+    // ES6
+    'no-var': 'error',
+    'prefer-const': 'error',
+    'no-duplicate-imports': 'error',
+    'prefer-promise-reject-errors': 'error',
+    'template-curly-spacing': ['error', 'never'],
+    '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'
+  }
+};

package/lib/for-ts.js

@@ -0,0 +1,52 @@
+/**
+ * TypeScript 工程的附加验证规则。
+ */
+
+const { devWarnProdError } = require('./util');
+
+module.exports = {
+  overrides: [{
+    files: ['*.ts', '*.tsx'],
+    parser: '@typescript-eslint/parser',
+    plugins: [
+      '@typescript-eslint'
+    ],
+    extends: [
+      'plugin:@typescript-eslint/recommended'
+    ],
+    rules: {
+      'semi': 'off',
+      'indent': 'off',
+      'no-use-before-define': 'off',
+      'no-unused-vars': 'off',
+      'comma-spacing': 'off',
+      '@typescript-eslint/semi': ['error', 'always'],
+      '@typescript-eslint/indent': ['error', 2, {
+        'SwitchCase': 1
+      }],
+      '@typescript-eslint/comma-spacing': ['error'],
+      '@typescript-eslint/no-duplicate-imports': ['error'],
+      '@typescript-eslint/type-annotation-spacing': ['error', {
+        after: true,
+        before: false,
+        overrides: {
+          arrow: {
+            before: true,
+            after: true
+          }
+        }
+      }],
+      '@typescript-eslint/no-var-requires': 'off',
+      '@typescript-eslint/no-unused-vars': [devWarnProdError, {
+        vars: 'all',
+        args: 'after-used'
+      }],
+      '@typescript-eslint/no-use-before-define': ['error', {
+        'functions': false,
+        'classes': false,
+        'variables': true
+      }],
+      '@typescript-eslint/explicit-module-boundary-types': ['error']
+    }
+  }]
+};

package/lib/for-vue.js

@@ -0,0 +1,42 @@
+/**
+ * Vue.js 工程的验证规则。
+ */
+
+const jsConfig = require('./for-js');
+
+module.exports = Object.assign({}, jsConfig, {
+  parser: 'vue-eslint-parser',
+  parserOptions: {
+    parser: '@babel/eslint-parser',
+    ...jsConfig.parserOptions
+  },
+  extends: [
+    ...jsConfig.extends,
+    '@vue/standard',
+    'plugin:vue/essential'
+  ],
+  rules: {
+    ...jsConfig.rules,
+    'vue/html-indent': ['error', 2],
+    'vue/html-self-closing': ['error', {
+      html: {
+        void: 'always',
+        normal: 'never',
+        component: 'always'
+      }
+    }],
+    'vue/no-v-html': 'off',
+    'vue/max-attributes-per-line': ['error', {
+      singleline: 3,
+      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',
+    'vue/attribute-hyphenation': ['warn', 'always'],
+    'vue/v-on-event-hyphenation': ['warn', 'always']
+  }
+});

package/lib/util.js

@@ -0,0 +1 @@
+exports.devWarnProdError = process.env.NODE_ENV === 'production' ? 'error' : 'warn';

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@polyv/eslint-config",
+  "version": "0.3.0",
+  "description": "Universal ESLint configuration for Polyv projects.",
+  "license": "MIT",
+  "dependencies": {
+    "@babel/core": "^7.18.10",
+    "@babel/eslint-parser": "^7.18.9",
+    "@typescript-eslint/eslint-plugin": "^5.33.0",
+    "@typescript-eslint/parser": "^5.33.0",
+    "@vue/eslint-config-standard": "^6.1.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-sonarjs": "^0.15.0",
+    "eslint-plugin-vue": "^9.3.0",
+    "vue-eslint-parser": "^9.0.2"
+  },
+  "peerDependencies": {
+    "eslint": ">=8.0.0",
+    "typescript": ">=4.0.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.21.0",
+    "typescript": "^4.7.4"
+  }
+}