WebStorm配置vueCli+eslint+prettier保存自动格式化

2022-10-03 07:59:52

eslint和prettier

eslint针对javascript做格式和语法的检查，prettier主要用于格式化，但格式化的文件类型相比eslint --fix来说要多一些。通常prettier的格式和eslint的格式会产生冲突，造成prettier格式化后eslint大量报错，所以我们需要配置使得格式上按照prettier为准，eslint专门做语法检查。

vuecli创建项目

选择eslint+prettier的格式化方案

eslint-config-prettier和eslint-plugin-prettier

项目创建完成后，package.json的开发依赖如下：

其中@vue/eslint-config-prettier是一组规则，引入到.eslintrc.js的extends数组中用于eslint格式检查时兼容prettier的格式。

而eslint-plugin-prettier则用于执行eslint --fix时自动执行prettier的格式化

添加prettier.config.js

现在代码的格式就以prettier为准，我们可以通过新建prettier.config.js文件进行格式调整：

vim prettier.config.js

module.exports = {
  singleQuote: true,
  semi: false
}

配置webstorm的eslint fix on save

打开fix on save后，代码修改保存就会自动执行eslint --fix，同时也会自动执行prettier

总结

基本配置步骤如下：

vuecli创建项目选择：eslint+prettier
添加prettier.config.js：自定义格式配置
打开webstorm的fix on save选项