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/ainsliaea/p/12986023.html

你可能感兴趣的:(Eslint + Prettier为团队项目协作保驾护航)