400 0867 457

NEWS/新闻

分享你我感悟

您当前位置> 主页 > 新闻 > 技术开发

Laravel Pint怎么格式化代码_使用Laravel Pint实现PHP代码风格自动化

发表时间:2025-11-30 00:00:00

文章作者:裘德小鎮的故事

浏览次数:

Laravel Pint 是 Laravel 官方推出的轻量级 PHP 代码样式修复工具,基于 PHP-CS-Fixer 构建但更简洁,开箱即用,默认提供 laravel、psr12、symfony 等预设规则,支持通过 pint.json 自定义规则和排除目录,并可集成到 Git 提交流程和 CI/CD 中,确保团队代码风格统一,无需复杂配置,提升协作效率。

想让PHP代码风格自动统一,Laravel Pint 是一个轻量又高效的工具。它不需要复杂配置,开箱即用,特别适合 Laravel 项目或希望快速实现代码规范化的团队。

什么是 Laravel Pint?

Laravel Pint 是 Laravel 官方推出的 PHP 代码样式修复工具,基于 PHP-CS-Fixer 构建,但更轻便,专为 Laravel 项目优化。它能自动检测并修正代码中的格式问题,比如缩进、空格、括号位置、use 语句顺序等。

与需要手动配置规则的工具不同,Pint 提供了默认规则集,大多数情况下无需额外设置即可直接使用。

安装 Laravel Pint

你可以通过 Composer 在项目中全局或局部安装 Pint:

composer require laravel/pint --dev

安装完成后,会在 vendor/bin 目录下生成 pint 可执行文件。

运行代码格式化

在项目根目录执行以下命令即可格式化所有 PHP 文件:

./vendor/bin/pint

如果你想先查看哪些文件会被修改,可以加上 --test 参数预览:

./vendor/bin/pint --test

这个命令不会修改文件,只输出格式不一致的地方,方便你在提交前检查。

自定义代码风格规则(可选)

虽然 Pint 默认规则适用于大多数 Laravel 项目,你也可以通过根目录下的 pint.json 文件自定义规则。

例如,创建 pint.json 文件并指定 PSR-12 标准:

{ "preset": "psr12" }

支持的 preset 包括:

  • psr12:PSR-12 编码规范
  • laravel:Laravel 默认风格(默认值)
  • symfony:Symfony 项目风格

你还可以启用特定规则或排除某些文件:

{ "preset": "laravel", "rules": { "array_syntax": {"syntax": "short"} }, "exclude": [ "database", "storage", "vendor" ] }

集成到开发流程

为了确保团队代码风格一致,建议将 Pint 集成到 Git 提交流程中。可以通过 Git Hookspre-commit 工具实现。

使用 spatie/php-git-hookslefthand/php-pre-commit-hook 等工具,在 commit 前自动运行 pint:

"scripts": { "lint": "pint" }

然后在 CI/CD 流程中加入 lint 检查,防止不符合规范的代码被合并。

基本上就这些。Laravel Pint 的优势在于简单、快速、无需折腾配置,适合追求高效协作的团队。用它来统一代码风格,省时又省心。

相关案例查看更多