想给Composer包增加安装提示?利用Post-create-project技巧

千敏同学_4998

千敏同学_4998

2026-06-05

469人浏览

原创

post-create-project-cmd仅在create-project生成新项目时触发,且必须定义在模板项目的composer.json中;它不适用于require场景,也无法在被依赖包中声明生效。

想给composer包增加安装提示?利用post-create-project技巧

不能靠 post-create-project-cmd 给“自己发布的包”加安装提示——它只对被 create-project 创建出的新项目生效,且提示必须写在那个新项目的 composer.json 里。

post-create-project-cmd 的执行主体不是你的包,而是新项目

很多人想在自己写的组件包(比如 vendor/my-component)里加个钩子,让别人 composer require vendor/my-component 时弹个提示。这行不通。post-create-project-cmd 根本不参与 require 流程,只在 composer create-project vendor/name 完成后、于**新生成的项目根目录**中执行,且前提是那个新项目的 composer.json 自己声明了该钩子。

也就是说:你作为包作者,只能把提示逻辑放进「模板项目」的 composer.json,而不是放进 my-component 这个库的配置里。

  • ✅ 正确场景:你维护一个 Laravel starter 模板(myorg/laravel-starter),它的 composer.json 里写了 "post-create-project-cmd",用户运行 composer create-project myorg/laravel-starter myapp 后,提示就出来了
  • ❌ 错误尝试:你在 my-component 的 composer.json 里写 "post-create-project-cmd",然后让用户 require 它——这个钩子永远不会被识别或执行
  • ⚠️ 注意:create-project 会把模板项目的整个 composer.json 复制到新项目中,所以钩子是“随骨架一起落地”的,不是远程调用

想给 require 行为加提示?用 post-install-cmd + 条件判断

如果你的真实需求是:“只要有人装了我的包,就想让他看到一行提示”,那得换思路:post-install-cmd 或 post-update-cmd 更合适,但要防止重复刷屏。

关键在于判断当前是否首次安装你的包,而不是整个项目。Composer 没有原生事件支持“某包安装完成”,但你可以借 composer show --format=json vendor/my-component 或检查 vendor/vendor/my-component 目录是否存在来间接判断。更轻量的做法是写个简单 PHP 脚本:

php -r "if (file_exists('vendor/vendor/my-component')) { echo "\n? my-component installed successfully!\n"; }"

把它塞进主项目的 post-install-cmd 数组里即可。不过要注意:

  • 这个提示会在每次 composer install 都出现,除非你加文件标记(如写个 .my-component-installed)并先检查
  • 不要用 echo 直接输出——某些 CI 环境会静默掉 stdout,建议加 fprintf(STDERR, ...) 提高可见性
  • 如果提示含交互内容(如“按回车继续”),create-project 默认关闭 stdin,必须加 --interactive 参数才有效

拼写和格式错误会导致钩子彻底静默

post-create-project-cmd 是 Composer 中最易写错的钩子名之一。它不是 post-create-project,也不是 post-create-project-command,更不是 PostCreateProjectCmd。

Discussion Composer
Discussion Composer

围绕关键发现、作用机制、临床相关性及研究局限性展开讨论。适用于撰写或优化任何生物医学论文的“讨论(Discussion)”部分——包括结果解读、与既往文献关联、阐释意外发现、界定研究局限性,以及撰写结论。当用户输入以下任一指令时也会自动触发该功能: - “write my discussion” - “help me discuss my findings” - “how do I compare to prior studies” - “write the limitations par

下载

常见失效原因包括:

  • 名字多一个 r:写成 post-create-project-cmd ✅ vs post-create-project-cmd ❌(后者根本不存在)
  • 用了空格或下划线代替连字符:"post install cmd" 或 "post_create_project_cmd"
  • 值不是数组:"post-create-project-cmd": "php -r "echo 'hi';"" ❌(必须是字符串数组)
  • 放在了子依赖的 composer.json 里,而不是目标模板项目的根配置中

一旦写错,Composer 不报错、不警告、不提示——它就当没这回事,直接跳过。

真正可控的提示方式:用自定义脚本 + run-script

如果既要提示,又要确保只在特定时机触发、还能传参或做环境判断,推荐放弃钩子,改用显式调用:

在你的模板项目 composer.json 的 scripts 里加一条:

"scripts": {
  "welcome": [
    "php -r "echo '\n? Welcome to my template!\n';""
  ]
}

然后告诉用户安装完运行:

composer run-script welcome

这种方式优势明显:

  • 完全可控:不会被 --no-scripts 或环境变量意外屏蔽
  • 可带参数:composer run-script welcome -- --env=prod(需脚本自行解析)
  • 调试方便:单独执行就能验证,不用反复跑 create-project
  • 兼容性好:不依赖钩子机制,Composer 1.x / 2.x 均可用

复杂点在于:它需要用户多打一行命令;容易被忽略的地方是——没人告诉你该运行什么,所以得在 README 或 create-project 输出末尾加一行提示,比如用 post-create-project-cmd 输出那句 “Run composer run-script welcome to get started”。

相关文章

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

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

下载

相关标签:

composer

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

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3129

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2308

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1240

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1198

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1356

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2138

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3440

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

15575

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

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

精品课程

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

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习