引言

代码风格

设计理念

• 样式相关的规则交给 Prettier 管理

• 传承 ESLint 的理念，帮助大家建立自己的规则

样式相关的规则交给 Prettier 管理

传承 ESLint 的理念，帮助大家建立自己的规则

为什么要重复造轮子

为什么不用 standard

相比于 airbnb 规则有什么优势

• eslint-config-alloy 拥有官方维护的 vue、typescript、react+typescript 规则，相比之下 airbnb 的 vue 和 typescript 都是第三方维护的

• 先进性，保证能够与时俱进，前面已经重点提到了

• 方便个性化定制，包含中文讲解和网站示例

你这个确实很好，我还是会选择 airbnb

开始配置

安装相关依赖

npm install --save-dev eslint@7.17.0 babel-eslint@10.1.0 vue-eslint-parser@7.3.0 eslint-config-alloy@3 eslint-config-prettier@7.1.0 eslint-plugin-prettier@3.3.1 eslint-plugin-vue@7.4.1 vue-eslint-parser@7.3.0

依赖版本

{
  "eslint": "7.17.0",
  "babel-eslint": "10.1.0",
  "eslint-config-alloy": "^3.10.0",
  "eslint-config-prettier": "^7.1.0",
  "eslint-plugin-prettier": "^3.3.1",
  "eslint-plugin-vue": "7.4.1",
  "vue-eslint-parser": "^7.3.0",
}

注意：可以看到我使用的依赖基本都是最新的版本，原因是之前版本比较低，出现了很多找不到相关规则的 error。最后网上找了好久才发现 npm 默认安装的版本相对较低，导致出现了兼容性问题，直到升级到了高版本后才解决。

.eslintrc.js

module.exports = {
  root: true,
  parserOptions: {
    parser: 'babel-eslint',
  },
  env: {
    browser: true,
    es6: true,
  },
  extends: [
    // https://github.com/AlloyTeam/eslint-config-alloy
    'eslint-config-alloy/vue',
    // https://github.com/vuejs/eslint-plugin-vue
    'plugin:vue/essential',
    // 结合.prettierrc.js中的规则来检查代码，这个一定要加！
    'plugin:prettier/recommended',
  ],
  // required to lint *.vue files
  plugins: ['vue'],
  // add your custom rules here
  rules: {
    // 让prettier找出代码中的格式问题
    'prettier/prettier': 'error',
    // 这个顺序不知道为啥，明明不用配置时，.vue文件template标签在script前面默认应该也是可以的，但是我这边不行，所以自定义了一下
    'vue/component-tags-order': [
      'error',
      {
        order: [['template', 'script'], 'style'],
      },
    ],
  },
}

因为大部分规则都继承于eslint-config-alloy/vue，所以代码的语法错误已经不需要我自己去规定了，

.prettierrc.js

module.exports = {
  // 一行最多 120 字符
  printWidth: 120,
  // 使用 2 个空格缩进
  tabWidth: 2,
  // 不使用缩进符，而使用空格
  useTabs: false,
  // 行尾不需要有分号
  semi: false,
  // 使用单引号
  singleQuote: true,
  // 对象的 key 仅在必要时用引号
  quoteProps: 'as-needed',
  // jsx 不使用单引号，而使用双引号
  jsxSingleQuote: false,
  // 末尾需要有逗号
  trailingComma: 'all',
  // 大括号内的首尾需要空格
  bracketSpacing: true,
  // jsx 标签的反尖括号需要换行
  jsxBracketSameLine: false,
  // 箭头函数，只有一个参数的时候，也需要括号
  arrowParens: 'always',
  // 每个文件格式化的范围是文件的全部内容
  rangeStart: 0,
  rangeEnd: Infinity,
  // 不需要写文件开头的 @prettier
  requirePragma: false,
  // 不需要自动在文件开头插入 @prettier
  insertPragma: false,
  // 使用默认的折行标准
  proseWrap: 'preserve',
  // 根据显示样式决定 html 要不要折行
  htmlWhitespaceSensitivity: 'css',
  // vue 文件中的 script 和 style 内不用缩进
  vueIndentScriptAndStyle: false,
  // 换行符使用 lf
  endOfLine: 'lf',
  // 格式化嵌入的内容
  embeddedLanguageFormatting: 'auto',
}

开发工具适配

WebStorm

VSCode

在 VSCode 中使用

{
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "vue",
    "typescript",
    "typescriptreact"
  ]
}

保存时自动修复 ESLint 错误

{
  "eslint.validate": ["javascript", "javascriptreact", "vue", "typescript", "typescriptreact"],
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
}

VSCode 中的 autoFixOnSave 没有效果

{
  "eslint.autoFixOnSave": true,
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    {
      "language": "vue",
      "autoFix": true
    },
    {
      "language": "typescript",
      "autoFix": true
    },
    {
      "language": "typescriptreact",
      "autoFix": true
    }
  ]
}

结束