mallardduck / prettier-php-runner
使用 Prettier 在 PHP 中重新格式化代码
1.0.0
2022-02-21 22:10 UTC
Requires
- php: ^8.0
- symfony/process: ^6.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^v3.0
- league/flysystem: ^3.0
- pestphp/pest: ^1.8
- phpunit/phpunit: ^9.5
- spatie/pest-plugin-snapshots: ^1.1
README
Prettier 是一个基于 NodeJS 的有偏见的代码格式化工具,支持多种语言。现在你可以在 PHP 项目中也能使用 Prettier 的强大功能!
\MallardDuck\PrettierPhp\PrettierHtml::format( html: '<html><body><div><h1>Heading</h1></div></body></html>' );
安装
你可以通过 composer 安装这个包
composer require mallardduck/prettier-php-runner
在你的项目中,你应该已经安装了 JavaScript 包 prettier
。你可以通过 npm... 安装它。
npm install prettier
... 或者 Yarn。
yarn add prettier
确保你已经安装了 Node 10 或更高版本。
使用方法
以下是一个示例,我们将突出显示一些 PHP 代码。
use Spatie\ShikiPhp\Prettier; PrettierHtml::format( '<html><body><div><h1>Heading</h1></div></body></html>' );
输出是这个 HTML 片段,它将在浏览器中完美渲染
<html> <body> <div><h1>Heading</h1></div> </body> </html>
使用 Node 版本管理器
在底层,这个包将运行一个 node 命令来美化你的 HTML 输入。
如果你在开发过程中使用 NVM,那么这个包可能找不到你的 node 版本,因为它在 /usr/local/bin
和 /opt/homebrew/bin
中寻找 node 可执行文件。如果你是这样,那么你应该在 NVM 文件夹中的 node 发布版之间创建一个符号链接。
这样的命令可能看起来像这样
sudo ln -s /home/some-user/.nvm/versions/node/v17.3.1/bin/node /usr/local/bin/node
创建这个符号链接将允许包找到你的 NPM 可执行文件。请注意,如果你更改了 NPM 版本,你必须相应地更新你的符号链接。
测试
你可以使用这个命令运行所有测试
composer test
变更日志
请参阅 CHANGELOG 了解最近更改的详细信息。
贡献
请参阅 CONTRIBUTING 了解详细信息。
许可证
MIT 许可证 (MIT)。请参阅 许可证文件 了解更多信息。