eslint的正确使用方式

最近项目里面来了新人,他对项目的代码风格提出了质疑,于是乎之前被遗忘的eslint又被提上了议程。

eslint是一个代码质量检查工具,它能根据特定的规则检查已知的项目代码是否符合规范。

之前项目没有推广开的主要原因是没有合适的工作流程,没有一个独立的环节保证所有的代码都是被lint过的。

今天才发现可以结合git钩子在提交的时候直接lint代码,有了这一步基本上就能保证lint的环节不被错过。

后来看了一下最近比较热的js代码格式化项目prettier,里面正好有针对git钩子做的处理。

最后总结下如何使用:

  1. 安装依赖库

yarn install lint-staged husky prettier --dev

  1. 更新package.json
1
2
3
4
5
6
7
8
9
10
11
12
{
"scripts": {
"precommit": "lint-staged"
},
"lint-staged": {
"*.{js,jsx}": [
"prettier --write --single-quote",
"eslint --fix",
"git add"
]
}
}

最后的效果就是在每次commit之前,都会格式化代码并且eslint被提交的代码保证风格统一。