https://github.com/jqassistant-plugin/jqassistant-sarif-report-plugin

SARIF report for publishing jQAssistant analysis results
https://github.com/jqassistant-plugin/jqassistant-sarif-report-plugin

Last synced: 4 months ago
JSON representation

SARIF report for publishing jQAssistant analysis results

• Host: GitHub
• URL: https://github.com/jqassistant-plugin/jqassistant-sarif-report-plugin
• Owner: jqassistant-plugin
• License: gpl-3.0
• Created: 2026-03-24T07:21:37.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2026-03-27T15:58:14.000Z (4 months ago)
• Last Synced: 2026-03-27T23:59:23.748Z (4 months ago)
• Size: 42 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

          
= jQAssistant SARIF Report Plugin

This is the SARIF Report Plugin of https://jqassistant.org[jQAssistant^].

It allows to generate JSON files in the https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html[SARIF format] which can be used to display them e.g. in https://gitlab.com[GitHub] pull requests.

For more information on jQAssistant see https://jqassistant.org[^].

NOTE: Despite linking of source locations is implemented by this plugin the generated links are not valid yet. This requires a https://github.com/jQAssistant/jqassistant/issues/1077[change in jQAssistant] which is scheduled for one of the next releases.

== Setup

The plugin must be declared in the jQAssistant configuration:

[source, yaml]

..jqassistant.yml

----

jqassistant:

  plugins:

    - group-id: org.jqassistant.plugin

      artifact-id: jqassistant-sarif-report-plugin

      version: 1.0.0-SNAPSHOT

----

During execution of the `analyze` task or goal a file `jqassistant-sarif-report.json` is created in the report directory.