vijay-duke / rewrite-checkstyle

Eliminate Checkstyle issues. Automatically.

Eliminate Checkstyle issues. Automatically.

What is this?

This project implements a series of Rewrite recipes and visitors that checks for and auto-remediates common Checkstyle issues. The check and remediation go together, so it does not use Checkstyle for the checking, but rather performs an equivalent check according to the Checkstyle documentation. Each Rewrite Checkstyle rule provides the full set of options for the corresponding Checkstyle check.

This module parses your existing Checkstyle configuration, supporting all the same configuration options that the Checkstyle check supports. It does its own checking, matching exactly the Checkstyle definition of each rule, and where it finds violations, fixes them automatically!

Since all of the rules check for syntactic and not semantic patterns, there is no need to ensure that the ASTs evaluated by Rewrite Checkstyle are fully type-attributed (i.e. there is no need to provide the compile classpath to JavaParser).

The list of currently supported checks is here. Submit an issue to add support for additional checks. Even better, submit a PR!

How to use?

See the full documentation at docs.openrewrite.org.