dustyrio/prettyhp

PrettyHP是一个具有偏见的PHP代码格式化工具

dev-master 2020-08-01 11:43 UTC

This package is auto-updated.

Last update: 2024-08-28 07:01:55 UTC


README

Logo

Build Status Code Climate Latest Stable Version Total Downloads License

PrettyHP是一个具有偏见的PHP代码格式化工具

它将移除所有原始样式并确保所有输出的代码都符合一致的风格。

PrettyHP将尽可能遵守PSR规范。

灵感来源于JavaScript的prettier

但为什么呢?

您的IDE或编辑器可能已经内置了一些基本的格式化功能,但

  • 至少PhpStorm无法在提交到VCS之前自动重新格式化代码;
  • 不同的团队成员可能有不同的编辑器、视图和标准;
  • 至少PhpStorm并没有真正地强制执行样式,它只是做了一些基本的缩进。

为什么不使用现有的PHP代码格式化工具呢?

phpfmt

phpfmt已经被官方关闭,该存储库已被作者删除。

php-cs-fixer

我是一个经验丰富的开发者和Linux用户,但我无法在10+分钟内将其安装并运行。它似乎有些问题。由于工具的详细模式尚未实现,我无法进一步调试它。

安装

$ composer require --dev dusterio/prettyhp

我们建议添加一个pre-commit Git钩子,以便在提交之前将任何修改过的PHP文件格式化

$ cat .git/hooks/pre-commit

git diff --staged --diff-filter=dx --name-only HEAD | grep ".*\.php$" | xargs -I % sh -c 'vendor/bin/prettyhp format %; git add %'

手动使用

PrettyHP适用于PSR 4兼容的文件 - 一个文件应包含一个PHP类。

$ vendor/bin/prettyhp [filename]