ESLint 与 Prettier 配合解决代码格式问题
ESLint 是一个插件, 用来对 javascript 代码做质量检测
- 例如未使用的变量,未定义的引用,比较时使用 ===,禁止不必要的括号 等等代码质量检测
- ESLint大大提高了团队协作的代码规范统一性,以及个人的代码质量
Prettier 的作用主要是进行代码格式化,统一代码的风格
- Prettier 自身的规范倾向于个人 / 团队的代码风格的规范或统一,例如单引号还是双引号,每行最大长度,等号左右空格,使用 tab 还是 空格等等,将Prettier 与 ESLint 一起协同工作犹如如虎添翼。
- ESLint 的作用是代码质量检测,Prettier 的作用则主要是代码格式化
- ESLint 只能格式化 js/ts 文件,而 Prettier 支持多种文件
怎么配置:
- VsCode 插件安装两个插件
Eslint、Prettier - Code formatter
- 在项目的根目录下创建
.vscode 文件夹,注意:文件夹名字前面带 . 点❗
- 在
.vscode 文件夹下,创建 settings.json 文件,用来对 当前项目进行格式化
- 在项目根目录下创建
.prettierrc 文件,用来对代码风格进行配置
.vscode/settings.json 文件
{
"eslint.enable": true,
"eslint.run": "onType",
"eslint.options": {
"extensions": [".js", ".ts", ".jsx", ".tsx", ".vue"]
},
"editor.codeActionsOnSave": {
"source.fixAll": true,
"source.fixAll.eslint": true
},
"[typescript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[vue]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[json]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"editor.wordSeparators": "`~!@#%^&*()=+[{]}\\|;:'\",.<>/?",
"editor.tabSize": 2,
"editor.formatOnSave": true,
}
.prettierrc 文件
{
"semi": false,
"singleQuote": true,
"useTabs": false,
"tabWidth": 2,
"printWidth": 130,
"trailingComma": "none",
"endOfLine": "auto"
}