Laravel Pint

• 介绍
• 安装
• 运行 Pint
• 配置 Pint
  • 预设
  • 规则
  • 排除文件/文件夹
• 持续集成
  • GitHub Actions

介绍

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 将显示所有更新文件的详细列表。您可以通过在调用 Pint 时提供 -v 选项来查看有关 Pint 更改的更多详细信息：

./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/phpdoc_type_annotations_only

该规则会移除代码中的所有注释和文档块描述，仅保留包含 @ 注解的行，例如 @param、@return、@var、@phpstan-type 等：

/**
 * 获取用户的文章。
 *
 * @return HasMany<Post, $this>
 */
public function posts(): HasMany

单行注释和不包含 @ 注解的块注释将被完全移除。如果你想保留某条特定的注释，可以在其前面加上 @note、@warning 或 @todo：

// @note 这条注释将被保留。

要启用此规则，请将其添加到你的 pint.json 文件中：

{
    "preset": "laravel",
    "rules": {
        "Pint/phpdoc_type_annotations_only": true
    }
}

注意

此规则会自动跳过 config 目录中的文件，因为配置文件通常依赖注释作为文档。

排除文件/文件夹

默认情况下，Pint 将检查项目中的所有 .php 文件，除了 vendor 目录中的文件。如果您希望排除更多文件夹，可以使用 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