TP8.0 利用 Git Hooks 实现代码提交前的自动检测【规范】

陌雪酱_6629

陌雪酱_6629

2026-07-17

508人浏览

原创

需在ThinkPHP 8.0项目中配置Husky+lint-staged实现pre-commit自动检查:初始化Husky、配置lint-staged仅扫描暂存区PHP/HTML文件并执行php-cs-fixer和phpstan,再通过php-no-debug或shell脚本拦截调试语句,确保提交前规范与安全。

tp8.0 利用 git hooks 实现代码提交前的自动检测【规范】

在 ThinkPHP 8.0 项目中,每次提交前手动运行 phpstan、php-cs-fixer、git status 检查是否漏加文件或存在未处理的 console/debugger,既打断开发节奏又容易遗漏。你需要一套稳定、轻量、开箱即用的 pre-commit 防守机制,让规范检查成为 Git 提交流程中不可跳过的自然环节。

初始化 Husky 环境

TP8.0 项目默认不带钩子管理器,必须用 Husky 而非手写 .git/hooks/pre-commit —— 后者在 Windows 下常因换行符、PATH 缺失、node_modules/.bin 路径解析失败而静默失效。【Husky 会自动注入环境变量并跨平台解析 package.json scripts】

执行以下命令:

npx husky-init && npm install

该命令会:自动创建 .husky 目录、改写 .git/hooks/pre-commit 为 Husky 托管脚本、并在 package.json 中插入 "prepare": "husky install"。

配置 lint-staged 精准检查变更文件

全量扫描 app/ 和 route/ 目录下所有 PHP 文件会拖慢提交速度,尤其在 vendor 已安装大量依赖时可能卡顿 8 秒以上。必须只检查本次 git add 进暂存区的文件。

安装依赖:

npm install --save-dev lint-staged

在 package.json 中添加配置段(注意缩进必须为 2 空格,JSON 不允许注释):

"lint-staged": { "app/**/*.{php,html}": ["php-cs-fixer fix --dry-run --using-cache=no", "phpstan analyse --no-interaction"], "route/**/*.{php}": ["phpstan analyse --no-interaction"] }

⚠️ 注意:glob 匹配路径基于项目根目录,不是 .git 目录;若你把控制器放在 app/controller/,请确保路径写成 "app/controller/**/*.{php}"。

绑定 pre-commit 钩子执行 lint-staged

进入 .husky/pre-commit 文件,替换全部内容为:

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
npx lint-staged

这一步不能省略 husky.sh 的引入 —— 它负责加载正确的 Node 环境和 PATH。

保存后,无需 chmod +x,Husky 已自动设好权限。

从 Git 仓库历史中彻底删除文件
从 Git 仓库历史中彻底删除文件

|Git删除了文件,但还会在Git 仓库历史中遗留。 - 想要从 Git 历史移除敏感信息(密码、密钥、token、私钥) - 想要删除意外提交的大文件 - 想要重写 Git 历史、移除特定文件的所有痕迹 - 提到 "force push"、"重写 commit 历史" - 需要从所有分支、所有 tag 中删除某个文件

下载

补充:拦截危险调试语句(console/debugger)

TP8.0 项目中残留 console.log 或 dump() 会暴露调试信息到生产日志,甚至引发 JSON 输出中断。需单独拦截。

方法一:用 shell 脚本原生过滤

在项目根目录新建 scripts/check-debug.sh,内容如下:

#!/bin/sh
for file in $(git diff --cached --name-only --diff-filter=ACM | grep '\.php$'); do
  if grep -nE 'console\.log|dump\(|dd\(|debugger|var_dump\(|print_r\(' "$file" >/dev/null 2>&1; then
    echo "❌ $file 包含调试语句,请删除后再提交";
    exit 1
  fi
done

给脚本加执行权限:
chmod +x scripts/check-debug.sh

然后在 .husky/pre-commit 最后一行追加:
sh ./scripts/check-debug.sh

方法二:复用 ESLint 思路(推荐)

安装 php-no-debug:
npm install --save-dev php-no-debug

在 lint-staged 配置中加入:
"app/**/*.{php}": ["php-no-debug check"]

该工具专为 PHP 设计,能识别 var_dump、dd、dump、debug_print_backtrace 等 12 种常见调试调用,并精准定位行号。

验证钩子是否生效

第一步:修改一个控制器文件,在某行插入 dd('test');

第二步:git add app/controller/IndexController.php

第三步:git commit -m "test debug hook"

如果看到 ❌ 提示并终止提交,说明钩子已激活;若直接提交成功,检查 .husky/pre-commit 是否被其他命令覆盖、scripts/check-debug.sh 是否有 CRLF 换行符、或 lint-staged 是否匹配到了该文件路径。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

thinkphp git

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

2023.07.05

6839

9

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

2023.07.06

1920

6

git撤销提交的commit
git撤销提交的commit

Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。

2023.07.24

1154

5

git提交错误怎么撤回
git提交错误怎么撤回

git提交错误撤回的方法:git reset head^:撤回最后一次提交,恢复到提交前状态。git revert head:创建新提交,内容与之前提交相反。git reset :使用提交的 sha-1 哈希撤回指定提交。交互式舞台区:标记要撤回的特定更改,然后提交,排除已撤回更改。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

4457

7

git怎么对比两个版本的文件内容
git怎么对比两个版本的文件内容

要对比两个版本的 git 文件,请使用 git diff 命令:git diff 比较工作树和暂存区之间的差异。git diff 比较两个提交或标签之间的差异。git diff 输出显示差异块,其中 + 表示添加的行,- 表示删除的行, 表示修改的行。可使用 gitkraken、meld、beyond compare 等可视化工具更直观地查看差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

4301

6

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

2026.10.28

40

16

Vite 如何搭配 Vue.js
Vite 如何搭配 Vue.js

Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章,帮助读者完成从初始化到日常开发的配置。

2026.10.28

20

15

Vite 项目目录怎么看
Vite 项目目录怎么看

Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章,帮助读者理解各文件夹的用途与引用方式。

2026.10.28

40

10

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

2026.10.22

140

11

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程