preittier和eslint有npm包也有vscode插件,平时应该怎么搭配使用,还有prettier格式化代码和eslint会产生规则冲突的问题。比如你在prettier中设置了semi:false,而eslint的推荐规则是强调你必须在行尾加分号的。就会产生冲突。
解决eslint和prettier的冲突问题
有两种方法,一个是直接放弃使用prettier,反正eslint也能格式化代码,把js加入prettier忽略的文件里面
另一个是使用prettier官方的解决方案eslint-config-prettier
,他的原理是将eslint里面和prettier重叠的配置都关掉。
npm install --save-dev eslint-config-prettier
在eslint的配置文件r.eslintrc.*
里面,进行配置,只需在extends里面放在最后一行,因为要保证覆盖前面的配置。
{
"extends": [
"some-other-config-you-use",
"prettier"
]
}
单独使用vscode插件的不安装npm包的方法
不想安装npm包的理由很简单,因为你每个项目都要npm install这么一下,多了一大堆文件,你搭脚手架的等待时间变长。你删除文件花的时间也变长,要是能在vscode插件上直接配好不是很方便吗。
prettier的vscode插件 esbenp.prettier-vscode
prettier的vscode的插件是集成了功能的,可以独立使用。并且可以读取当前项目目录的配置文件,优先级高于你在编辑器的配置。并且你在项目安装了prettier,他会优先读取,并且有个配置项配置了 prettier.resolveGlobalModules
为true,他也会从全局下载的npm包中找prettier,都找不到了才会用编辑器绑定的prettier。
而官方推荐的方式是在项目目录中安装本地开发依赖
关于配置文件读取的优先级如下:
- Prettier configuration file
.editorconfig
- Visual Studio Code Settings (Ignored if any other configuration is present)
所以,prettier 可以单独使用,但是还是建议安装本地开发依赖
eslint的vscode插件dbaeumer.vscode-eslint
eslint的vscode插件并不能单独使用,你只能全局安装一个或者项目文件夹里面安装一个。
全局安装一个就能正常使用了npm install -g eslint
综上,如果要讲prettier+eslint一起使用,你至少要在项目文件夹中安装个eslint-config-prettier配置好,并且全局安装eslint
然后最推荐的方式还是在项目文件夹安装,因为作为开发依赖,你需要把它记录到package.json中保持一致性。比如说你把这个项目传到git,然后过一阵子有人下载下来,要用eslint,版本跟你用的不一样,可能就会因为配置变化多一堆报错。。。
另外开发依赖里面你还需要一个git hook,这些都是在本地配置比较方便。
作为开发依赖安装eslint+prettier的流程
01.安装prettier相关
npm install prettier --save-dev
npm install eslint-config-prettier --save-dev
然后把你写的prettier文件复制过来,我对默认配置只改了两项。
//.prettierrc.js
module.exports = {
semi: false,
singleQuote: true,
}
02.安装eslint相关
npm install eslint --save-dev
然后安装你想用的js代码风格之类的,可以用npx eslint --init
,他预设了一些配置的选项给你选,包括typescript也可以支持。
配置完eslint,你就可以配置和prettier的兼容了。
.eslintrc.js
里extends里面最后加上prettier
{
"extends": [
"some-other-config-you-use",
"prettier"
]
}
03.配置git hooks
这里介绍一种用lint-stage进行配置的方法,
直接安装npm install --save-dev lint-staged husky
husky现在的版本号是6.0,配置方式已经发生了变化,网上很多教程是4的版本号已经不适用了。
# 执行完这样代码会多出一个.husky目录
npx husky install
# 后面字符串参数就是pre-commit阶段里面会执行的命令,你也可以直接编辑pre-commit文件添加命令
npx husky add .husky/pre-commit "npx lint-staged"
然后在package.json文件里添加lint-staged的配置,注意prettier要放在最后执行
"lint-staged": {
"**/*.js": [
"eslint ",
"prettier --write"
]
},