bartlett/sarif-php-converters

Allows PHP projects to print a static code analysis report in SARIF format

dev-master 2024-07-31 13:59 UTC

Requires

• php: ^7.4 || ^8.0
• composer-runtime-api: ^2.0
• ext-json: *
• ext-pcre: *
• ext-spl: *
• bartlett/sarif-php-sdk: ^2.0

Requires (Dev)

• bamarni/composer-bin-plugin: ^1.8
• php-parallel-lint/php-console-highlighter: ^1.0
• symfony/console: ^6.4 || ^7.0

Suggests

• ext-libxml: If you use the Console Tool and checkstyle input format
• ext-simplexml: If you use the Console Tool and checkstyle input format

MIT

• Laurent Laville

• converter
• sarif

README

SARIF PHP Converters

Introduction

SARIF, the Static Analysis Results Interchange Format, defines a standard format for the output of static analysis tools. It is a powerful and sophisticated format suited to the needs of a wide variety of tools.

There are a lot of PHP project that do Static Code Analysis, but few of them support the SARIF format.

You can consider to be lucky when they provide at least the checkstyle or junit format.

This library may be considered as a producer on sarif report format, for these projects that did not support yet natively.

Features at a glance

• A Console Tool to allow conversion from checkstyle format to sarif, if your application does not support custom reporting class.
• Add sarif output format support to your application, if you accept to load on fly, any custom reporting class.

Comparison by project on output formats

Legend :

• ✅ indicate that support to the format is available
• (✅) indicate that support to the format is optional
• ❌ indicate that support to the format is not yet available

Documentation

All the documentation is available on website, generated from the docs folder.