配置VSCode自动运行Lint和格式化可提升代码质量。首先安装ESLint和Prettier插件并启用保存时自动格式化,通过.editor.formatOnSave和source.fixAll.eslint实现。接着使用Husky和lint-staged在git commit时自动检查,安装依赖后初始化Husky,配置lint-staged对js、ts等文件执行eslint --fix和prettier --write,并修改pre-commit钩子调用lint-staged。测试提交验证流程,确保不规范代码无法提交。建议将配置纳入版本控制并结合commitlint等工具统一团队规范。

在团队协作开发中,保持代码风格统一和避免低级错误至关重要。通过配置 VSCode 在提交代码前自动运行 Lint 检查和格式化,可以有效提升代码质量。以下是具体实现方式。
安装并配置必要的插件
VSCode 本身不自带完整的 Git 提交钩子功能,需要借助插件和工具链来实现自动化检查。
- ESLint / Prettier 插件:根据项目技术栈安装对应插件,如 ESLint、Prettier - Code formatter,确保编辑器能实时高亮问题。
- 保存时自动格式化:在 VSCode 设置中启用“Format on Save”:
也可在 .vscode/settings.json 中配置:
{
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
}
}使用 Husky 和 lint-staged 自动化提交检查
仅靠编辑器设置无法阻止他人或命令行提交不规范代码。推荐结合 Husky 和 lint-staged,在 git commit 时自动执行检查。
- 安装依赖:
npm install --save-dev husky lint-staged
- 启用 Husky:
npx husky init
这会创建 .husky/pre-commit 钩子文件。
-
配置 lint-staged:在
package.json中添加:
"lint-staged": {
"*.{js,ts,jsx,tsx}": [
"eslint --fix",
"prettier --write"
]
}- 修改 pre-commit 钩子,让其运行 lint-staged:
#!/bin/sh . "$(dirname "$0")/_/husky.sh"npx lint-staged
验证流程是否生效
进行一次测试提交:
- 修改一个 JS 文件,故意加入不符合 ESLint 规则的代码(如未使用的变量)。
- 执行
git add . && git commit -m "test"。 - 如果配置正确,提交会被中断,ESLint 会尝试修复问题,Prettier 会格式化文件。
- 修复后才能完成提交。
补充建议
为确保团队一致性,建议将 .vscode/settings.json 和 husky 配置纳入版本控制。
- 可配合
pretty-quick或commitlint进一步规范提交信息。 - 若项目使用 TypeScript,确保 ESLint 支持 TS 语法解析。
基本上就这些。通过编辑器设置 + Git hooks 的组合,能有效保障提交代码的整洁与规范。










