laravel Pint是官方提供的代码风格修复工具,基于php-CS-Fixer,安装后可通过./vendor/bin/pint运行检查与修复,支持自动格式化、目录指定扫描及自定义配置文件pint.json,推荐集成到git提交前或CI流程中以保障代码一致性。
Laravel Pint 是 Laravel 官方提供的轻量级代码风格检查与修复工具,基于 PHP-CS-Fixer 构建,开箱即用,无需复杂配置。它能自动修复代码中的格式问题,统一团队编码风格,尤其适合 Laravel 项目。
安装与启用 Pint
Pint 可通过 composer 安装到项目中,推荐作为开发依赖引入:
- 安装命令:运行
composer require --dev laravel/pint
- 安装完成后,Pint 会自动生成可执行文件
vendor/bin/pint
- 你也可以全局安装:使用
composer global require laravel/pint
,之后可直接运行pint
运行 Pint 进行代码修复
安装后即可对项目代码进行风格检查和自动修复:
- 检查并显示问题:执行
./vendor/bin/pint
,Pint 会扫描项目文件并输出格式错误 - 自动修复代码:再次运行相同命令,Pint 会尝试自动修正所有可修复的问题
- 指定目录扫描:如只检查 app 目录,使用
./vendor/bin/pint check app/
或./vendor/bin/pint --test app/
(仅检测不修改)
自定义 Pint 配置(可选)
Pint 大部分情况下无需配置,但你可以在项目根目录创建 pint.json
文件来自定义规则:
- 运行
./vendor/bin/pint --test
查看当前规则下的问题 - 创建
pint.json
文件示例内容:
{ "preset": "laravel", "rules": { "array_syntax": {"syntax": "short"}, "binary_operator_spaces": {"default": "single_space"} }, "paths": [ "app/", "routes/", "database/" ] }
其中 preset 可选值包括:vendor/bin/pint
0、vendor/bin/pint
1、vendor/bin/pint
2 等
集成到开发流程
为了确保代码风格一致,建议将 Pint 集成到日常开发或 CI 流程中:
- Git 提交前检查:配合 Husky + Simple-Precommit 使用,在 commit 时自动运行 pint
- CI 中验证:在 github Actions 或其他 CI 工具中添加步骤:
vendor/bin/pint
3,防止不符合规范的代码合入 - ide 集成:在 phpstorm、VS Code 等编辑器中配置外部工具,一键运行 pint 格式化当前文件
基本上就这些。Laravel Pint 使用简单,功能明确,是保持 Laravel 项目代码整洁的好帮手。不复杂但容易忽略。
以上就是laravel Pint代码风格自动修复工具如何使用_Laravel Pint自动修复代码风格教程的详细内容,更多请关注php中文网其它相关文章!