怎样使用VSCode的代码格式化扩展?

怎样使用VSCode的代码格式化扩展?
最新回答
夏了夏天

2021-07-13 01:07:06

在VSCode中使用代码格式化扩展需完成安装扩展、设置默认工具、开启自动格式化及配置项目规则四步,具体操作如下

1. 安装对应语言的格式化扩展

不同语言需安装适配的扩展工具,常见搭配如下:

  • JavaScript/TypeScript:Prettier(推荐)或内置TypeScript格式化器。
  • Python:安装Python扩展,并配合black或autopep8。
  • HTML/CSS/JSON:Prettier基本覆盖所有需求。
  • 操作步骤:打开VSCode扩展面板(快捷键Ctrl+Shift+X),搜索目标工具(如“Prettier”),点击安装。
2. 设置默认格式化工具

安装后需指定默认扩展,避免每次手动选择:

  • 方法一:通过右键菜单设置右键编辑器空白处,选择“格式化文档”。若未设置默认工具,VSCode会弹出选项列表,勾选“设为默认”即可。
  • 方法二:通过设置面板配置打开设置(快捷键Ctrl+,),搜索“default formatter”,找到“Editor: Default Formatter”选项,为每种语言指定扩展(如JavaScript选择“Prettier”)。
3. 开启自动格式化功能

通过快捷键或保存时自动触发格式化:

  • 手动格式化快捷键

    格式化整个文件:Ctrl+Shift+I(Windows/Linux)或Cmd+Shift+I(Mac)。

    格式化选中代码:Ctrl+K Ctrl+F(Windows/Linux)或Cmd+K Cmd+F(Mac)。

  • 保存时自动格式化:在设置中搜索“Format On Save”,勾选该选项,每次保存文件时自动格式化。
  • 粘贴时自动格式化:搜索“Format On Paste”并启用,粘贴代码时立即美化。
4. 配置项目级规则文件

团队开发时需统一代码风格,通过配置文件实现:

  • Prettier项目配置:在项目根目录创建.prettierrc文件,定义缩进(tabWidth)、引号(singleQuote)、行宽(printWidth)等规则。例如:{ "tabWidth": 2, "singleQuote": true, "printWidth": 80}
  • ESLint配合Prettier:通过.eslintrc文件统一规范,需安装eslint-config-prettier插件避免规则冲突。
  • Python项目配置:使用black时无需额外配置(默认规则严格),若需自定义可创建pyproject.toml文件。
  • 生效方式:VSCode会自动读取项目根目录的配置文件,格式化时遵循约定规则。
注意事项
  • 扩展冲突:若安装多个格式化工具(如Prettier和ESLint),需在设置中明确指定默认工具,避免重复格式化。
  • 文件排除:在设置中搜索“Exclude”可配置忽略格式化的文件或文件夹(如node_modules)。
  • 语言覆盖:部分语言(如Java)需安装专用扩展(如“Red Hat Java”),并配置对应格式化工具(如clang-format)。

通过以上步骤,可实现高效、统一的代码格式化体验,显著提升可读性和协作效率。