nedbase/composer-audit-common-report-formats-plugin

Common report formats for the composer audit command, usable for CI processes

v1.0.0 2024-03-14 09:12 UTC

Requires

• php: ^7.2.5 || ^8.0
• composer-plugin-api: ^2.3
• ext-dom: *
• ext-json: *

Requires (Dev)

• composer/composer: ^2.4
• phpunit/phpunit: ^8.5
• phpunit/phpunit-dom-assertions: ^2.6
• vimeo/psalm: ^4.30

MIT

• Leon Boot

• composer
• ci
• Audit
• reports
• junit
• trivy

README

This package provides several common report formats for the composer audit command, that was introduced in Composer 2.4. The plugin uses the output generated by the composer audit format, augments the data where needed, and outputs it in the requested format.

Currently, JUnit and Trivy formats are supported.

Installation

You can either require the package globally or as a dev dependency for your project.

To make the plugin globally available run the following command:

composer global require nedbase/composer-audit-common-report-formats-plugin 

To add the plugin available for a specific project, you may add it as a dev dependency:

composer require --dev nedbase/composer-audit-common-report-formats-plugin

Usage

To generate a JUnit formatted audit report, run the following command:

composer audit:junit

To generate a Trivy formatted audit report, run the following command:

composer audit:trivy

The same options and arguments that exist on Composer's native audit command are available for the audit:[format] command, except for the --format option, as the report format is implied by the audit:[format] command itself. So to generate a JUnit formatted audit report of regular dependencies only (so no dev dependencies) you may run:

composer audit:junit --no-dev

Technical documentation

For the full documentation, including the technical documentation of the code, see the Documentation.

Developed and maintained in 🇳🇱 by Nedbase.