How to parse ESLint reports with Violations Lib?

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.

Violations Lib vs SonarQube for code quality reporting?

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.

Can Violations Lib handle custom report formats?

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.

How to integrate Violations Lib into a Jenkins pipeline?

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.

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

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.

Does Violations Lib support SARIF 2.1?

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 — Java Static Analysis Parser

What is Violations Lib?

Violations Lib is a Java library that parses output files from static code analysis tools into a unified data model. It solves the problem of dealing with dozens of different report formats by providing a single API to read violations from tools like Checkstyle, PMD, ESLint, and many others. This enables consistent processing, reporting, and integration of code quality feedback across projects.

Target Audience

Java developers and DevOps engineers building CI/CD pipelines, code quality dashboards, or tools that need to aggregate results from multiple static analysis tools.

Value Proposition

Developers choose Violations Lib because it offers the broadest support for static analysis report formats in a single Java library, with a clean API and the ability to export to standard formats like SARIF and CodeClimate for platform integration.

Java library for parsing report files from static code analysis.

Use Cases

Best For

Aggregating code quality reports from multiple linters in a CI pipeline
Converting static analysis output to SARIF for GitHub code scanning
Building custom code quality dashboards that consume diverse tool outputs
Integrating lint results into GitLab via CodeClimate format
Creating plugins for build tools (Gradle, Maven) that process analysis reports
Developing tools that need to parse and process violations from many different analyzers

Not Ideal For

Projects relying exclusively on a single static analysis tool with no need for report aggregation
Real-time code analysis or IDE integration, as it's designed for batch processing of report files
Non-Java ecosystems where adding a Java dependency is impractical, such as pure Python or Node.js CI/CD pipelines

Pros & Cons

Pros

Extensive Tool Coverage

Supports parsing reports from 79+ static analysis tools across languages like Java, Python, and JavaScript, with 52 dedicated parsers listed in the detailed table.

Unified Data Model

Converts diverse report formats into a consistent Violation object, simplifying post-processing and integration into CI/CD systems, as highlighted in the philosophy section.

Fluent Builder API

Offers an easy-to-use Java API with a builder pattern for locating and parsing files, demonstrated in the usage example with methods like `withPattern()` and `findAll()`.

Export to Standard Formats

Can export violations to CodeClimate and SARIF formats, enabling integration with platforms like GitLab and GitHub, as mentioned in the export capabilities section.

Cons

Java Dependency Overhead

Requires a Java runtime and build tool integration, making it cumbersome for non-Java projects or lightweight scripts that prefer native solutions.

Parser-Specific Configuration

Many parsers need source tools to be run with specific flags (e.g., `cppcheck --xml`), adding setup complexity and potential for misconfiguration.

Version Fragmentation

Different library versions require different Java versions (8 vs 11), complicating upgrades and cross-version compatibility in mixed environments.

Frequently Asked Questions

What is Violations Lib?

Target Audience

Java developers and DevOps engineers building CI/CD pipelines, code quality dashboards, or tools that need to aggregate results from multiple static analysis tools.

Value Proposition

Use Cases

Best For

Aggregating code quality reports from multiple linters in a CI pipeline
Converting static analysis output to SARIF for GitHub code scanning
Building custom code quality dashboards that consume diverse tool outputs
Integrating lint results into GitLab via CodeClimate format
Creating plugins for build tools (Gradle, Maven) that process analysis reports
Developing tools that need to parse and process violations from many different analyzers

Not Ideal For

Projects relying exclusively on a single static analysis tool with no need for report aggregation
Real-time code analysis or IDE integration, as it's designed for batch processing of report files
Non-Java ecosystems where adding a Java dependency is impractical, such as pure Python or Node.js CI/CD pipelines

Pros & Cons

Pros

Extensive Tool Coverage

Supports parsing reports from 79+ static analysis tools across languages like Java, Python, and JavaScript, with 52 dedicated parsers listed in the detailed table.

Unified Data Model

Converts diverse report formats into a consistent Violation object, simplifying post-processing and integration into CI/CD systems, as highlighted in the philosophy section.

Fluent Builder API

Offers an easy-to-use Java API with a builder pattern for locating and parsing files, demonstrated in the usage example with methods like `withPattern()` and `findAll()`.

Export to Standard Formats

Can export violations to CodeClimate and SARIF formats, enabling integration with platforms like GitLab and GitHub, as mentioned in the export capabilities section.

Cons

Java Dependency Overhead

Requires a Java runtime and build tool integration, making it cumbersome for non-Java projects or lightweight scripts that prefer native solutions.

Parser-Specific Configuration

Many parsers need source tools to be run with specific flags (e.g., `cppcheck --xml`), adding setup complexity and potential for misconfiguration.

Version Fragmentation

Different library versions require different Java versions (8 vs 11), complicating upgrades and cross-version compatibility in mixed environments.

Frequently Asked Questions

Violations Lib

What is Violations Lib?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

Violations Lib

What is Violations Lib?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?