关于vscode中settings.json中的设置
为什么会需要有这个文章,因为在整合eslint和prettier出现settings.json文件,究竟哪个配置对应哪个插件?
vscode版本1.93.1
settings.json
json
{
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll": "explicit",
"source.fixAll.eslint": "explicit"
},
}
这段 JSONC 配置应用于 VSCode 编辑器,其执行流程如下:
保存文件时:
当用户保存一个文件时,触发后续配置项的检查和应用。
如果文件中有格式化问题,由于 "editor.formatOnSave": true
,编辑器会自动进行代码格式化。
要确定 editor.formatOnSave 使用的是哪个格式化工具,可以通过以下几种方式来确认:
1. 查看全局设置:
在 VSCode 中,打开设置 (File > Preferences > Settings 或者使用快捷键 Ctrl + ,)。
查找 Editor: Format On Save 相关的设置,特别是 editor.defaultFormatter 和 editor.formatOnSaveProvider。
2.查看工作区或项目级别的设置:
在项目的 .vscode/settings.json 文件中,查看是否有特定的格式化工具配置。
常见的配置项包括:
editor.defaultFormatter: 指定默认的格式化工具。
具体格式化工具的扩展 ID,例如 esbenp.prettier-vscode 或 dbaeumer.vscode-eslint。
3.安装的扩展:
查看已安装的扩展列表 (Extensions 侧边栏),找到与格式化相关的扩展。
常用的格式化工具扩展有:
Prettier (esbenp.prettier-vscode)
ESLint (dbaeumer.vscode-eslint)
TSLint (ms-vscode.vscode-typescript-tslint-plugin)
TypeScript Formatter (vscode.typescript-language-features)
检查扩展设置:
如果安装了多个格式化工具,可以查看每个扩展的具体设置,例如:
JSON
{
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
这将指定默认的格式化工具为 Prettier。
示例配置
假设你安装了 Prettier 和 ESLint,并希望使用 Prettier 进行格式化,可以在 .vscode/settings.json 中添加以下配置:
JSON
{
"editor.formatOnSave": true,
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
这样,VSCode 在保存文件时就会使用 Prettier 进行格式化。
执行代码操作:
检查是否有可以被自动修复的问题。
source.fixAll: "explicit"
这个配置项表示在保存文件时,显式地修复所有可以自动修复的问题。这些问题是通过各种 linting 工具检测到的,不限于 ESLint。
source.fixAll.eslint: "explicit"
这个配置项特别指定使用 ESLint 来修复所有可以自动修复的问题。这意味着只针对 ESLint 报告的问题进行修复。
因此,这两个配置项的作用范围不同:
- source.fixAll 适用于所有 linting 工具。
- source.fixAll.eslint 仅适用于 ESLint。
通常情况下,source.fixAll.eslint 是 source.fixAll 的子集,但为了确保 ESLint 的问题得到特别处理,两者可以同时配置。
总结:
在保存文件时,先自动格式化代码,然后使用 ESLint 和其他 linter 工具尝试自动修复所有能修复的代码问题。