pds/ composer-script-names
Composer 脚本名称的标准。
README
本出版物描述了一个适用于所有 PHP 包的 Composer 脚本名称标准。
有关背景信息,请参阅 https://github.com/php-pds/composer-script-names_research。
本出版物中的“必须”,“不允许”,“必需”,“应”,“不应”,“应该”,“不应该”,“推荐”,“可能”和“可选”等关键词的解释,请参阅 RFC 2119。
摘要
composer.json
文件中的脚本名称必须是小写的,并且必须使用连字符作为单词分隔符。
composer.json
文件必须使用这些脚本名称来执行以下目的
命名约定
composer.json
文件中的脚本名称必须是小写的,并且必须使用连字符作为单词分隔符。
符合规范的脚本名称示例
foo
foo-bar
foo-bar-baz
不符合规范的脚本名称示例
Foo
foo:bar
foo_bar:Baz
脚本名称
test
如果 composer.json
文件定义了一个使用默认配置运行测试的脚本,则该脚本必须命名为 test
。
本出版物未定义其他测试工具。
test-coverage
如果 composer.json
文件定义了一个使用默认配置和覆盖率生成运行测试的脚本,则必须命名为 test-coverage
。
本出版物未定义其他测试覆盖率工具。
test-*
如果 composer.json
文件定义了一个使用替代配置或方法运行测试的脚本,则必须使用前缀 test-
加上描述性后缀。
示例
test-behavior
test-filter
test-integration
test-system
除了 test-coverage
,本出版物未定义任何 test-*
描述性后缀的含义。
cs-fix
如果 composer.json
文件定义了一个使用默认配置运行代码样式修复器或代码检查器的脚本,则必须命名为 cs-fix
。
本出版物未定义其他样式修复器或代码检查器工具。
analyse
或 analyze
如果 composer.json
文件定义了一个使用默认配置运行静态分析的脚本,则必须命名为 analyse
或 analyze
。
注意:命名选项反映了美式英语和英式英语使用者的典型差异。
本出版物未定义其他静态分析工具。
check
如果 composer.json
文件定义了一个运行多个质量保证脚本或命令的脚本的脚本,则必须命名为 check
。
本出版物未定义特定的脚本或命令,也未定义它们运行的顺序。