VSCode的Format On Save:自动格式化代码,保持团队风格统一

11次阅读

需配置vscodeformat On Save功能以实现保存时自动格式化:一、勾选设置中的Editor: Format On Save;二、为各语言指定默认格式化器;三、在.settings.json中设editor.formatOnSaveTimeout为2000;四、通过format on save excludes排除dist/等无需格式化的文件。

VSCode的Format On Save:自动格式化代码,保持团队风格统一

如果您在使用 VSCode 编辑代码时希望保存文件时自动应用格式化规则,以确保与团队约定的代码风格保持一致,则需要正确配置 Format On Save 功能。以下是实现该功能的多种方法:

本文运行环境:MacBook Air,macos Sequoia

一、启用内置 Format On Save 设置

VSCode 提供了开箱即用的自动格式化开关,通过修改用户或工作区设置即可全局启用该功能,无需安装额外扩展。

1、打开 VSCode,按下 Cmd + ,windows/linux 为 Ctrl + ,)进入设置界面。

2、在右上角搜索框中输入 format on save

3、勾选 Editor: Format On Save 复选框。

二、按语言指定格式化工具

不同编程语言可能需要不同的格式化器(如 Prettier、ESLint、Black、clang-format),仅开启通用开关不足以保证正确执行,需为特定语言绑定格式化提供程序。

1、在设置界面搜索 default formatter

2、点击对应语言(如 javaScript、pythontypescript)右侧的下拉菜单。

3、选择已安装且兼容的格式化扩展,例如为 javascript 选择 esbenp.prettier-vscode

三、配置工作区级 formatOnSaveTimeout

当格式化工具响应较慢时,VSCode 默认会在 750ms 后放弃执行,导致保存后未生效。可通过延长超时时间确保格式化完成。

1、在项目根目录创建或编辑 .vscode/settings.json 文件。

2、添加以下键值对:“editor.formatOnSaveTimeout”: 2000

3、保存该 json 文件,重启当前窗口使配置生效。

四、禁用特定文件类型的自动格式化

某些生成文件(如 dist/ 目录下的 JS、*.min.js)不应被格式化,可通过排除模式避免误操作。

1、打开设置界面,搜索 format on save excludes

2、点击 Add Pattern 按钮。

3、输入需跳过的路径模式,例如 “**/dist/**”“**/*.min.js”

text=ZqhQzanResources