Visual Studio Code 的 settings.json 配置指南
文章目录
- Visual Studio Code 的 settings.json 配置指南
- 基本结构
- 访问 settings.json
- 常用配置示例
- 编辑器基础设置
- 文件与保存
- 终端配置
- 扩展特定设置
- 主题与外观
- 最佳实践
- 注意事项
Visual Studio Code 的 settings.json 配置指南
settings.json 是 VS Code 中用于存储用户和工作区设置的文件。以下是关于如何编写和配置 settings.json 的详细指南。
基本结构
settings.json 是一个 JSON 格式的文件,包含键值对配置:
{"settingName": "value","anotherSetting": 42,"booleanSetting": true,"arraySetting": ["item1", "item2"]
}
访问 settings.json
-
用户设置:适用于所有项目的全局设置
- 快捷键:
Ctrl+,
或Cmd+,
打开设置界面,然后点击右上角的打开设置(JSON)图标 - 文件位置:
- Windows:
%APPDATA%\Code\User\settings.json
- macOS:
$HOME/Library/Application Support/Code/User/settings.json
- Linux:
$HOME/.config/Code/User/settings.json
- Windows:
- 快捷键:
-
工作区设置:仅适用于当前项目的设置
- 在项目根目录的
.vscode/settings.json
文件中
- 在项目根目录的
常用配置示例
编辑器基础设置
{"editor.fontSize": 14,"editor.tabSize": 2,"editor.wordWrap": "on","editor.renderWhitespace": "all","editor.minimap.enabled": false,"editor.lineNumbers": "on","editor.autoClosingBrackets": "always"
}
文件与保存
{"files.autoSave": "afterDelay","files.autoSaveDelay": 1000,"files.exclude": {"**/.git": true,"**/.DS_Store": true,"**/node_modules": true},"files.associations": {"*.js": "javascript","*.vue": "vue"}
}
终端配置
{"terminal.integrated.fontSize": 12,"terminal.integrated.shell.windows": "C:\\Windows\\System32\\cmd.exe","terminal.integrated.shell.linux": "/bin/bash","terminal.integrated.shell.osx": "/bin/zsh"
}
扩展特定设置
{// ESLint"eslint.enable": true,"eslint.autoFixOnSave": true,// Prettier"prettier.singleQuote": true,"prettier.trailingComma": "es5","editor.defaultFormatter": "esbenp.prettier-vscode","editor.formatOnSave": true,// Python"python.pythonPath": "/usr/local/bin/python3","python.linting.enabled": true
}
主题与外观
{"workbench.colorTheme": "One Dark Pro","workbench.iconTheme": "material-icon-theme","window.zoomLevel": 0,"editor.tokenColorCustomizations": {"comments": "#FF0000"}
}
最佳实践
- 优先使用工作区设置:将项目特定的设置放在
.vscode/settings.json
中 - 注释:虽然 JSON 标准不支持注释,但 VS Code 允许以下形式的注释:
{// 这是一个注释"setting": "value" }
- 组织设置:按功能或扩展分组相关设置
- 版本控制:将工作区 settings.json 纳入版本控制,确保团队成员共享相同配置
注意事项
- 修改 settings.json 后会自动生效,无需重启 VS Code
- 设置名称区分大小写
- 可以通过命令面板 (
Ctrl+Shift+P
或Cmd+Shift+P
) 输入 “Preferences: Open Settings (JSON)” 快速打开 - 不确定设置名称时,可以先在图形界面设置中修改,然后查看 settings.json 的变化
希望这份指南能帮助您更好地配置 VS Code 的 settings.json 文件!