简介
Laravel Pint 是一款面向极简主义者、带有明确倾向的 PHP 代码风格修复工具。Pint 构建于 PHP CS Fixer 之上，可让您轻松确保代码风格保持整洁一致。
Pint 会随所有新的 Laravel 应用自动安装，因此您可以立即开始使用。默认情况下，Pint 无需任何配置，会遵循 Laravel 的代码风格倾向，自动修复代码中的风格问题。
安装
Pint 已包含在 Laravel 框架的近期版本中，因此通常无需安装。不过，对于旧应用，您可以通过 Composer 安装 Laravel Pint：
composer require laravel/pint --dev运行 Pint
您可以调用项目 vendor/bin 目录下的 pint 可执行文件，让 Pint 修复代码风格问题：
./vendor/bin/pint如果您希望 Pint 以并行模式（实验性）运行以提升性能，可以使用 --parallel 选项：
./vendor/bin/pint --parallel并行模式还允许您通过 --max-processes 选项指定要运行的最大进程数。若未提供该选项，Pint 将使用机器上所有可用的核心：
./vendor/bin/pint --parallel --max-processes=4您也可以对特定文件或目录运行 Pint：
./vendor/bin/pint app/Models
./vendor/bin/pint app/Models/User.php默认情况下，Pint 不会格式化 Blade 模板。如果您也想格式化 .blade.php 文件，可以使用 --blade 选项，该选项会在不修改 pint.json 文件的前提下，为当前运行启用 Pint/laravel_blade 规则：
./vendor/bin/pint --bladePint 会列出所有已更新文件的详细信息。在调用 Pint 时提供 -v 选项，可以查看更详细的更改信息：
./vendor/bin/pint -v如果您希望 Pint 仅检查代码的风格错误而不实际更改文件，可以使用 --test 选项。若发现任何代码风格错误，Pint 会返回非零退出码：
./vendor/bin/pint --test如果您希望 Pint 仅根据 Git 对与指定分支存在差异的文件进行修改，可以使用 --diff=[branch] 选项。此选项可有效用于 CI 环境（如 GitHub Actions），通过仅检查新增或修改的文件来节省时间：
./vendor/bin/pint --diff=main如果您希望 Pint 仅修改 Git 中存在未提交更改的文件，可以使用 --dirty 选项：
./vendor/bin/pint --dirty如果您希望 Pint 修复所有存在代码风格错误的文件，并且在修复任何错误后以非零退出码退出，可以使用 --repair 选项：
./vendor/bin/pint --repair配置 Pint
如前所述，Pint 无需任何配置。不过，如果您希望自定义预设、规则或要检查的文件夹，可以在项目根目录创建 pint.json 文件：
{
"preset": "laravel"
}此外，如果您希望使用来自特定目录的 pint.json，可以在调用 Pint 时提供 --config 选项：
./vendor/bin/pint --config vendor/my-company/coding-style/pint.json预设
预设定义了一组规则，可用于修复代码中的风格问题。默认情况下，Pint 使用 laravel 预设，它会遵循 Laravel 的代码风格倾向来修复问题。不过，您也可以通过向 Pint 提供 --preset 选项来指定其他预设：
./vendor/bin/pint --preset psr12如有需要，您也可以在项目的 pint.json 文件中设置预设：
{
"preset": "psr12"
}Pint 目前支持的预设有：laravel、per、psr12、symfony 和 empty。
规则
规则是 Pint 用于修复代码风格问题的代码风格指南。如上所述，预设是规则的预定义组合，适用于大多数 PHP 项目，因此您通常无需关心其包含的单条规则。
不过，如有需要，您可以在 pint.json 文件中启用或禁用特定规则，也可以使用 empty 预设并从零开始定义规则：
{
"preset": "laravel",
"rules": {
"simplified_null_return": true,
"array_indentation": false,
"new_with_parentheses": {
"anonymous_class": true,
"named_class": true
}
}
}Pint 构建于 PHP CS Fixer 之上。因此，您可以使用其任何规则来修复项目中的代码风格问题：PHP CS Fixer Configurator。
自定义规则
除了 PHP CS Fixer 规则外，Pint 还提供了以 Pint/ 为前缀的自定义规则。这些规则默认未启用，但您可以在 pint.json 文件中启用它们。
Pint/laravel_blade
此规则会对您的 Blade 模板进行格式化，为 .blade.php 文件应用一致的缩进、间距和属性格式。默认情况下，Pint 不会格式化 Blade 文件，因此您必须在 pint.json 文件中启用此规则才能启用该功能：
{
"preset": "laravel",
"rules": {
"Pint/laravel_blade": true
}
}启用后，Pint 在运行时会同时格式化 Blade 模板和 PHP 文件：
./vendor/bin/pint另外，如果您想在不修改 pint.json 文件的情况下，仅为单次运行启用此规则，可以使用 --blade 选项：
./vendor/bin/pint --blade在底层，此规则会使用 Prettier，并配合 prettier-plugin-blade 与 prettier-plugin-tailwindcss 插件，因此您的机器上必须安装 Node.js。首次在启用此规则的情况下运行 Pint 时，Pint 会检测缺失的 Prettier 依赖，并提示您进行安装。
此规则会自动跳过通常依赖自身格式的文件，例如遵循 Laravel Boost 指南的文件，以及位于 resources/views/emails 与 resources/views/mail 目录下的邮件视图。
Pint/phpdoc_type_annotations_only
此规则会移除代码中的所有注释和文档块正文，仅保留包含 @ 标注的行，例如 @param、@return、@var、@phpstan-type 等：
/**
* Get the posts for the user.
*
* @return HasMany<Post, $this>
*/
public function posts(): HasMany不包含 @ 标注的单行注释和块注释会被完全移除。如果您想保留某条特定注释，可以在其前面加上 @note、@warning 或 @todo 前缀：
// @note This comment will be preserved.要启用此规则，请将其添加到您的 pint.json 文件中：
{
"preset": "laravel",
"rules": {
"Pint/phpdoc_type_annotations_only": true
}
}此规则会自动跳过 config 目录中的文件，因为配置文件通常依赖注释来进行说明。
排除文件/文件夹
默认情况下，Pint 会检查项目中除 vendor 目录外的所有 .php 文件。如果您想排除更多文件夹，可以使用 exclude 配置项：
{
"exclude": [
"my-specific/folder"
]
}如果您想排除所有符合指定文件名模式的文件，可以使用 notName 配置项：
{
"notName": [
"*-my-file.php"
]
}如果您想通过提供文件的完整路径来排除某个文件，可以使用 notPath 配置项：
{
"notPath": [
"path/to/excluded-file.php"
]
}持续集成
GitHub Actions
若要使用 Laravel Pint 自动对项目进行代码检查，可配置 GitHub Actions，以便在有新代码推送到 GitHub 时自动运行 Pint。首先，请确保在 GitHub 中为工作流授予“读写权限”，路径为 Settings > Actions > General > Workflow permissions。然后，创建一个 .github/workflows/lint.yml 文件，内容如下：
name: Fix Code Style
on: [push]
jobs:
lint:
runs-on: ubuntu-latest
strategy:
fail-fast: true
matrix:
php: [8.4]
steps:
- name: Checkout code
uses: actions/checkout@v5
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
tools: pint
- name: Run Pint
run: pint
- name: Commit linted files
uses: stefanzweifel/git-auto-commit-action@v6