Rector Converter

Note

Available since version 1.0.0

Requirements

Rector requires PHP version 7.4.0 or greater, with phpstan 2.0 or greater
This SARIF converter requires at least Rector version 2.0

Installation

composer require --dev rector/rector bartlett/sarif-php-converters

Usage

Update your `rector.php` configuration file

Register at least the RectorFormatter service to be able to specify --output-format sarif with rector command.

<?php
use Bartlett\Sarif\Converter\Reporter\RectorFormatter;

use Rector\ChangesReporting\Contract\Output\OutputFormatterInterface;
use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withPaths([
        __DIR__ . '/src',
    ])
    ->withPreparedSets(true)
    ->withRealPathReporting()
    ->withBootstrapFiles([__DIR__ . '/../../vendor/autoload.php']) // loader for Sarif PHP Converters classes
    ->registerService(RectorFormatter::class, null, OutputFormatterInterface::class)
;

Then print the SARIF report

vendor/bin/rector process --dry-run  --output-format sarif --config /path/to/rector.php > .sarif.json

Warning

Be sure to specify withRealPathReporting, otherwise the Console Tool convert command will raise some warnings about file names. Requires at least feature is implemented in a future Rector release.

How to customize your converter

There are many ways to customize render of your converter.

Make the SARIF report output human-readable

By default, all converters use the default \Bartlett\Sarif\Factory\PhpSerializerFactory to return the SARIF JSON representation of your report.

But this serializer factory component, as native PHP [json_encode][json-encode] function, does not use whitespace in returned data to format it.

To make your report human-readable, you have to specify the \JSON_PRETTY_PRINT constant, as encoder option.

Here is the way to do it !

Create your formatter specialized class

<?php

use Bartlett\Sarif\Converter\RectorConverter;
use Bartlett\Sarif\Converter\Reporter\RectorFormatter;

class MySarifFormatter extends RectorFormatter
{
    public function __construct()
    {
        parent::__construct(
            new RectorConverter(
                [
                    'format_output' => true,
                ]
            )
        );
    }
}

Create your own class loader to register custom converter

<?php
require_once dirname(__DIR__, 2) . '/vendor/autoload.php';
require_once __DIR__ . '/MySarifFormatter.php';

Then update your `rector.php` configuration file

<?php
use Bartlett\Sarif\Converter\Reporter\RectorFormatter;

use Rector\ChangesReporting\Contract\Output\OutputFormatterInterface;
use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withPaths([
        __DIR__ . '/src',
    ])
    ->withPreparedSets(true)
    ->withRealPathReporting()
    ->withBootstrapFiles([__DIR__ . '/../../vendor/autoload.php']) // loader for Sarif PHP Converters classes
    ->registerService(MySarifFormatter::class, null, OutputFormatterInterface::class)
;

And finally, print the SARIF report

vendor/bin/rector process --dry-run  --output-format sarif --config /path/to/rector.php --autoload-file /path/to/bootstrap.php > .sarif.json

Learn more

See demo examples/rector/ directory into this repository.

IDE Integration

The SARIF report file [*].sarif.json is automagically recognized and interpreted by PhpStorm (2024).

PHPStorm integration

Web SARIF viewer

With the React based component, you are able to explore a sarif report file previously generated.

For example:

sarif-web-rector