编辑此页面 →

CLI API 参考

在 Pest 文档的前几章中，我们介绍了许多 Pest 中可用的 CLI 选项。尽管如此，Pest 还提供了许多其他可能证明有益的选项。为了方便起见，下面提供了完整的 CLI API 参考。

配置

--init: 初始化标准的 Pest 配置。
-c|--configuration <file>: 从 XML 文件读取配置。
--no-configuration: 忽略默认配置文件 (phpunit.xml)。
--no-extensions: 不加载 PHPUnit 扩展。
--include-path <path(s)>: 使用给定的路径将 PHP 的 include_path 放在前面。
-d <key[=value]>: 设置 php.ini 值。
--cache-directory <dir>: 指定缓存目录。
--generate-configuration: 使用建议的设置生成配置文件。
--migrate-configuration: 将配置文件迁移到当前格式。
--test-directory: 指定包含 Pest.php、TestCase.php、助手和测试的测试目录。默认值：tests

选择

--bail: 在第一个未通过的测试时停止执行。
--todos: 将待办事项列表输出到标准输出。
--retry: 首先运行未通过的测试，并在第一个错误或失败时停止执行。
--exclude-testsuite <name>: 从指定的测试套件中排除测试。
--list-groups: 列出可用的测试组。
--group <name>: 仅运行指定组中的测试。
--exclude-group <name>: 从指定的组中排除测试。
--covers <name>: 仅运行旨在覆盖 <name> 的测试。
--uses <name>: 仅运行旨在使用 <name> 的测试。
--list-tests: 列出可用的测试。
--list-tests-xml <file>: 以 XML 格式列出可用的测试。
--filter <pattern>: 过滤要运行的测试
--test-suffix <suffixes>: 仅在具有指定后缀的文件中搜索测试。默认值：Test.php,.phpt

执行

--globals-backup: 为每个测试备份和恢复 $GLOBALS。
--static-backup: 为每个测试备份和恢复静态属性。
--strict-coverage: 对代码覆盖率元数据严格。
--strict-global-state: 对全局状态的更改严格。
--disallow-test-output: 对测试期间的输出严格。
--enforce-time-limit: 根据测试大小强制执行时间限制。
--default-time-limit <sec>: 未声明大小的测试的超时时间（秒）。
--dont-report-useless-tests: 不报告不测试任何内容的测试。
--stop-on-defect: 在第一个未通过的测试时停止执行。
--stop-on-error: 在第一个错误时停止执行。
--stop-on-failure: 在第一个错误或失败时停止执行。
--stop-on-warning: 在第一个警告时停止执行。
--stop-on-risky: 在第一个有风险的测试时停止执行。
--stop-on-skipped: 在第一个跳过的测试时停止执行。
--stop-on-incomplete: 在第一个不完整的测试时停止执行。
--fail-on-incomplete: 将不完整的测试视为失败。
--fail-on-risky: 将有风险的测试视为失败。
--fail-on-skipped: 将跳过的测试视为失败。
--fail-on-warning: 将带有警告的测试视为失败。
--cache-result: 将测试结果写入缓存文件。
--do-not-cache-result: 不将测试结果写入缓存文件
--order-by <order>: 按顺序运行测试：default|defects|depends|duration|no-depends|random|reverse|size。
--random-order-seed <N>: 在随机顺序运行测试时使用指定的随机种子