isabella232 / rewrite-maven-plugin

Eliminate technical debt. At build time.

Eliminate Tech-Debt. At build time.

What is this?

This project provides a Maven plugin that applies Rewrite checking and fixing tasks as build tasks, one of several possible workflows for propagating change across an organization's source code.

Getting started

This README may not have the most up-to-date documentation. For the most up-to-date documentation and reference guides, see:

• Maven Plugin Configuration
• OpenRewrite Quickstart Guide

To configure, add the plugin to your POM:

<?xml version="1.0" encoding="UTF-8"?>
<project>
    ...
    <build>
        <plugins>
            <plugin>
                <groupId>org.openrewrite.maven</groupId>
                <artifactId>rewrite-maven-plugin</artifactId>
                <version><!-- latest version here --></version>
                <configuration>
                    <activeRecipes>
                        <recipe>org.openrewrite.java.format.AutoFormat</recipe>
                    </activeRecipes>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

To get started, try mvn rewrite:help, mvn rewrite:discover, mvn rewrite:dryRun, mvn rewrite:run, among other plugin goals.

See the Maven Plugin Configuration documentation for full configuration and usage options.

Notes for developing and testing this plugin

This plugin uses the Maven Integration Testing Framework Extension for tests.

All tests can be run from the command line using:

./mvnw verify

If you're looking for more information on the output from a test, try checking the target/maven-it/**/*IT/** directory contents after running the tests. It will contain the project state output, including maven logs, etc. Check the Integration Testing Framework Users Guide for information, too. It's good.

Using this plugin against itself

The pom.xml has the a profile for using the rewrite-maven-plugin applied to itself (it's a helpful plugin, why not use it to help develop itself?). This needs to be in it's own profile to prevent errors during deployment.

./mvnw -Pbootstrap rewrite:dryRun

Resource guides

• https://carlosvin.github.io/posts/creating-custom-maven-plugin/en/#_dependency_injection
• https://developer.okta.com/blog/2019/09/23/tutorial-build-a-maven-plugin
• https://medium.com/swlh/step-by-step-guide-to-developing-a-custom-maven-plugin-b6e3a0e09966