index.adoc

Spring Rewrite Commons

Table of Contents

• Overview
• Using Spring Rewrite Commons
• Examples
• Limitations

Overview

Spring Rewrite Commons provides abstractions and parsers for OpenRewrite.

OpenRewrite is a code refactoring, remediation, and modernization automation tool providing a rich catalog of recipes for task like automated code transformations.

These are the main components offered by Spring Rewrite Commons:

• RewritePlugin - Helper to execute OpenRewrite’s Gradle or Maven plugin through Java

• RewriteProjectParser - Parse a project to an OpenRewrite LST outside a build tool plugin.

• ProjectResourceSet - Encapsulates the LST to run OpenRewrite recipes sequentially.

• RewriteRecipeDiscovery - Discover recipes on the classpath.

• ProjectResourceSetSerializer - Serialize the current state of the ProjectResourceSet to the filesystem.

• Some helpers for testíng also exist

Using Spring Rewrite Commons

partials/snapshots-repository.adoc

Then the dependency can be retrieved.

partials/dependency-code.adoc

Examples

Some working examples exist to demo what can be built using Spring Rewrite Commons.

• Atomically upgrade a Spring Boot application

• Iteratively upgrade a Spring Boot application using PRs

• Find applicable recipes by doing a dry-run

All examples can be found here.

Limitations

The project has currently some limitations.

1. JDK 17 is a requirement

2. Kotlin is not supported.

3. Styles are not supported

4. Migrating projects for Maven plugins might fail