Composer脚本怎么检查未提交的代码

冬明君_2997

冬明君_2997

2026-11-02

667人浏览

原创

不能。Composer 本身不提供 Git 状态检测能力,composer run-script 仅执行 scripts 字段定义的命令,需手动添加 git status --porcelain 等命令实现未提交代码检查。

composer脚本怎么检查未提交的代码

composer run-script 能不能直接检查未提交代码?

不能。Composer 本身不提供 Git 状态检测能力,composer run-script 只负责执行你定义在 scripts 字段里的命令,它不会自动读取 Git 工作区状态。所谓“检查未提交代码”,本质是调用 git status --porcelain 或类似命令,必须你自己写进脚本里。

怎么在 composer.json 中定义一个「检查未提交」的脚本?

在 composer.json 的 scripts 段添加一条 shell 命令即可,关键是用 git status --porcelain 判断是否有修改:

"scripts": {
  "check:dirty": "git status --porcelain | grep -q '.' || (echo '✅ No uncommitted changes.' && exit 0) || (echo '❌ Uncommitted changes detected.' && exit 1)"
}

说明与要点:

  • git status --porcelain 输出为空表示干净;有任意输出(哪怕只有一行)就代表存在未提交变更
  • grep -q '.' 是最简判断:只要匹配到任意字符即视为“有输出”,避免空格/换行干扰
  • 该命令退出码为 1 时,CI 或 composer run-script 会中止后续流程,适合用在 pre-commit 或 CI 的前置检查中
  • Windows 用户注意:git 必须在 PATH 中,且 PowerShell/CMD 对管道语法支持有限,建议在 Git Bash 或 WSL 下运行
  • 如果只想检查特定目录(如只关心 src/),加 -- src/ 参数:git status --porcelain -- src/

为什么加了脚本但运行没反应或总成功?

常见失效原因不是逻辑错,而是环境或配置问题:

Academic Composer Upload
Academic Composer Upload

辅助学术写作,包括查找资料、生成大纲、引用扩写及润色风格,同时确保引用规范。

下载
  • scripts 字段拼写错误:必须是 "scripts"(全小写、无空格、无冒号后空格),写成 "script" 或 "Scripts" 都无效
  • 脚本名含非法字符:比如用了中文、全角标点、或开头数字,会导致 Composer 忽略该条目
  • Git 不在 PATH:某些 CI 环境(如最小化 Alpine 镜像)默认没装 Git,git: command not found 会被静默吞掉,脚本退出码为 127,但 Composer 默认不报错——加 --verbose 可看到真实错误
  • 项目不在 Git 仓库根目录:脚本执行时当前工作目录是项目根(含 composer.json),但如果该目录下没有 .git,git status 会失败
  • 使用了 composer run-script check:dirty --no-ansi 等参数干扰输出,但不影响退出码逻辑

和 pre-commit hook 配合时要注意什么?

很多团队想把「检查未提交」塞进 pre-commit,但这里有个关键陷阱:

  • pre-commit hook 运行时,Git 尚未暂存新文件,git status --porcelain 会显示 ?? newfile.php ——这属于「未跟踪文件」,是否算“脏”取决于你的定义
  • 如果你只关心已跟踪但未提交的修改(M、D、MM 等),应改用:git status --porcelain --ignored=no | grep '^[MADRC]'
  • 不要在 hook 里直接调用 composer run-script,因为 hook 执行路径可能不是项目根;推荐写成独立 shell 脚本并硬编码项目路径,或确保 cd $(git rev-parse --show-toplevel) 先切过去
  • IDE 自动保存 + Git 插件(如 PHPStorm 的 Commit dialog)有时会绕过 hook,实际提交前仍需人工确认

真正要靠住的,不是脚本有没有运行,而是它的退出码是否被下游流程(CI、hook、Makefile)严格消费。别信输出文字,盯住 $?。

相关文章

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

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

下载

相关标签:

composer脚本 composer

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

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.12.25

364

5

Composer 安装与快速入门指南
Composer 安装与快速入门指南

面向 PHP 开发新手,详细介绍 Composer 的下载安装方式(本地安装与全局安装)、国内镜像源(阿里云/腾讯云)加速配置、composer.json 与 composer.lock 文件的作用解析、require/install/update 等核心命令的使用方法,帮助开发者快速掌握 PHP 依赖管理的基本工作流。

2026.04.10

603

36

Composer 依赖管理与版本控制实战
Composer 依赖管理与版本控制实战

深入讲解 Composer 的依赖管理机制,涵盖语义化版本号规范、版本约束符(^、~、*、>=)的区别与最佳实践、composer.lock 在团队协作中的锁定策略、依赖冲突的排查与解决方法、require-dev 与生产依赖的分离管理、平台依赖检查(platform-check)等进阶内容,帮助开发者在项目中精准控制依赖版本、避免"依赖地狱"。

2026.04.10

367

29

Composer 自定义包开发与发布教程合集
Composer 自定义包开发与发布教程合集

以实际项目为导向,讲解如何从零创建一个符合规范的 Composer 包,涵盖 composer.json 元信息配置、PSR-4 自动加载规则设置、命名空间规划、单元测试集成、README 与 LICENSE 编写规范,以及将包提交到 Packagist 公共仓库或搭建 Satis/Private Packagist 私有仓库的完整发布流程,帮助开发者将可复用代码封装为标准化的 Composer 包。

2026.04.10

369

15

Composer 自动加载机制与性能优化
Composer 自动加载机制与性能优化

系统剖析 Composer 的自动加载体系,讲解 PSR-0 与 PSR-4 自动加载标准的区别与演进、classmap 与 files 加载方式的适用场景、autoload_real.php 源码级加载流程解析,同时介绍 composer dump-autoload -o 优化加载映射、APCu 缓存加速、authoritative-classmap 配置等生产环境性能优化手段,帮助开发者深入理解自动加载原理并提升项目启动速度。

2026.04.13

320

21

Composer 在主流 PHP 框架中的应用实践
Composer 在主流 PHP 框架中的应用实践

结合 Laravel、ThinkPHP、Symfony 等主流 PHP 框架的实际场景,讲解 Composer 在框架项目中的典型应用,包括通过 create-project 初始化框架项目、安装与管理第三方扩展包、scripts 钩子(post-install/post-update)自动执行部署任务、自定义 Installer 插件开发、多项目共享 vendor 依赖的 Monorepo 工作流管理,帮助开发者在真实框架项目中充分发

2026.04.13

523

14

Composer 镜像源配置与网络问题排查
Composer 镜像源配置与网络问题排查

针对国内开发者常遇到的 Composer 网络问题,详细讲解阿里云、腾讯云、华为云等国内镜像源的全局与项目级切换方法、多镜像源优先级配置策略、composer config 命令行快速设置技巧,同时涵盖 SSL 证书错误、连接超时、下载中断等常见网络报错的排查与修复方案,以及利用 artifact / path 仓库实现完全离线环境下的依赖安装。

2026.04.14

311

24

Composer Scripts 脚本与自动化工作流
Composer Scripts 脚本与自动化工作流

系统讲解 Composer Scripts 机制的完整用法,涵盖 pre-install、post-update、post-autoload-dump 等内置事件钩子的触发时机与应用场景、自定义脚本命令的定义与参数传递、调用外部 Shell 命令与 PHP 静态方法、多脚本串联执行与条件判断,以及结合代码检查(PHPStan/PHP-CS-Fixer)、数据库迁移、缓存清理等任务构建一键部署自动化工作流。

2026.04.14

390

18

Composer 私有仓库搭建与企业级管理
Composer 私有仓库搭建与企业级管理

面向团队与企业开发场景,讲解如何使用 Satis 搭建轻量级静态私有仓库、通过 Toran Proxy / Private Packagist 构建功能完善的企业级私有包管理平台,涵盖 Git/SVN 仓库类型接入、Token 鉴权与访问权限控制、Webhook 自动触发包更新、内网部署方案以及与 GitLab CI/CD 流水线的集成配置,帮助企业安全高效地管理内部 PHP 组件资产。

2026.04.14

440

26

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpMyAdmin 安装文档
phpMyAdmin 安装文档

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习