1. 什么是ESlint?
ESLint 是一款开源的 JavaScript lint 工具,由 Nicholas C. Zakas 于2013 年创建。
ESLint 官方文档 About 页面分 About 和 Philosophy 两个部分对 ESLint 做了介绍,简洁明了,值得一读。
借助 ESLint,可将 静态代码分析 和 问题代码协助修复 集成到 编码、提交 和 打包 过程中,及早发现并协助修复代码中:
有语法错误的部分
不符合约定的样式准则的部分
不符合约定的最佳实践的部分
在项目开发中获得如下收益:
在执行代码之前发现并修复语法错误,减少调试耗时和潜在 bug
保证项目的编码风格统一,提高可维护性
督促团队成员在编码时遵守约定的最佳实践,提高代码质量
主要有以下特点:
默认规则包含所有 JSLint、 JSHint 中存在的规则, 易迁移;
规则可配置性高: 可设置「 警告」、「 错误」 两个 error 等级, 或者直接禁用;
包含代码风格检测的规则( 可以丢掉 JSCS 了);
支持插件扩展、 自定义规则。
2. ESlint规范
AlloyTeam ESLint 规则
AlloyTeam ESLint 规则不仅是一套科学的 ESLint 配置规范,而且也是你配置个性化 ESLint 规则的最佳参考。
规则列表
名称 | 包含规则 | 解析器 |
---|---|---|
标准规则 | ESLint 规则 | babel-eslint |
React | ESLint 规则、eslint-plugin-react | babel-eslint |
Vue | ESLint 规则、eslint-plugin-vue | vue-eslint-parser |
TypeScript | ESLint 规则、@typescript-eslint | @typescript-eslint/parser |
TypeScript React | ESLint 规则、@typescript-eslint、eslint-plugin-react | @typescript-eslint/parser |
TypeScript Vue(开发中) |
[babel-eslint] https://github.com/babel/babel-eslint
[vue-eslint-parser] https://github.com/mysticatea/vue-eslint-parser
[@typescript-eslint/parser] https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser
[ESLint 规则] https://eslint.org/docs/rules/
[eslint-plugin-react] https://github.com/yannickcr/eslint-plugin-react
[eslint-plugin-vue] https://eslint.vuejs.org/rules/
[@typescript-eslint] https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#supported-rules
配置原则
我们依据以下三条原则,研读了 ESLint 所有的配置项,定制出了心目中的「完美」ESLint 配置。
能够帮助发现代码错误的规则,全部开启
配置不应该依赖于某个具体项目,而应尽可能的合理
帮助保持团队的代码风格统一,而不是限制开发体验
配置解读
ESLint 的配置多达几百条,逐个查阅是一项非常繁重的工作,我们为了简化个性化配置的成本,针对每一条配置都有一句话的注释,以及对应的错误示例和正确示例。这样不仅方便了我们自己查阅某项配置的意义和原因,也使大家更容易配置出自己心目中的规则:
每一条配置都有一句话注释说明此配置的用途
每个开启的配置都有对应的错误示例和正确示例
每个示例都会在真实的 ESLint 脚本中运行,以保证报错项与配置一一匹配
对于有争议的配置,都在注释中说明了为什么要这么配置的原因
对于能够自动修复的配置,在注释中有标注了
@fixable
使用方法
标准规则
安装:
安装:
npm install --save-dev eslint babel-eslint eslint-config-alloy
在你的项目根目录下创建 .eslintrc.js
,并将以下内容复制到文件中:
module.exports = {
extends: [
'eslint-config-alloy',
],
globals: {
// 这里填入你的项目需要的全局变量
// 这里值为 false 表示这个全局变量不允许被重新赋值,比如:
//
// jQuery: false,
// $: false
},
rules: {
// 这里填入你的项目需要的个性化配置,比如:
//
// // 一个缩进必须用两个空格替代
// 'indent': [
// 'error',
// 2,
// {
// SwitchCase: 1,
// flatTernaryExpressions: true
// }
// ]
}
};