简体中文 README
Metapsy ESLint 规则不仅是一套先进的适用于 React/Vue/Typescript 项目的 ESLint 配置规范,而且也是你配置个性化 ESLint 规则的最佳参考。
快速开始
请根据你的项目使用的技术栈选择以下配置:
设计理念
- 样式相关的规则交给 [Prettier][] 管理
- 传承 ESLint 的理念,帮助大家建立自己的规则
- 高度的自动化:先进的规则管理,测试即文档即[网站][]
- 与时俱进,第一时间跟进最新的规则
样式相关的规则交给 [Prettier][] 管理
Prettier 是一个代码格式化工具,相比于 ESLint 中的代码格式规则,它提供了更少的选项,但是却更加专业。
如今 Prettier 已经成为前端项目中的必备工具,eslint-config 也没有必要再去维护 ESLint 中的代码格式相关的规则了,所以我们在 v3 版本中彻底去掉了所有 Prettier 相关的规则,用 ESLint 来检查它更擅长的逻辑错误。
至于缩进要两个空格还是四个空格,末尾要不要分号,可以在项目的 .prettierrc.js
中去配置,当然我们也提供了一份推荐的 Prettier 配置供大家参考。
传承 [ESLint 的理念][],帮助大家建立自己的规则
ESLint 推崇插件化、配置化,满足了不同团队不同技术栈的个性的需求。
eslint 版本安装建议
eslint ^7.5.0
babel-eslint ^10.1.0
eslint-plugin-react ^7.20.3
vue-eslint-parser ^7.1.0
eslint-plugin-vue ^6.2.2
@typescript-eslint/parser ^3.7.0
@typescript-eslint/eslint-plugin ^3.7.0
覆盖率 100% 的测试和文档
Metapsy ESLint 规则奉行「测试即文档」,每个配置不仅配有一句话注释以及对应的错误示例和正确示例,而且还更进一步,将这些示例代码作为测试代码运行,保证了报错项与配置一一匹配。
- 所有 ESLint 配置均在
test
目录下 - 每一项配置存放在对应的目录下,如
test/react/jsx-key/.eslintrc.js
描述了规则react/jsx-key
- 每一条配置都有一句话注释说明此配置的用途
- 对于有争议的配置,在注释中通过
@reason
说明了这么配置的原因 - 如果配置开启了,则必须有对应的示例,包括
bad.js
和good.js
- 每个示例都会在真实的 ESLint 脚本中运行,以保证每次更新都向前兼容
- 由于配置和示例在一个目录下,故编辑器中可以直接看到错误信息
- 将测试中的配置、注释和示例输出为 html,生成网站
高度的自动化
无情的推动自动化
- 由
scripts/build.ts
脚本将test
目录下分散的配置生成整体的配置,并且生成网站中需要用到的site/config/rules
- 运行测试脚本
test/index.ts
会检查每个示例是否按照要求报错 - 运行
scripts/rulesCoverage.ts
保证当前配置覆盖了最新的 ESLint 规则,即:- 不包含被标记为
deprecated
的规则 - 不包含 eslint-config-prettier 的规则(样式相关的规则交给更专业的 Prettier 处理)
- 包含所有其余可用的规则
- 不包含被标记为
- 通过 Prettier 保证代码样式的一致性
- 使用 gitlab-ci 保证主干通过以上测试
配置原则
我们依据以下三条原则,研读了 ESLint 所有的配置项,定制出了心目中的「完美」ESLint 配置。
- 能够帮助发现代码错误的规则,全部开启
- 配置不应该依赖于某个具体项目,而应该全局合理
- 帮助保持团队的代码风格统一,而不是限制开发体验
内置规则
npm install --save-dev eslint babel-eslint eslint-config
在你的项目的根目录下创建一个 .eslintrc.js
文件,并将以下内容复制进去:
module.exports = {
extends: [
'@metapsy/eslint-config',
],
env: {
// 你的环境变量(包含多个预定义的全局变量)
//
// browser: true,
// node: true,
// mocha: true,
// jest: true,
// jquery: true
},
globals: {
// 你的全局变量(设置为 false 表示它不允许被重新赋值)
//
// myGlobal: false
},
rules: {
// 自定义你的规则
}
};
React
yarn add -D eslint babel-eslint eslint-plugin-react @metapsy/eslint-config
在你的项目的根目录下创建一个 .eslintrc.js
文件,并将以下内容复制进去:
module.exports = {
extends: [
'@metapsy/eslint-config',
'@metapsy/eslint-config/react',
],
env: {
// 你的环境变量(包含多个预定义的全局变量)
//
// browser: true,
// node: true,
// mocha: true,
// jest: true,
// jquery: true
},
globals: {
// 你的全局变量(设置为 false 表示它不允许被重新赋值)
//
// myGlobal: false
},
rules: {
// 自定义你的规则
}
};
Vue
npm install --save-dev eslint babel-eslint vue-eslint-parser eslint-plugin-vue eslint-config
在你的项目的根目录下创建一个 .eslintrc.js
文件,并将以下内容复制进去:
module.exports = {
extends: [
'Metapsy',
'Metapsy/vue',
],
env: {
// 你的环境变量(包含多个预定义的全局变量)
//
// browser: true,
// node: true,
// mocha: true,
// jest: true,
// jquery: true
},
globals: {
// 你的全局变量(设置为 false 表示它不允许被重新赋值)
//
// myGlobal: false
},
rules: {
// 自定义你的规则
}
};
TypeScript
yarn add -D eslint typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin @metapsy/eslint-config
在你的项目的根目录下创建一个 .eslintrc.js
文件,并将以下内容复制进去:
module.exports = {
extends: [
'@metapsy/eslint-config/typescript',
],
env: {
// 你的环境变量(包含多个预定义的全局变量)
//
// browser: true,
// node: true,
// mocha: true,
// jest: true,
// jquery: true
},
globals: {
// 你的全局变量(设置为 false 表示它不允许被重新赋值)
//
// myGlobal: false
},
rules: {
// 自定义你的规则
}
};
TypeScript React
yarn add -D eslint typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-react eslint-config
在你的项目的根目录下创建一个 .eslintrc.js
文件,并将以下内容复制进去:
module.exports = {
extends: [
'@metapsy/eslint-config/typescript',
'@metapsy/eslint-config/react'
],
env: {
// 你的环境变量(包含多个预定义的全局变量)
//
// browser: true,
// node: true,
// mocha: true,
// jest: true,
// jquery: true
},
globals: {
// 你的全局变量(设置为 false 表示它不允许被重新赋值)
//
// myGlobal: false
},
rules: {
// 自定义你的规则
}
};
常见问题
在 VSCode 中使用
在 VSCode 中,默认 ESLint 并不能识别 .vue
、.ts
或 .tsx
文件,需要在「文件 => 首选项 => 设置」里做如下配置:
{
"eslint.validate": [
"javascript",
"javascriptreact",
"vue",
"typescript",
"typescriptreact"
]
}
VSCode 中的 autoFixOnSave 没有效果
如果需要针对 .vue
、.ts
和 .tsx
文件开启 ESLint 的 autoFix,则需要配置成:
{
"eslint.autoFixOnSave": true,
"eslint.validate": [
"javascript",
"javascriptreact",
{
"language": "vue",
"autoFix": true
},
{
"language": "typescript",
"autoFix": true
},
{
"language": "typescriptreact",
"autoFix": true
}
]
}
如何结合 Prettier 使用
eslint-config 从 v2 开始,已经不包含所有样式相关的规则了,故不需要引入 eslint-config-prettier
。只需要安装 prettier
及相关 VSCode 插件即可。
下面给出一个 FED 使用的 .prettierrc.js
配置,仅供参考:
// .prettierrc.js
module.exports = {
// 一行最多 100 字符
printWidth: 100,
// 使用 4 个空格缩进
tabWidth: 4,
// 不使用缩进符,而使用空格
useTabs: false,
// 行尾需要有分号
semi: true,
// 使用单引号
singleQuote: true,
// 对象的 key 仅在必要时用引号
quoteProps: 'as-needed',
// jsx 不使用单引号,而使用双引号
jsxSingleQuote: false,
// 末尾不需要逗号
trailingComma: 'none',
// 大括号内的首尾需要空格
bracketSpacing: true,
// 箭头函数,只有一个参数的时候,也需要括号
arrowParens: 'always',
// 每个文件格式化的范围是文件的全部内容
rangeStart: 0,
rangeEnd: Infinity,
// 不需要写文件开头的 @prettier
requirePragma: false,
// 不需要自动在文件开头插入 @prettier
insertPragma: false,
// 使用默认的折行标准
proseWrap: 'preserve',
// 根据显示样式决定 html 要不要折行
htmlWhitespaceSensitivity: 'css',
// 换行符使用 lf
endOfLine: 'lf'
};
常用命令
# 安装依赖
npm i
# 构建 index.js react.js 等 eslintrc 配置
npm run build
# 执行测试
npm test
# 自动修复 ESLint 错误
npm run eslint:fix
# 自动修复格式错误
npm run prettier:fix
# 检查当前是否覆盖了所有的规则
npm run test:rulesCoverage
# 发布新版本
npm version <major|minor|patch>
git push --follow-tags
npm publish
测试
yarn test