matheusab / rector-html-output-formatter

Rector PHP库的HTML输出格式化工具。

维护者

详细信息

github.com/matheusab-soft/rector-html-output-formatter

源代码

问题

安装次数: 7,257

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 3

开放问题: 0

1.1 2024-09-20 20:01 UTC

Requires

Requires (Dev)

MIT f0263d4532049ae5bee97fec0303136668f1c25c

This package is auto-updated.

Last update: 2024-09-20 20:07:14 UTC

README

使用以下命令安装：composer require --dev matheusab/rector-html-output-formatter

使用方法

在您的 rector.php 文件中配置它，其中 exportedFilePathPrefix 参数是导出报告的路径。示例

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->singleton(HtmlOutputFormatter::class, HtmlOutputFormatter::class);
    $rectorConfig->tag(HtmlOutputFormatter::class, OutputFormatterInterface::class);
    $rectorConfig
        ->when(HtmlOutputFormatter::class)
        ->needs('$exportedFilePathPrefix')
        ->give(__DIR__ . '/rector-report');

从v1.1版本开始，也可以使用自定义报告模板：请参阅使用自定义报告模板

生成报告

配置完成后，您可以使用Rector的process命令通过设置--output-format=html来生成报告。

示例

vendor/bin/rector process --dry-run --output-format=html

使用自定义报告模板

在配置RectorConfig时，可以使用自定义报告模板。示例

rector.php:

$rectorConfig
    ->when(HtmlOutputFormatter::class)
    ->needs('$customReportTemplatePath')
    ->give(__DIR__ . '/custom_template.php');

您可以在模板中使用以下变量

示例

生成的报告截图

image image