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

Running 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 选项：

pint --config vendor/my-company/coding-style/pint.json

Presets

预设定义了一组可用于修复代码中代码样式问题的规则。默认情况下，Pint 使用 laravel 预设，它通过遵循 Laravel 固执己见的编码风格来解决问题。但是，您可以通过为 Pint 提供 --preset 选项来指定不同的预设：

pint --preset psr12

如果您愿意，您还可以在项目的 pint.json 文件中设置预设：

{
    "preset": "psr12"
}

Pint's currently supported presets are: laravel, per, psr12, symfony, and empty.

规则

规则是 Pint 将用于修复代码中的代码样式问题的样式准则。如上所述，预设是预定义的规则组，应该非常适合大多数 PHP 项目，因此您通常不需要担心它们包含的单个规则。

但是，如果您愿意，可以在 pint.json 文件中启用或禁用特定规则，或者使用空预设并从头开始定义规则：

{
    "preset": "laravel",
    "rules": {
        "simplified_null_return": true,
        "braces": false,
        "new_with_braces": {
            "anonymous_class": false,
            "named_class": false
        }
    }
}

Pint is built on top of PHP-CS-Fixer. Therefore, you may use any of its rules to fix code style issues in your project: PHP-CS-Fixer Configurator.

排除文件/文件夹

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