laravelphp 中文文档      >

介绍

Laravel Pint 是面向极简主义者的 PHP 代码风格修复工具。Pint 建立在 PHP-CS-Fixer 之上，简化了确保代码风格保持清洁和一致的过程。

Pint 自动安装在所有新的 Laravel 应用程序中，因此您可以立即开始使用它。默认情况下，Pint 不需要任何配置，并且将通过遵循 Laravel 的主观编码风格来修复代码风格问题。

安装

Pint 已包含在 Laravel 框架的最新版本中，因此通常不需要安装。但是，对于旧应用程序，您可以通过 Composer 安装 Laravel Pint：

  1. composer require laravel/pint --dev

运行 Pint

您可以通过调用项目的 php vendor/bin 目录中的 php pint 二进制文件来指示 Pint 修复代码风格问题：

  1. ./vendor/bin/pint

您还可以在特定文件或目录上运行 Pint：

  1. ./vendor/bin/pint app/Models
  3. ./vendor/bin/pint app/Models/User.php

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

  1. ./vendor/bin/pint -v

如果您希望 Pint 仅检查代码样式错误而不实际更改文件，可以使用 php --test 选项。如果发现任何代码风格错误，Pint 将返回非零退出代码：

  1. ./vendor/bin/pint --test

如果您希望 Pint 仅修改根据 Git 有未提交更改的文件，您可以使用 php --dirty 选项：

  1. ./vendor/bin/pint --dirty

如果您希望 Pint 修复任何具有代码风格错误的文件，但同时在修复任何错误时退出并返回非零退出代码，您可以使用 php --repair 选项：

  1. ./vendor/bin/pint --repair

配置 Pint

如前所述，Pint 不需要任何配置。但是，如果您希望自定义预设、规则或检查的文件夹，您可以在项目的根目录中创建一个 php pint.json 文件：

  1. {
  2.     "preset": "laravel"
  3. }

此外，如果您希望使用特定目录中的 php pint.json，您可以在调用 Pint 时提供 php --config 选项：

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

预设

预设定义了一组规则，可用于修复代码风格问题。默认情况下，Pint 使用 php laravel 预设，通过遵循 Laravel 的主观编码风格来修复问题。但是，您可以通过向 Pint 提供 php --preset 选项来指定不同的预设：

  1. pint --preset psr12

如果需要，您也可以在项目的 php pint.json 文件中设置预设：

  1. {
  2.     "preset": "psr12"
  3. }

Pint 目前支持的预设有：php laravel、php per、php psr12 和 php symfony。

规则

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

然而，如果你愿意的话，你可以在你的 php pint.json 文件中启用或禁用特定规则：

  1. {
  2.     "preset": "laravel",
  3.     "rules": {
  4.         "simplified_null_return": true,
  5.         "braces": false,
  6.         "new_with_braces": {
  7.             "anonymous_class": false,
  8.             "named_class": false
  9.         }
  10.     }
  11. }

Pint 是建立在 PHP-CS-Fixer 之上的。因此，你可以使用它的任何规则来修复项目中的代码风格问题： PHP-CS-Fixer Configurator。

排除文件/文件夹

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

  1. {
  2.     "exclude": [
  3.         "my-specific/folder"
  4.     ]
  5. }

如果你希望排除所有包含特定名称模式的文件，你可以使用 php notName 配置选项：

  1. {
  2.     "notName": [
  3.         "*-my-file.php"
  4.     ]
  5. }

如果你希望通过提供文件的确切路径来排除文件，你可以使用 php notPath 配置选项：

  1. {
  2.     "notPath": [
  3.         "path/to/excluded-file.php"
  4.     ]
  5. }

持续集成

GitHub Actions

要使用 Laravel Pint 自动化检查你的项目代码风格，你可以配置 GitHub Actions 在代码推送到 GitHub 时运行 Pint。首先，请确保在 GitHub 的 Settings > Actions > General > Workflow permissions 中为 workflows 授予“读取和写入权限”。然后，创建一个名为 php .github/workflows/lint.yml 的文件，并包含以下内容：

  1. name: Fix Code Style
  3. on: [push]
  5. jobs:
  6.   lint:
  7.     runs-on: ubuntu-latest
  8.     strategy:
  9.       fail-fast: true
  10.       matrix:
  11.         php: [8.3]
  13.     steps:
  14.       - name: Checkout code
  15.         uses: actions/checkout@v4
  17.       - name: Setup PHP
  18.         uses: shivammathur/setup-php@v2
  19.         with:
  20.           php-version: ${{ matrix.php }}
  21.           extensions: json, dom, curl, libxml, mbstring
  22.           coverage: none
  24.       - name: Install Pint
  25.         run: composer global require laravel/pint
  27.       - name: Run Pint
  28.         run: pint
  30.       - name: Commit linted files
  31.         uses: stefanzweifel/git-auto-commit-action@v5
  32.         with:
  33.           commit_message: "Fixes coding style"