通过配置git Hooks、vscode扩展或Husky与Lint-Staged,可在提交前自动检查代码质量。首先可用.git/hooks/pre-commit脚本运行ESLint等工具进行校验;其次在VSCode中安装Prettier和ESLint扩展,并设置”editor.formatOnSave”与”source.fixAll.eslint”实现保存时自动修复;再者使用Husky结合lint-staged仅对暂存文件执行格式化和检查,提升效率;最后利用VSCode源代码管理界面查看文件差异,手动审查改动内容,确保提交符合规范。

如果您在使用VSCode进行开发时,希望在提交代码前自动检查文件改动与代码质量,以避免提交不符合规范的代码,则可以通过配置Git Hooks或集成扩展来实现自动化检查。以下是几种可行的方法:
一、使用Git Hooks结合Shell脚本执行检查
通过Git自带的pre-commit钩子,可以在每次提交前运行自定义脚本,例如检查代码风格、运行测试或验证文件改动内容。
1、进入项目根目录下的.git/hooks文件夹:cd .git/hooks。
2、创建或编辑名为pre-commit的脚本文件:touch pre-commit && chmod +x pre-commit。
3、在pre-commit文件中添加检查逻辑,例如使用ESLint检查javaScript代码:
#!/bin/sh echo "正在运行代码检查..." git diff --cached --name-only --diff-filter=d | grep '.js$' | xargs eslint --fix if [ $? -ne 0 ]; then echo "代码检查未通过,请修复问题后再提交。" exit 1 fi
4、保存后,每次执行git commit时都会自动触发该脚本。
二、安装并配置Prettier与ESLint实现自动格式化
利用VSCode中的Prettier和ESLint扩展,在提交前自动格式化代码并提示错误,确保代码风格统一。
1、在VSCode扩展市场中搜索并安装Prettier – Code formatter和ESLint。
2、在项目根目录创建或修改.vscode/settings.json文件,启用保存时自动格式化:
{ "editor.formatOnSave": true, "editor.codeActionsOnSave": { "source.fixAll.eslint": true } }
3、确保项目中已安装eslint和相关规则包,例如eslint-config-airbnb。
4、当您保存文件时,ESLint会自动修复可处理的问题,Prettier会对代码进行格式化。
三、使用Husky与Lint-Staged构建现代化提交前检查流程
Husky可以简化Git Hooks的管理,配合Lint-Staged仅对暂存文件执行检查,提升效率。
1、在项目中初始化npm环境(若尚未初始化):npm init -y。
2、安装Husky和Lint-Staged:npm install husky lint-staged –save-dev。
3、启用Husky并创建hooks目录:npx husky install,然后将其添加到package.json的prepare脚本中。
4、配置package.json,添加lint-staged任务:
"lint-staged": { "*.js": ["eslint --fix", "prettier --write"], "*.ts": ["eslint --fix", "prettier --write"] }
5、设置pre-commit钩子执行lint-staged:npx husky add .husky/pre-commit “npx lint-staged”。
6、此后每次提交,只会对已暂存的文件运行指定检查命令。
四、在VSCode中查看文件改动差异
在提交前手动审查文件改动是保证代码质量的重要步骤,VSCode提供了直观的界面帮助您查看变更。
1、打开VSCode左侧活动栏中的源代码管理视图(快捷键Ctrl+Shift+G)。
2、在“更改”列表中,点击任一文件名即可在编辑器中显示其改动差异。
3、绿色背景表示新增行,红色背景表示删除行,仔细核对每一处修改是否符合预期。
4、右键点击某个文件可选择“放弃更改”或“暂存更改”,便于精细化控制提交内容。