Composer如何使用scripts定义命令_Composer脚本钩子编写规范【核心】

千枫酱_4671

千枫酱_4671

2026-04-27

600人浏览

原创

scripts字段必须位于composer.json根层级,不可嵌套在extra、config等子字段中;键名须严格匹配官方事件名,值支持字符串、数组或php静态方法,且仅根目录composer.json中的scripts生效。

composer如何使用scripts定义命令_composer脚本钩子编写规范【核心】

scripts 字段必须写在根 composer.json 顶层,否则完全不生效。 它不是配置项、不是插件扩展、也不是 extra 或 config 的子字段——放错位置,脚本就等于没写。

scripts 字段必须在根 composer.json 顶层

常见错误是把它塞进 extra、config 或某个包的子配置里。Composer 只扫描项目根目录下 composer.json 的顶层 "scripts" 键:

  • ✅ 正确:"scripts": { "post-install-cmd": "php artisan optimize:clear" }
  • ❌ 错误:"extra": { "scripts": { ... } } —— 静默忽略
  • ❌ 错误:在 vendor/ 下某依赖包的 composer.json 里写 scripts —— 根本不读

验证方式很简单:composer run-script --list 输出里看不到你的脚本名,基本就是位置错了。用 composer validate 也能发现格式是否合法,但它不会报“scripts 不在顶层”这种语义错误。

内置事件名拼写必须严格匹配,大小写和连字符都不能错

Composer 不校验钩子名是否有效,拼错就直接跳过,且不提示。比如:

  • post-autoload-dump ✅(正确)
  • post-autoloader-dump ❌(多一个 r,不触发)
  • PostAutoloadDump ❌(驼峰,不识别)
  • post_dump_autoload ❌(下划线,非标准分隔符)

真正会被自动调用的事件名只有官方文档列出的那十几个,例如:pre-install-cmd、post-update-cmd、post-root-package-install。别自己造名字指望它“意会”——after-install、onRequire 这类写法永远不执行。

Discussion Composer
Discussion Composer

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

下载

命令值支持字符串、数组、PHP 类方法,但行为差异很大

同一个钩子名,不同写法执行逻辑完全不同:

  • 字符串:"post-install-cmd": "php artisan key:generate" —— 交给 shell 解析,引号、空格、转义全得自己处理,Windows 下容易崩
  • 数组:"post-install-cmd": ["php", "artisan", "key:generate"] —— Composer 直接 exec,绕过 shell,更安全、跨平台兼容性好
  • PHP 方法:"post-autoload-dump": "MyBuild\Scripts::clearCache" —— 要求类已能被 autoload 加载(推荐放 autoload-dev 里),方法必须是 public static,且签名可选接收 ComposerScriptEvent 对象

注意:数组形式里不能写 @xxx 别名(那是字符串命令里的语法),也不能带 && 或 || —— 数组每项独立执行,失败即中断。

@ 符号只在字符串命令中生效,用于递归调用其他 script

想复用已有脚本,得用 @ 前缀,但它只在字符串值里解析:

  • ✅ 有效:"test": "@clean && phpunit" → 先展开 @clean 成实际命令,再交给 shell 执行
  • ❌ 无效:"test": ["@clean", "phpunit"] → Composer 会尝试执行名为 @clean 的命令,报 command not found
  • ❌ 无效:"test": "clean && phpunit" → shell 找不到 clean 命令,因为 clean 是你定义的 script 名,不是系统命令

@ 展开是 Composer 内部机制,不经过 shell,所以能跨平台;但嵌套太深(比如 @a 调 @b 再调 @c)容易出错,建议控制在两层内。

最常被忽略的一点:脚本是否执行,和 composer install 是否真的做了事强相关。如果 vendor/ 已存在、composer.lock 没变,Composer 可能跳过安装流程,也就不会触发 post-install-cmd —— 这时候加 -v 看日志,你会发现根本没 “Executing script” 这行输出。

相关文章

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

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

下载

相关标签:

composer composer脚本

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

相关专题

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

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

2023.06.20

3289

3

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

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

2023.07.25

2348

9

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

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

2023.08.02

1280

5

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

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

2023.08.09

1238

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

1376

5

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

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

2023.09.20

2218

7

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

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

2023.09.20

3580

8

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

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

2023.09.22

16495

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人学习