# ESLint

JavaScript 和 TypeScript 代码风格检查与自动修复工具。

# 原则

提交至 Git 仓库的代码都应可通过 ESLint 检查且无错误。
禁止以该条规则过于严格作为理由要求关闭该规则检查，但可提出配置不合理，要求修改规则配置。(配置会在合理的范围内越来越严格，帮助提升代码质量)
禁止个人私自关闭项目 ESLint 配置的任何规则，但若有必要可在团队内发起评审后决定是否关闭。
代码受规则影响无法提交时，可通过注释关闭规则 (opens new window)，但应限制禁用规则作用范围尽可能小。
使用注释禁用规则时，需在其上打上 // FIXME: eslint 注释, Vue 模板中为 ，并尽快修复。
优先使用命令行 --fix 参数或者编辑器插件修复所有 可修复的 问题，避免浪费时间。

基于 eslint-config-standard (opens new window) 进行订制。

增加了最大文件行数、嵌套层级、复杂度等利于代码维护的规则限制。

$ npm i @qxy/eslint-config -D
# OR
$ yarn add @qxy/eslint-config -D

使用 .eslintrc.js 文件:

module.exports = {
  root: true,

  extends: ['@qxy'],

  rules: {
    // Override rules
  },
}

或

package.json 中配置:

{
  "eslintConfig": {
    "root": true,
    "extends": "@qxy"
  }
}

基于 eslint-plugin-vue:recommended (opens new window) 预设(最严格)进行配置

增加了所有未列入默认预设的规则，并对其进行了适当的配置。

$ npm i @qxy/eslint-config-vue babel-eslint -D
# OR
$ yarn add @qxy/eslint-config-vue babel-eslint -D

使用 .eslintrc.js 文件:

module.exports = {
  root: true,

  extends: ['@qxy/vue'],

  rules: {
    // Override rules
  },
}

或

package.json 中配置:

{
  "eslintConfig": {
    "root": true,
    "extends": "@qxy/vue"
  }
}

WARNING

规则 vue/no-unsupported-features (opens new window) 内配置了默认 Vue 版本为 ^2.6.0。若有需要可根据项目内的 Vue 版本进行配置修改。