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

./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 未提交更改的文件，则可以使用 --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 配置器。

排除文件/文件夹

默认情况下，Pint 将检查项目中除 vendor 目录中的文件之外的所有 .php 文件。如果您希望排除更多文件夹，可以使用 exclude 配置选项来实现

{
    "exclude": [
        "my-specific/folder"
    ]
}

如果您希望排除所有包含给定名称模式的文件，可以使用 notName 配置选项来实现

{
    "notName": [
        "*-my-file.php"
    ]
}

如果您想通过提供文件的确切路径来排除文件，可以使用 notPath 配置选项来实现

{
    "notPath": [
        "path/to/excluded-file.php"
    ]
}

持续集成

GitHub Actions

要使用 Laravel Pint 自动执行项目的 linting，您可以配置 GitHub Actions，以便在将新代码推送到 GitHub 时运行 Pint。首先，请确保在 GitHub 中的“**设置 > 操作 > 常规 > 工作流权限**”中授予工作流“读取和写入权限”。然后，创建一个 .github/workflows/lint.yml 文件，其中包含以下内容

name: Fix Code Style
 
on: [push]
 
jobs:
  lint:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: true
      matrix:
        php: [8.3]
 
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
 
      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ matrix.php }}
          extensions: json, dom, curl, libxml, mbstring
          coverage: none
 
      - name: Install Pint
        run: composer global require laravel/pint
 
      - name: Run Pint
        run: pint
 
      - name: Commit linted files
        uses: stefanzweifel/git-auto-commit-action@v5
        with:
          commit_message: "Fixes coding style"