Laravel Pint
发布日期:作者: 史蒂夫·麦克杜格尔
期待已久的炒作终于结束,Laravel 最新的开源 CLI 应用已发布,我们已经上手体验,并为您带来相关介绍。介绍 Laravel Pint...
从自述文件中可以看出,“Laravel Pint 是一款零依赖的 PHP 代码风格修复器,专为极简主义者设计 - 基于 PHP-CS-Fixer 构建。”
当我读到这句话时,我感到很兴奋,而且是非常兴奋。在现代 PHP 中,我们一直在努力完善我们的技术,使我们的代码更加严格、测试更加完善,并确保我们拥有统一的代码风格。这一切都始于 PHP-FIG 的成立,他们开始发布 PSR,并且随着框架发布了自己的特定风格规则,这一趋势越来越强劲。这个包也不例外,它将根据预设自动测试和修复您的代码风格。
要开始使用这个包,请使用 Composer 安装它
composer require laravel/pint --dev
安装完成后,它将立即运行,无需任何配置。所以你可以运行
./vendor/bin/pint
无需任何配置、设置或思考或努力 - 我的项目会立即针对 PSR-12 风格进行评估并自动修复。太神奇了。保持代码整洁和一致有时需要付出努力或思考如何进行设置 - 需要实现哪些规则。或者使用 PHP CS Fixer,您需要创建一个配置文件,然后创建一个查找器来将规则添加到 PHP 文件中的数组中。事情很快就会变得很混乱,对吧?
不再需要。如果您在项目的根目录中创建一个 pint.json 文件,它将简单地加载该文件并读取配置 - 否则,请坚持使用默认值。配置全部使用 JSON 完成,使其更易于使用且更易读。
让我们快速了解一下如何使用预设设置新的 pint 配置。但让我们看看如何使用全新的 Laravel 项目来做,所以创建一个新项目
laravel new pint-demo
在您的终端中打开这个新项目并安装 pint
composer require laravel/pint --dev
使用我们全新的 Laravel 应用程序,让我们为 Laravel 配置一个预设。创建一个 pint.json 文件并添加
{ "preset": "laravel"}
现在运行 pint
./vendor/bin/pint
您应该会看到类似于以下的输出
我们起飞了 🚀
所以现在让我们将我们的预设更改为 PSR-12 并检查输出
{ "preset": "psr12"}
重新运行 pint 并让我们看看输出
./vendor/bin/pint
您应该会看到以下输出
让我们仔细检查一下。它实现了像 single_trait_insert_per_statement
、braces
和 new_with_braces
这样的规则。如果我们要稍微自定义一下呢?嗯,我们可以很容易地打开和关闭规则。让我们在 pint.json 文件中关闭 braces
{ "preset": "psr12", "rules": { "braces": false }}
就是这样!自定义代码风格设置非常简单。不再需要使用混乱的 PHP 和数组来配置您的编码风格。所以让我们重新运行 pint,但这次我们想进行一次干运行,看看会发生哪些改变
./vendor/bin/pint —test
很棒吧?漂亮的输出,进行干运行,查看什么会失败以及原因!那么,如果我们想要更多信息会怎样?我已经修复了上面的文件并返回到用户迁移 - 并撤销了这些更改,以便我们可以测试它。让我们再进行一次干运行,但这次我们想使用 -v
标志请求详细输出
我们得到了非常棒的输出,就像使用 GitHub 时一样,显示了将要进行的更改。所以我们可以看到代码风格问题、它在哪里被捕获以及如果我们修复它会发生什么变化 - 所有这一切都来自一个非常简单的命令。
我不知道您怎么想,但我认为这对于我所有即将到来的项目、包以及我参与的任何其他工作来说都是必须安装的。