一.eslint及其相关插件
1.安装eslint
cd进入我们自己的项目目录里面之后，给项目安装eslint
npm install eslint --save-dev
2.初始化 eslin t配置文件
执行以下命令以后初始化 .eslintrc.js 文件。
eslint --init
执行上述命令以后，你会在自己的项目里面看到eslintrc.js文件
3.添加检验规则
当你添加了 rule 以后,打开你的 .ts 文件
'semi': ["error", "always"]
上述标红的地方报错了，就是要你加上封号的意思。你按 ctrl+S 保存，自动帮你添加封号。
当然，你可以在rules里面添加其他的校验规则。比如缩进，对象换行，箭头函数等等。（其他的配置项目你可以移动到附件查看，我已经将所有文档的里面规则翻译了。）
4.插件说明
安装一些eslint的插件，方便 react 的检查，不必须。 eslint-plugin-import插件 没有必要就不要安装了，更具需要走。
npm install -D eslint-plugin-import eslint-plugin-react eslint-plugin-jsx-a11y
插件说明：
- 1.babel-eslint 这个包已经被废弃，很多 博客上还在引用，智慧如你，别再用了。
- 2.eslint-plugin-react 这个插件在 npx eslint --init 的时候如果你选择了 react 她会自动帮你下载配置。
- 3.插件配置： 你可以在 extends里面配置也可以在plugin里面配置， 在extends里面是：一次启用所有推荐的或严格的规则； 在plugin里面是： 选择性启用。
你需要的 plugin 如下：
5. VScode 设置添加 eslint
我们在 vscode 上，下载了 eslint 插件，在项目里面安装了 eslint包，目的就是要 vscode 上的 eslint 插件能够按照 .eslintrc 的配置规则，实时监控我们的代码。
所以要记得在 vscode 的 setting.json 里面打开监控：
eslint.validate 用来检测文件
下面的都是用来 fix 代码的。
按照上述的配置结果就是，当你的文件报错了以后，你直接点击保存，vscode 会将你的文件格式错误自动格式化。不信你试试看呃。当你集成了prettier就不要再配置格式化文件的配置项。后面集成prettier会说这个问题。
5.执行检验命令
在package.json里面增加一个脚本命令
{
"scripts":{
"lint":"eslint --ext .js --ext .jsx src"
}
}
添加完这个命令以后我们就可以对改项目进行eslint管理了 具体执行命令如下：
npm run lint
6.和 git 连接
现在的项目一般都是提交到Gitgub或者Gitlab上管理，我们在提交Git的时候需要对项目进行校验，如果校验不通过，那么就不能进行commit操作，那么此时就需要一个插件叫做pre-commit。该插件的作用就是执行git commit -m "fix:xxxx"的时候先去校验代码是否符合规范，符合则继续commit，不符合则不提交，告诉你哪里有问题需要你去修改。
npm install pre-commit --save-dev
执行完上述命令以后我们需要在package.json文件里面配置一条信息
{
"pre-commit": [
"lint"
]
}
二. prettier 和 eslint 结合使用
为什么使用 prettier？
`
Prettier 是一个“有主见”的代码格式化工具，支持列表如下：
简而言之，这个工具能够使输出代码保持风格一致。
ESLint 是一个开源的 JavaScript 代码检查工具，它是用来进行代码的校验，检测代码中潜在的问题，比如某个变量定义了未使用、函数定义的参数重复、变量名没有按规范命名等等。
Prettier 它是代码格式化工具，用来做代码格式化，有了Prettier之后，它能去掉原始的代码风格，确保团队的代码使用统一相同的格式，修复规则可自定义。
原理:
prettier的规则是负责格式化代码的，
eslint的规则是负责检查文件是否符合规则的，
我没有开启eslint的autoFix，
格式化的工作全部交给了prettier，
eslint只负责检查,
这么配置感觉挺好用的。
注意： 好多博客上面把eslint和prettier混在一起并没有分开，导致一些经典问题（我要求每一行代码后面都要有封号，但是却要求我去掉，不管我怎么配置prettier的属性都没有效果。那就有必要继续向下看。）
1.vscode 安装 prettier 插件
2.在项目里面安装 prettier
npm i prettier -g
安装 eslint和prettier 的相关插件
npm i eslint-plugin-prettier -D
3. 配置 .eslintrc
{
"extends": [ // extends 指定扩展的配置, 支持规则的覆盖和聚合
...
"plugin:prettier/recommended", // 如果同时使用了eslint和prettier发生冲突了，会关闭掉与prettier有冲突的规则，也就是使用prettier认为对的规则
],
"plugins": [ // plugins 配置那些我们想要Linting规则的插件。
...
"prettier", // eslint 会使用pretter的规则对代码格式化
],
"rules": {
"prettier/prettier": 2, // 这项配置 对于不符合prettier规范的写法，eslint会提示报错
}
}
4.配置 .prettierrc 文件
module.exports = {
"printWidth": 100, // 指定代码长度，超出换行
"tabWidth": 2, // tab 键的宽度
"useTabs": false, // 不使用tab
"semi": false, // 结尾加上分号
"singleQuote": true, // 使用单引号
"quoteProps": "as-needed", // 要求对象字面量属性是否使用引号包裹,(‘as-needed’: 没有特殊要求，禁止使用，'consistent': 保持一致 , preserve: 不限制，想用就用)
"jsxSingleQuote": false, // jsx 语法中使用单引号
"trailingComma": "es5", // 确保对象的最后一个属性后有逗号
"bracketSpacing": true, // 大括号有空格 { name: 'rose' }
"jsxBracketSameLine": false, // 在多行JSX元素的最后一行追加 >
"arrowParens": "always", // 箭头函数，单个参数添加括号
"requirePragma": false, // 是否严格按照文件顶部的特殊注释格式化代码
"insertPragma": false, // 是否在格式化的文件顶部插入Pragma标记，以表明该文件被prettier格式化过了
"proseWrap": "preserve", // 按照文件原样折行
"htmlWhitespaceSensitivity": "ignore", // html文件的空格敏感度，控制空格是否影响布局
"endOfLine": "auto" // 结尾是 \n \r \n\r auto
}
有了这个配置文件，再执行lint命令，eslint会按照这个prettier配置文件格式化我们的文件。
到这里，我们的项目中的eslint + prettier 的规则配置基本就完成了。
但是，当我们新增一个文件，需要对新写的代码进行格式化的时候，每次都要执行一下lint命令，这样也太不方便了，我们就希望在保存文件的时候，编辑器可以帮我们做格式化的事情。
5.配置 vscode 的 settings.json
上面的都省略.....
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact"
],
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll": true
},
"eslint.format.enable": true,
"eslint.alwaysShowStatus": true,
"[javascript]": {
"editor.defaultFormatter": "dbaeumer.vscode-eslint"
// 这里也可以使用 "editor.defaultFormatter": "esbenp.prettier-vscode"，但是要保证安装了prettier插件
// 这样使用快捷键格式化 command + k \ command + f，可以进行选择部分代码进行格式化
},
此时我们把eslint用来fix的全部删除了，然后在VScode的settings里面配置用 prettier 来 fix 代码。
三.配置编辑器
首先我们要在vscode上安装eslint插件，并且在vscode的setting.json配置文件里面配置相关检查信息，比如空格几个，对js和ts有没有修饰，具体的配置文件信息如下：
{
"typescript.tsserver.useSeparateSyntaxServer": false,
"emmet.syntaxProfiles": {
"vue-html": "html",
"vue": "html"
},
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact"
],
// #每次保存的时候将代码按eslint格式进行修复
"editor.codeActionsOnSave": {
"source.fixAlltrue.eslint": true,
"source.fixAll.eslint": true
},
"editor.tabSize": 2,
// 两个选择器中是否换行
"window.zoomLevel": 1,
"editor.fontSize": 12,
// #每次保存的时候自动格式化
"editor.formatOnSave": true,
// #让prettier使用eslint的代码格式进行校验
"prettier.eslintIntegration": true,
// #去掉代码结尾的分号
"prettier.semi": false,
// #使用带引号替代双引号
"prettier.singleQuote": true,
// #让函数(名)和后面的括号之间加个空格
//"javascript.format.insertSpaceBeforeFunctionParenthesis": true,
//要js和ts的jsx标签添加空格
//"javascript.format.insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces": true,
// "typescript.format.insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces": true,
//"files.autoSave": "onWindowChange",
//按下tab以后代码自动补全
"emmet.triggerExpansionOnTab": true,
//工作台状态栏可见
"workbench.statusBar.visible": true,
// 找回设置栏，
// "workbench.activityBar.visible": true,
//工作台设置打开默认密钥绑定
// "workbench.settings.openDefaultKeybindings": true,
//eslint始终显示状态
"eslint.alwaysShowStatus": true,
//html中的html格式
"html.format.indentInnerHtml": true,
//html格式缩进句柄栏
"html.format.indentHandlebars": true,
//工作台编辑器启用预览
"workbench.editor.enablePreview": false,
//javascript隐式项目配置实验修饰符
"javascript.implicitProjectConfig.experimentalDecorators": true,
//git命令关闭焦点
"gitlens.gitCommands.closeOnFocusOut": true,
//git确认同步
"git.confirmSync": false,
//git lens高级文件历史记录遵循重命名
"gitlens.advanced.fileHistoryFollowsRenames": false,
//差异编辑器忽略修剪空白
"diffEditor.ignoreTrimWhitespace": true,
//搜索跟踪符号链接
"search.followSymlinks": false,
//维图尔完成自动导入
"vetur.completion.autoImport": false,
}
附件（eslint的rules的配置规则）
module.exports = {
"env": {
"browser": true,
"commonjs": true,
"es6": true
},
"parser": "babel-eslint",
"extends": [
"eslint:recommended",
"plugin:react/recommended"
],
"parserOptions": {
"ecmaVersion": 7,
// 开启实验属性
"ecmaFeatures": {
"experimentalObjectRestSpread": true,
// 修饰器
"experimentalDecorators": true,
"jsx": true
},
"sourceType": "module"
},
"plugins": [
"react"
],
"globals": {
"__DEV__": false,
"__dirname": false,
"window": true,
"define": true,
"history": true,
"location": true,
"wxjs": true,
"$": true,
"WeixinJSBridge": true,
"wx": true,
"process": true,
"qq": true,
},
"settings": {
"react": {
"version": "16.2.0",
}
},
/**
* "off" 或 0 - 关闭规则
* "warn" 或 1 - 开启规则，使用警告级别的错误：warn (不会导致程序退出),
* "error" 或 2 - 开启规则，使用错误级别的错误：error (当被触发的时候，程序会退出)
*/
"rules": {
"no-cond-assign": 2,
"no-console": [
"error", {
"allow": ["log", "warn", "error", "info"]
}
],
// 禁止 function 定义中出现重名参数
"no-dupe-args": 2,
// 禁止对象字面量中出现重复的 key
"no-dupe-keys": 2,
// 禁止重复的 case 标签
"no-duplicate-case": 2,
// 禁止空语句块
"no-empty": 2,
// 禁止对 catch 子句的参数重新赋值
"no-ex-assign": 2,
// 禁止不必要的布尔转换
"no-extra-boolean-cast": 2,
// 禁止不必要的括号 //(a * b) + c;//报错
"no-extra-parens": 0,
//强制所有控制语句使用一致的括号风格
"curly": [2, "all"],
// 禁止 catch 子句的参数与外层作用域中的变量同名
"no-catch-shadow": 0,
// 不允许标签与变量同名
"no-label-var": 2,
// 禁用特定的全局变量
"no-restricted-globals": 2,
// 禁止 var 声明 与外层作用域的变量同名
"no-shadow": 0,
// 禁止覆盖受限制的标识符
"no-shadow-restricted-names": 2,
// 禁止将变量初始化为 undefined
"no-undef-init": 2,
// 禁止将 undefined 作为标识符
"no-undefined": 0,
// 不允许在变量定义之前使用它们
"no-use-before-define": 0,
//////////////
// 风格指南 //
//////////////
// 指定数组的元素之间要以空格隔开(, 后面)， never参数：[ 之前和 ] 之后不能带空格，always参数：[ 之前和 ] 之后必须带空格
"array-bracket-spacing": [2, "never"],
// 禁止或强制在单行代码块中使用空格(禁用)
"block-spacing": [1, "never"],
//强制使用一致的缩进 第二个参数为 "tab" 时，会使用tab，
// if while function 后面的{必须与if在同一行，java风格。
"brace-style": [2, "1tbs", {
"allowSingleLine": true
}],
// 控制逗号前后的空格
"comma-spacing": [2, {
"before": false,
"after": true
}],
// 控制逗号在行尾出现还是在行首出现 (默认行尾)
// http://eslint.org/docs/rules/comma-style
"comma-style": [2, "last"],
//"SwitchCase" (默认：0) 强制 switch 语句中的 case 子句的缩进水平
// 以方括号取对象属性时，[ 后面和 ] 前面是否需要空格, 可选参数 never, always
"computed-property-spacing": [2, "never"],
// 用于指统一在回调函数中指向this的变量名，箭头函数中的this已经可以指向外层调用者，应该没卵用了
// e.g [0,"self"] 指定只能 var that = this. self不能指向其他任何值，this也不能赋值给self以外的其他值
"consistent-this": [2, "self","that","_self","_that","me","_this"],
// 强制使用命名的 function 表达式
"func-names": 0,
// 文件末尾强制换行
"eol-last": 2,
"indent": [
"error", 2
],
//要求或禁止在函数标识符和其调用之间有空格
"func-call-spacing": 2,
// 强制在对象字面量的属性中键和值之间使用一致的间距
"key-spacing": [2, {
"beforeColon": false,
"afterColon": true
}],
// 要求在注释周围有空行 ( 要求在块级注释之前有一空行)
"lines-around-comment": [2, {
"beforeBlockComment": true
}],
"func-style": 0,
// 强制回调函数最大嵌套深度 5层
"max-nested-callbacks": [2, 5],
// 禁止使用指定的标识符
"id-blacklist": 0,
// 强制标识符的最新和最大长度
"id-length": 0,
// 要求标识符匹配一个指定的正则表达式
"id-match": 0,
// 强制在 JSX 属性中一致地使用双引号或单引号
"jsx-quotes": 0,
// 强制在关键字前后使用一致的空格 (前后腰需要)
"keyword-spacing": 2,
// 强制一行的最大长度
"max-len": [2, 200, { "ignoreUrls": true }],
// 强制最大行数
"max-lines": 0,
// 强制 function 定义中最多允许的参数数量
"max-params": [1, 5],
// 强制 function 块最多允许的的语句数量
"max-statements": [1, 200],
// 强制每一行中所允许的最大语句数量
"max-statements-per-line": 0,
// 要求构造函数首字母大写 （要求调用 new 操作符时有首字母大小的函数，允许调用首字母大写的函数时没有 new 操作符。）
"new-cap": [2, {
"newIsCap": true,
"capIsNew": false
}],
// 要求调用无参构造函数时有圆括号
"new-parens": 2,
// 要求或禁止 var 声明语句后有一行空行
"newline-after-var": 0,
// 禁止使用 Array 构造函数
"no-array-constructor": 2,
// 禁用按位运算符
"no-bitwise": 0,
// 要求 return 语句之前有一空行
"newline-before-return": 0,
// 要求方法链中每个调用都有一个换行符
"newline-per-chained-call": 1,
// 禁用 continue 语句
"no-continue": 0,
// 禁止在代码行后使用内联注释
"no-inline-comments": 0,
// 禁止 if 作为唯一的语句出现在 else 语句中
"no-lonely-if": 0,
// 禁止混合使用不同的操作符
"no-mixed-operators": 0,
//禁止空格和 tab 的混合缩进
"no-mixed-spaces-and-tabs": [
"error", "smart-tabs"
],
// 不允许多个空行
"no-multiple-empty-lines": [2, {
"max": 2
}],
// 不允许否定的表达式
"no-negated-condition": 0,
// 不允许使用嵌套的三元表达式
"no-nested-ternary": 0,
// 禁止使用 Object 的构造函数
"no-new-object": 2,
// 禁止使用一元操作符 ++ 和 --
"no-plusplus": 0,
// 禁止使用特定的语法
"no-restricted-syntax": 0,
// 禁止 function 标识符和括号之间出现空格
"no-spaced-func": 2,
// 不允许使用三元操作符
"no-ternary": 0,
// 禁用行尾空格
"no-trailing-spaces": 2,
// 禁止标识符中有悬空下划线_bar
"no-underscore-dangle": 0,
// 禁止可以在有更简单的可替代的表达式时使用三元操作符
"no-unneeded-ternary": 2,
// 禁止属性前有空白
"no-whitespace-before-property": 2,
// 要求或禁止在 var 声明周围换行
"one-var-declaration-per-line": 0,
// 要求或禁止在可能的情况下要求使用简化的赋值操作符
"operator-assignment": 0,
// 强制操作符使用一致的换行符
"operator-linebreak": [2, "after", {
"overrides": {
"?": "before",
":": "before"
}
}],
// 要求或禁止块内填充
"padded-blocks": 0,
// 要求对象字面量属性名称用引号括起来
"quote-props": 0,
// 强制使用一致的反勾号、双引号或单引号
"quotes": [2, "single", "avoid-escape"],
// 要求使用 JSDoc 注释
"require-jsdoc": 0,
// 要求或禁止使用分号而不是 ASI（这个才是控制行尾部分号的，）
// "semi": [2, "always"],
// 强制分号之前和之后使用一致的空格
"semi-spacing": 2,
// 要求同一个声明块中的变量按顺序排列
"sort-vars": 0,
// 强制在块之前使用一致的空格
"space-before-blocks": [2, "always"],
// 强制在 function的左括号之前使用一致的空格
"space-before-function-paren": [2, "always"],
// 强制在圆括号内使用一致的空格
"space-in-parens": [2, "never"],
// 要求操作符周围有空格
"space-infix-ops": 2,
// 强制在一元操作符前后使用一致的空格
"space-unary-ops": [2, {
"words": true,
"nonwords": false
}],
// 强制在注释中 // 或 /* 使用一致的空格
"spaced-comment": [2, "always", {
"markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!"]
}],
// 要求或禁止 Unicode BOM
"unicode-bom": 2,
// 要求正则表达式被括号括起来
"wrap-regex": 0,
//禁止词法声明 (let、const、function 和 class) 出现在 case或default 子句中
"no-case-declarations": ["warn"],
//////////////
// ES6.相关 //
//////////////
// 要求箭头函数体使用大括号
"arrow-body-style": 2,
// 要求箭头函数的参数使用圆括号
"arrow-parens": 2,
"arrow-spacing": [2, {
"before": true,
"after": true
}],
// 强制 generator 函数中 * 号周围使用一致的空格
"generator-star-spacing": [2, {
"before": true,
"after": true
}],
// 禁止修改类声明的变量
"no-class-assign": 2,
// 不允许箭头功能，在那里他们可以混淆的比较
"no-confusing-arrow": 0,
// 禁止修改 const 声明的变量
"no-const-assign": 2,
// 禁止类成员中出现重复的名称
"no-dupe-class-members": 2,
// 每个模块只能使用一个import
"no-duplicate-imports": 2,
// 禁止 Symbolnew 操作符和 new 一起使用
"no-new-symbol": 2,
// 允许指定模块加载时的进口
"no-restricted-imports": 0,
// 禁止在构造函数中，在调用 super() 之前使用 this 或 super
"no-this-before-super": 2,
// 禁止不必要的计算性能键对象的文字
"no-useless-computed-key": 0,
// 要求使用 let 或 const 而不是 var
"no-var": 1,
// 要求或禁止对象字面量中方法和属性使用简写语法
"object-shorthand": 0,
// 要求使用箭头函数作为回调
"prefer-arrow-callback": 0,
// 要求使用 const 声明那些声明后不再被修改的变量
"prefer-const": 0,
// 要求在合适的地方使用 Reflect 方法
"prefer-reflect": 0,
// 要求使用扩展运算符而非 .apply()
"prefer-spread": 0,
// 要求使用模板字面量而非字符串连接
"prefer-template": 0,
// Suggest using the rest parameters instead of arguments
"prefer-rest-params": 0,
// 要求generator 函数内有 yield
"require-yield": 2,
// 要求或禁止模板字符串中的嵌入表达式周围空格的使用
"template-curly-spacing": 1,
// 强制在 yield* 表达式中 * 周围使用空格
"yield-star-spacing": 2,
// 强制使用一致的换行风格
"linebreak-style": [2, "unix"],
//在JSX中强制布尔属性符号
"react/jsx-boolean-value": 2,
//在JSX中验证右括号位置
// "react/jsx-closing-bracket-location": 1,
//在JSX属性和表达式中加强或禁止大括号内的空格。
"react/jsx-curly-spacing": [2, {
"when": "never",
"children": true
}],
//在数组或迭代器中验证JSX具有key属性
"react/jsx-key": 2,
// 限制JSX中单行上的props的最大数量
"react/jsx-max-props-per-line": [1, {
"maximum": 5
}],
//防止在JSX中重复的props
"react/jsx-no-duplicate-props": 2,
// //防止使用未包装的JSX字符串
// "react/jsx-no-literals": 0,
//在JSX中禁止未声明的变量
"react/jsx-no-undef": 2,
//为用户定义的JSX组件强制使用PascalCase
"react/jsx-pascal-case": 0,
//防止反应被错误地标记为未使用
"react/jsx-uses-react": 2,
//防止在JSX中使用的变量被错误地标记为未使用
"react/jsx-uses-vars": 2,
//防止在componentDidMount中使用setState
"react/no-did-mount-set-state": 2,
//防止在componentDidUpdate中使用setState
"react/no-did-update-set-state": 2,
//防止使用未知的DOM属性
"react/no-unknown-property": 2,
//为React组件强制执行ES5或ES6类
"react/prefer-es6-class": 2,
//防止在React组件定义中丢失props验证
// "react/prop-types": 1,
//使用JSX时防止丢失React
"react/react-in-jsx-scope": 2,
//防止没有children的组件的额外结束标签
"react/self-closing-comp": 0,
//禁止不必要的bool转换
// "no-extra-boolean-cast": 0,
//防止在数组中遍历中使用数组key做索引
// "react/no-array-index-key": 0,
//不使用弃用的方法
"react/no-deprecated": 2,
//在JSX属性中强制或禁止等号周围的空格
"react/jsx-equals-spacing": 2,
"react/jsx-filename-extension": [2, {
"extensions": [".js", ".jsx"]
}],
// 禁止未使用的变量
"no-unused-vars": 0,
}
};
我们可以更具项目的需要增减eslintrc里面的配置信息，具体的配置需要到eslint的官网上面查看。
