乐趣区

关于vue.js:Eslint-Prettier为团队项目协作保驾护航

eslint 作为我的项目代码格调管理工具
Prettier 能够认为是帮忙代码格式化的工具

构建我的项目

在 vue-cli 初始化我的项目时 抉择 eslint : 默认有 3 种格调

.eslintrc.js 阐明

会在我的项目根目录产生一个.eslintrc.js 文件,外面能够进行代码检测的相干配置,例如规定 rules 的配置,相干配置示例如下:

module.exports = {
  // 此项是用来通知 eslint 找以后配置文件不能往父级查找
  root: true,

  // 此项是用来指定 eslint 解析器的,解析器必须合乎规定,babel-eslint 解析器是对 babel 解析器的包装使其与 ESLint 解析
  parser: 'babel-eslint',

  // 此项是用来指定 javaScript 语言类型和格调,sourceType 用来指定 js 导入的形式,默认是 script,此处设置为 module,指某块导入形式
  parserOptions: {// 设置 script(默认) 或 module,如果代码是在 ECMASCRIPT 中的模块
    sourceType: 'module',
    "ecmaVersion": 6,
    "ecmaFeatures": {"jsx": true}
  },

  // 此项指定环境的全局变量,上面的配置指定为浏览器环境
  env: {
    "browser": true,
    "node": true,
    "commonjs": true,
    "es6": true,
    "amd": true
  },
  // https://github.com/standard/standard/blob/master/docs/RULES-en.md
  // 此项是用来配置规范的 js 格调,就是说写代码的时候要标准的写,如果你应用 vs-code 我感觉应该能够防止出错
  extends: 'vue',
  // 此项是用来提供插件的,插件名称省略了 eslint-plugin-,上面这个配置是用来标准 html 的
  plugins: [
    'html',
    "flow-vars", 
    "react"
  ],
  /* 
   上面这些 rules 是用来设置从插件来的标准代码的规定,应用必须去掉前缀 eslint-plugin-
    次要有如下的设置规定,能够设置字符串也能够设置数字,两者成果统一
    "off" -> 0 敞开规定
    "warn" -> 1 开启正告规定
    "error" -> 2 开启谬误规定
  */
  rules: {
    // 不须要
    "space-before-function-paren": 0,  // 函数定义时括号后面要不要有空格
    "eol-last": 0,  // 文件以繁多的换行符完结
    "no-extra-semi": 0, // 能够多余的冒号
    "semi": 0,  // 语句能够不须要分号结尾
    "eqeqeq": 0, // 必须应用全等
    "one-var": 0, // 间断申明
    "no-undef": 0, // 能够 有未定义的变量

    // 正告
    "no-extra-boolean-cast": 1, // 不必要的 bool 转换
    "no-extra-parens": 1, // 非必要的括号
    "no-empty": 1, // 块语句中的内容不能为空
    "no-use-before-define": [1, "nofunc"], // 未定义前不能应用
    "complexity": [1, 10], // 循环复杂度
    "no-unused-vars": 1, // 不能有申明后未被应用的变量或参数
    // vue
    "flow-vars/define-flow-type": 1,
    "flow-vars/use-flow-type": 1,

    // react
    "react/jsx-uses-react": 2,
    "react/jsx-uses-vars": 2,

    // 谬误
    "comma-dangle": [2, "never"], // 对象字面量项尾不能有逗号
    "no-debugger": 2, // 禁止应用 debugger
    "no-constant-condition": 2, // 禁止在条件中应用常量表达式 if(true) if(1)
    "no-dupe-args": 2, // 函数参数不能反复
    "no-dupe-keys": 2, // 在创建对象字面量时不容许键反复 {a:1,a:1}
    "no-duplicate-case": 2, // switch 中的 case 标签不能反复
    "no-empty-character-class": 2, // 正则表达式中的 [] 内容不能为空
    "no-invalid-regexp": 2, // 禁止有效的正则表达式
    "no-func-assign": 2, // 禁止反复的函数申明
    "valid-typeof": 2,  // 必须应用非法的 typeof 的值
    "no-unreachable": 2, // 不能有无奈执行的代码
    "no-unexpected-multiline": 2, // 防止多行表达式
    "no-sparse-arrays": 2, // 禁止稠密数组,[1,,2]
    "no-shadow-restricted-names": 2, // 严格模式中规定的限度标识符不能作为申明时的变量名应用
    "no-cond-assign": 2, // 禁止在条件表达式中应用赋值语句
    "no-native-reassign": 2, // 不能重写 native 对象

    // 代码格调
    "no-else-return": 1, // 如果 if 语句外面有 return, 前面不能跟 else 语句
    "no-multi-spaces": 1, // 不能用多余的空格
    "key-spacing": [1, {  // 对象字面量中冒号的前后空格
      "beforeColon": false,
      "afterColon": true
    }],
    "block-scoped-var": 2, // 块语句中应用 var
    "consistent-return": 2, // return 前面是否容许省略
    "accessor-pairs": 2, // 在对象中应用 getter/setter
    "dot-location": [2, "property"], // 对象拜访符的地位,换行的时候在行首还是行尾
    "no-lone-blocks": 2, // 禁止不必要的嵌套块
    "no-labels": 2, // 禁止标签申明
    "no-extend-native": 2, // 禁止扩大 native 对象
    "no-floating-decimal": 2, // 禁止省略浮点数中的 0 .5 3.
    "no-loop-func": 2, // 禁止在循环中应用函数(如果没有援用内部变量不造成闭包就能够)"no-new-func": 2,  // 禁止应用 new Function
    "no-self-compare": 2, // 不能比拟本身
    "no-sequences": 2, // 禁止应用逗号运算符
    "no-throw-literal": 2, // 禁止抛出字面量谬误 throw "error";
    "no-return-assign": [2, "always"], // return 语句中不能有赋值表达式
    "no-redeclare": [2, {   // 禁止反复申明变量
      "builtinGlobals": true
    }],
    "no-unused-expressions": [2, {  // 禁止无用的表达式
      "allowShortCircuit": true,
      "allowTernary": true
    }],
    "no-useless-call": 2, // 禁止不必要的 call 和 apply
    "no-useless-concat": 2,
    "no-void": 2, // 禁用 void 操作符
    "no-with": 2, // 禁用 with
    "space-infix-ops": 2, // 中断操作符四周要不要有空格
    "valid-jsdoc": [2, { // jsdoc 规定
      "requireParamDescription": true,
      "requireReturnDescription": true
    }],
    "no-warning-comments": [2, {  // 不能有正告备注
      "terms": ["todo", "fixme", "any other term"],
      "location": "anywhere"
    }],
    "curly": 1, // 必须应用 if(){} 中的{}

    // common js
    "no-duplicate-imports": 1
  }
}

vscode 装置 prettier 插件

如果想要保留代码时就主动格式化,能够在 vscode 中装置插件

配置 prettierrc

而后再在我的项目根目录增加一个 .prettierrc.js,用来自定义格式化的格调,所有的属性在 这里 能够查到。

module.exports = {
    printWidth: 120, // 一行的字符数换行
    tabWidth: 2, // 一个 tab 代表几个空格数
    useTabs: false, // 是否应用 tab 进行缩进
    singleQuote: true, // 字符串是否应用单引号
    semi: true, // 行尾是否应用分号,默认为 true
    trailingComma: 'none', // 是否应用尾逗号
    bracketSpacing: true, // 对象大括号间接是否有空格,默认为 true,成果:{foo: bar}
    endOfLine:"auto" // 保留在 Windows 和 Unix 下的换行符
  };
在这外面配置句尾强制增加分号(semi: true),能够去掉 eslint rule 外面的 "semi": ["error", "always"]

参考:
https://www.cnblogs.com/ainsl…
https://www.jb51.net/article/…
https://www.jb51.net/article/…
https://www.jianshu.com/p/411…

退出移动版