Question 1

How to parse ESLint reports with Violations Lib?

Accepted Answer

Use the CHECKSTYLE parser with ESLint configured to output in Checkstyle format (e.g., `--format checkstyle`). The library's builder API can then locate and parse the XML files, converting them to Violation objects.

Question 2

Violations Lib vs SonarQube for code quality reporting?

Accepted Answer

Violations Lib is a parsing library for aggregating reports from multiple tools, ideal for custom pipelines. SonarQube is a full platform with dashboards and historical tracking; choose Violations Lib if you need flexibility, SonarQube for out-of-the-box solutions.

Question 3

Can Violations Lib handle custom report formats?

Accepted Answer

Yes, via the GENERIC parser for simple cases or by implementing a custom parser. The project invites contributions for missing formats through GitHub issues, as noted in the README.

Question 4

How to integrate Violations Lib into a Jenkins pipeline?

Accepted Answer

Use the Jenkins plugins like Violation Comments to GitLab, or call the library directly in a Java-based script. The plugins simplify integration by automatically parsing reports and posting comments to version control systems.

Question 5

What's the difference between Violations Lib and the command-line tool?

Accepted Answer

Violations Lib is the core Java library for programmatic use, while the command-line tool provides a standalone interface for parsing and converting reports without writing Java code, useful for scripting or ad-hoc conversions.

Question 6

Does Violations Lib support SARIF 2.1?

Accepted Answer

It supports SARIF v2.x, as mentioned in the README for tools like Microsoft Visual C#. For exact version compatibility, check the project's documentation or test with your specific SARIF files.

Violations Lib

What is Violations Lib?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions