2022年6月29日,本文最初发表于techvblogs.com,阅读时间3分钟。
长时间的期待终于结束了,Laravel最新的开源CLI应用已经面世了,我们亲自试用了一下,现在向你详细介绍。这就是Laravel Pint。
从readme文件可以看到,“Laravel Pint是一个基于PHP-CS-Fixer构建的零依赖的PHP代码风格修复器,面向极简主义者。”
一读到这里,我就兴奋了,而且非常开心。在现代的PHP中,我们一直在磨练我们的技能,使我们的代码更加严格和更好地测试,并确保我们有一致的代码风格。这一切始于PHP-FIG的成立,他们开始发布PSRs,这些规范使框架拥有自己的特定的代码风格规则。这个软件包也不例外,它会根据预设自动测试和修复你的代码风格。
安装
Laravel Pint需要PHP 8.0+。
你可以使用Composer将Pint安装到你的PHP项目中:
#! /bin/bash
composer require laravel/pint --dev
安装Pint之后,pint二进制文件将在你的项目的vendor/bin
目录中可用:
./vendor/bin/pint
运行Pint
运行Pint时,它将输出已修复的文件列表。使用-v
选项可以查看更详细的更改内容:
#! /bin/bash
./vendor/bin/pint -v
此外,如果你希望Pint检查你的代码是否存在风格错误,而不实际更改文件,可以使用--test
选项:
#! /bin/bash
./vendor/bin/pint --test
配置Pint
在我们全新的Laravel应用程序中,让我们将预设配置为Laravel。创建一个pint.json
文件并添加:
{
"preset": "laravel"
}
此外,如果你希望使用特定目录中的pint.json
,可以使用--config
选项:
#! /bin/bash
pint --config vendor/my-company/coding-style/pint.json
预设
预设定义了一组规则,可以用于修复代码风格问题。默认情况下,Pint使用laravel预设,该预设通过遵循Laravel的有偏见的编码风格来解决问题。
但是,你可以通过传递--preset
选项来使用不同的预设:
#! /bin/bash
pint --preset psr12
如果你愿意,也可以在你的项目的pint.json
文件中设置预设:
{
"preset": "psr12"
}
当前支持的预设有laravel、psr12和Symfony。
规则
规则是Pint将用于修复代码风格问题的样式指南。如上所述,预设是预定义的规则组,应该适用于大多数PHP项目,因此你通常不需要担心它们包含的各个规则。
但是,如果你愿意,可以在你的pint.json
文件中启用或禁用特定规则:
{
"preset": "laravel",
"rules": {
"simplified_null_return": true,
"braces": false,
"new_with_braces": {
"anonymous_class": false,
"named_class": false
}
}
}
Pint是基于PHP-CS-Fixer构建的。因此,你可以使用它的规则来修复项目中的代码风格问题:PHP-CS-Fixer配置器。
更多详情,请访问Github。
评论(0)