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

您可以指示 Pint 修复代码风格问题，方法是在您的项目 vendor/bin 目录中调用可用的 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,
        "braces": false,
        "new_with_braces": {
            "anonymous_class": false,
            "named_class": false
        }
    }
}

Pint 基于 PHP-CS-Fixer 构建。因此，您可以使用其任何规则来修复项目中的代码风格问题：PHP-CS-Fixer 配置器.

排除文件/文件夹

默认情况下，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 上的 设置 > Actions > 常规 > 工作流程权限 中，向工作流程授予“读取和写入权限”。然后，创建一个包含以下内容的 .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"