Trunk

作为开发者，我们很少会只使用一组已知、难忘的工具来处理一个单一的项目。我们的一些项目可能使用PHPStan，而另一些则使用Psalm。我们可能有一些旧项目正在运行PHP-CS-Fixer，但我们的新项目正在运行Pint。

如果不再这样呢？如果你可以使用单个命令并使其适用于所有项目会怎样？现在介绍 Trunk。

Trunk提供了一套命令，可以帮助你处理困难的事情。你可以在所有项目中使用相同的命令集，而不管使用的是哪些工具。

安装

Composer（推荐）

使用Composer安装Trunk

composer global require pxp/trunk

安装此软件包将要求一个名为 pact-foundation/composer-downloads-plugin 的插件，允许执行代码。对此回答 y，因为它负责为您系统下载适当的二进制文件。

安装完成后，请参阅下面的 命令 部分，并开始使用Trunk！

命令

fmt

fmt 命令使您能够轻松地格式化项目中的PHP代码。它目前支持以下格式化工具：

• php-cs-fixer
• pint

要格式化整个项目（或为您的编辑器配置的文件），请运行以下命令。

trunk fmt

如果您希望格式化特定的文件或目录，可以将路径作为命令的参数传递，并且它将被传递到底层的格式化工具（如果适用）。

trunk fmt ./src/Container/Container.php

如果您想进行Dry-run，可以传递 --dry-run (-d) 标志。

trunk fmt --dry-run

check

check 命令用于执行静态分析。它目前支持以下静态分析工具：

• phpstan
• psalm
• phan

要在整个项目上运行静态分析器，请使用以下命令

trunk check

如果您只想对单个文件进行静态分析，请使用以下命令

trunk check ./src/Container/Container.php

某些项目可能出于不同原因选择使用多个静态分析器。如果您的项目需要这样做，您可以通过--using（-u）选项传递一个逗号分隔的工具列表来运行。它们将按照提供的顺序执行。

trunk check --using=phpstan,psalm

测试

test命令用于执行任何形式的测试。目前它支持以下测试运行器

• phpunit
• pest

要运行您的测试，请使用以下命令

trunk test

如果您想执行特定的测试或测试目录，请使用以下命令

trunk test ./path/to/Test.php

在某些场景下，您可能需要向底层命令传递额外的参数。您可以通过在--符号之后放置额外的参数来完成此操作。所有额外的参数都将转发到底层测试运行器。

trunk test -- --parallel