ayushkr19 / rewrite-recipe-starter Goto Github PK

This repository serves as a template for building your own recipe JARs and publishing them to a repository where they can be applied on app.moderne.io against all the public OSS code that is included there.

We've provided a sample recipe (NoGuavaListsNewArray) and a sample test class. Both of these exist as placeholders, and they should be replaced by whatever recipe you are interested in writing.

To begin, fork this repository and customize it by:

1. Changing the root project name in settings.gradle.kts.
2. Changing the group in build.gradle.kts.
3. Changing the package structure from com.yourorg to whatever you want.

Familiarize yourself with the OpenRewrite documentation, in particular the concepts & explanations op topics like the lossless semantic trees, recipes and visitors.

You might be interested to watch some of the videos available on OpenRewrite and Moderne.

Once you want to dive into the code there is a comprehensive getting started guide available in the OpenRewrite docs that provides more details than the below README.

• META-INF/rewrite/stringutils.yml - A declarative YAML recipe that replaces usages of org.springframework.util.StringUtils with org.apache.commons.lang3.StringUtils.
  • UseApacheStringUtilsTest - A test class for the com.yourorg.UseApacheStringUtils recipe.
• NoGuavaListsNewArrayList.java - An imperative Java recipe that replaces usages of com.google.common.collect.Lists with new ArrayList<>().
  • NoGuavaListsNewArrayListTest.java - A test class for the NoGuavaListsNewArrayList recipe.
• SimplifyTernary - An Refaster style recipe that simplifies ternary expressions.
  • SimplifyTernaryTest - A test class for the SimplifyTernary recipe.
• AssertEqualsToAssertThat - An imperative Java recipe that replaces JUnit's assertEquals with AssertJ's assertThat, to show how to handle classpath dependencies.
  • AssertEqualsToAssertThatTest - A test class for the AssertEqualsToAssertThat recipe.
• AppendToReleaseNotes - A ScanningRecipe that appends a message to the release notes of a project.
  • AppendToReleaseNotesTest - A test class for the AppendToReleaseNotes recipe.
• ClassHierarchy - A recipe that demonstrates how to produce a data table on the class hierarchy of a project.
  • ClassHierarchyTest - A test class for the ClassHierarchy recipe.
• UpdateConcoursePipeline - A recipe that demonstrates how to update a Concourse pipeline, as an example of operating on Yaml files.
  • UpdateConcoursePipelineTest - A test class for the UpdateConcoursePipeline recipe.

Before you publish your recipe module to an artifact repository, you may want to try it out locally. To do this on the command line, run:

./gradlew publishToMavenLocal
# or ./gradlew pTML

This will publish to your local maven repository, typically under ~/.m2/repository.

Replace the groupId, artifactId, recipe name, and version in the below snippets with the ones that correspond to your recipe.

In the pom.xml of a different project you wish to test your recipe out in, make your recipe module a plugin dependency of rewrite-maven-plugin:

<project>
    <build>
        <plugins>
            <plugin>
                <groupId>org.openrewrite.maven</groupId>
                <artifactId>rewrite-maven-plugin</artifactId>
                <version>RELEASE</version>
                <configuration>
                    <activeRecipes>
                        <recipe>com.yourorg.NoGuavaListsNewArrayList</recipe>
                    </activeRecipes>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>com.yourorg</groupId>
                        <artifactId>rewrite-recipe-starter</artifactId>
                        <version>0.1.0-SNAPSHOT</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>
</project>

Unlike Maven, Gradle must be explicitly configured to resolve dependencies from Maven local. The root project of your Gradle build, make your recipe module a dependency of the rewrite configuration:

plugins {
    id("java")
    id("org.openrewrite.rewrite") version("latest.release")
}

repositories {
    mavenLocal()
    mavenCentral()
}

dependencies {
    rewrite("com.yourorg:rewrite-recipe-starter:latest.integration")
}

rewrite {
    activeRecipe("com.yourorg.NoGuavaListsNewArrayList")
}

Now you can run mvn rewrite:run or gradlew rewriteRun to run your recipe.

This project is configured to publish to Moderne's open artifact repository (via the publishing task at the bottom of the build.gradle.kts file). If you want to publish elsewhere, you'll want to update that task. app.moderne.io can draw recipes from the provided repository, as well as from Maven Central.

Note: Running the publish task will not update app.moderne.io, as only Moderne employees can add new recipes. If you want to add your recipe to app.moderne.io, please ask the team in Slack or in Discord.

These other docs might also be useful for you depending on where you want to publish the recipe:

• Sonatype's instructions for publishing to Maven Central
• Gradle's instructions on the Gradle Publishing Plugin.

The .github directory contains a Github action that will push a snapshot on every successful build.

Run the release action to publish a release version of a recipe.

To build a snapshot, run ./gradlew snapshot publish to build a snapshot and publish it to Moderne's open artifact repository for inclusion at app.moderne.io.

To build a release, run ./gradlew final publish to tag a release and publish it to Moderne's open artifact repository for inclusion at app.moderne.io.

We maintain a collection of best practices for writing OpenRewrite recipes. You can apply these recommendations to your recipes by running the following command:

./gradlew rewriteRun -Drewrite.activeRecipe=org.openrewrite.recipes.OpenRewriteBestPractices