介绍
Laravel Pint (opens in a new tab) 是一个为极简主义者打造的固执己见的 PHP 代码风格修复器。Pint 构建在 PHP-CS-Fixer 之上,能轻松确保您的代码风格保持干净且一致。
在所有新的 Laravel 应用程序中,Pint 会自动安装,因此您可以立即开始使用它。默认情况下,Pint 不需要任何配置,它会按照 Laravel 的固执己见的编码风格来修复您代码中的代码风格问题。
安装
在近期发布的 Laravel 框架版本中已包含 Pint,通常无需另行安装。然而,对于较旧的应用程序,您可以通过 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,
"braces": false,
"new_with_braces": {
"anonymous_class": false,
"named_class": false
}
}
}
Pint 构建在 PHP-CS-Fixer (opens in a new tab) 之上。因此,您可以使用其任何规则来修复项目中的代码风格问题:PHP-CS-Fixer 配置器 (opens in a new tab)。
排除文件/文件夹
默认情况下,Pint 会检查项目中除 vendor
目录下的所有 .php
文件。如果您希望排除更多文件夹,可以使用 exclude
配置选项:
{
"exclude": [
"my-specific/folder"
]
}
如果您希望排除所有包含给定名称模式的文件,可以使用 notName
配置选项:
{
"notName": [
"*-my-file.php"
]
}
如果您想通过提供文件的精确路径来排除文件,可以使用 notPath
配置选项:
{
"notPath": [
"path/to/excluded-file.php"
]
}
持续集成
GitHub Actions
要使用 Laravel Pint 自动对项目进行代码风格检查,您可以配置 GitHub Actions (opens in a new tab),以便在将新代码推送到 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: 检出代码
uses: actions/checkout@v4
- name: 设置 PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
extensions: json, dom, curl, libxml, mbstring
coverage: none
- name: 安装 Pint
run: composer global require laravel/pint
- name: 运行 Pint
run: pint
- name: 提交已检查风格的文件
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: "Fixes coding style"