OpenRewrite

https://docs.openrewrite.org/
Admin
OpenRewrite is an open-source automated refactoring ecosystem for source code, enabling developers...
Tokens:2,817,102
Snippets:29,468
Trust Score:6.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example configuration files

Source: https://docs.openrewrite.org/recipes/java/spring/deletespringproperty

Examples of configuration files before the property deletion.

```text
project  
```

```text
server.servlet-path=/tmp/my-server-path  
```

```text
server:  
  servlet-path: /tmp/my-server-path  
```

--------------------------------

### Install MigrateToDropwizard5 recipe

Source: https://docs.openrewrite.org/recipes/java/dropwizard/migratetodropwizard5

Install the recipe jar if it is not available locally.

```shell
mod config recipes jar install io.moderne.recipe:rewrite-dropwizard:0.5.5
```

--------------------------------

### Example build.gradle and settings.gradle content

Source: https://docs.openrewrite.org/recipes/gradle/search/effectivegradlepluginrepositories

Initial state of build and settings files for the recipe example.

```gradle
plugins {  
    id 'java'  
}  

```

```gradle
rootProject.name = 'my-project'  

```

--------------------------------

### Unchanged build.gradle example

Source: https://docs.openrewrite.org/recipes/gradle/search/findrepositoryorder

Example of a build.gradle file structure before applying the recipe.

```gradle
plugins {  
    id 'java'  
}  
  
repositories {  
    maven { url 'https://repo.spring.io/milestone' }  
}  
```

--------------------------------

### Example Maven Project Configuration

Source: https://docs.openrewrite.org/recipes/hibernate/migratetohibernate71-moderne-edition

Example of a Maven project configuration file before applying migration changes.

```xml
<project>  

    <modelVersion>4.0.0</modelVersion>  

    <groupId>com.example</groupId>  

    <artifactId>demo</artifactId>  

    <version>0.0.1-SNAPSHOT</version>  

    <dependencies>  

        <dependency>  

            <groupId>io.hypersistence</groupId>  

            <artifactId>hypersistence-utils-hibernate-70</artifactId>  

            <version>3.15.0</version>  

        </dependency>  

    </dependencies>  

</project>  


```

```xml
<project>  

    <modelVersion>4.0.0</modelVersion>  

    <groupId>com.example</groupId>  

    <artifactId>demo</artifactId>  

    <version>0.0.1-SNAPSHOT</version>  

    <dependencies>  

        <dependency>  

            <groupId>io.hypersistence</groupId>  

            <artifactId>hypersistence-utils-hibernate-70</artifactId>  

            <version>3.15.0</version>  

        </dependency>  

    </dependencies>  

</project>  


```

--------------------------------

### Install Recipe JAR

Source: https://docs.openrewrite.org/recipes/cryptography/findhardcodedalgorithmchoice

Install the recipe JAR if it is not available locally.

```shell
mod config recipes jar install io.moderne.recipe:rewrite-cryptography:0.14.9
```

--------------------------------

### Install project dependencies

Source: https://docs.openrewrite.org/authoring-recipes/javascript-recipe-development-environment

Install the core OpenRewrite framework, mutative, and necessary development tools.

```bash
# Core OpenRewrite framework - should be compatible with your Moderne CLI version
npm install @openrewrite/rewrite

# Mutative is required for modifying LSTs immutably
npm install mutative

# Development dependencies for testing and building
npm install --save-dev typescript jest @jest/globals ts-jest rimraf
```

--------------------------------

### TOML Example Before and After

Source: https://docs.openrewrite.org/recipes/toml/deletekey

Shows the state of a TOML file before and after applying the DeleteKey recipe.

```toml
name = "my-project"  
description = "A sample project"  
version = "1.0.0"  
```

```toml
name = "my-project"  
version = "1.0.0"  
```

```diff
@@ -2,1 +2,0 @@  
name = "my-project"  
-description = "A sample project"  
version = "1.0.0"  
```

--------------------------------

### Install ChangeTapestryPackages recipe jar

Source: https://docs.openrewrite.org/recipes/tapestry/changetapestrypackages

Installs the recipe jar if it is not already available locally.

```shell
mod config recipes jar install io.moderne.recipe:rewrite-tapestry:0.4.3
```

--------------------------------

### YAML Before and After Example

Source: https://docs.openrewrite.org/recipes/yaml/search/findkey

Demonstrates the effect of the FindKey recipe on a YAML file when searching for '$.metadata.name'.

```yaml
    apiVersion: v1  
    metadata:  
      name: monitoring-tools  
      namespace: monitoring-tools  
```

```yaml
    apiVersion: v1  
    metadata:  
      ~~>name: monitoring-tools  
      namespace: monitoring-tools  
```

--------------------------------

### AtomicPrimitiveEqualsUsesGet Refactoring Example

Source: https://docs.openrewrite.org/recipes/staticanalysis/atomicprimitiveequalsusesget

Demonstrates the transformation of equals() calls to get() comparisons for atomic primitive types.

```java
import java.util.concurrent.atomic.AtomicInteger;  
import java.util.concurrent.atomic.AtomicLong;  
import java.util.concurrent.atomic.AtomicBoolean;  
  
class A {  
    boolean areEqual(AtomicInteger i1, AtomicInteger i2) {  
        return i1.equals(i2);  
    }  
    boolean areEqual(AtomicLong l1, AtomicLong l2) {  
        return l1.equals(l2);  
    }  
    boolean areEqual(AtomicBoolean b1, AtomicBoolean b2) {  
        return b1.equals(b2);  
    }  
}  
```

```java
import java.util.concurrent.atomic.AtomicInteger;  
import java.util.concurrent.atomic.AtomicLong;  
import java.util.concurrent.atomic.AtomicBoolean;  
  
class A {  
    boolean areEqual(AtomicInteger i1, AtomicInteger i2) {  
        return i1.get() == i2.get();  
    }  
    boolean areEqual(AtomicLong l1, AtomicLong l2) {  
        return l1.get() == l2.get();  
    }  
    boolean areEqual(AtomicBoolean b1, AtomicBoolean b2) {  
        return b1.get() == b2.get();  
    }  
}  
```

```diff
@@ -7,1 +7,1 @@  
class A {  
    boolean areEqual(AtomicInteger i1, AtomicInteger i2) {  
-       return i1.equals(i2);  
+       return i1.get() == i2.get();  
    }  
@@ -10,1 +10,1 @@  
    }  
    boolean areEqual(AtomicLong l1, AtomicLong l2) {  
-       return l1.equals(l2);  
+       return l1.get() == l2.get();  
    }  
@@ -13,1 +13,1 @@  
    }  
    boolean areEqual(AtomicBoolean b1, AtomicBoolean b2) {  
-       return b1.equals(b2);  
+       return b1.get() == b2.get();  
    }  
```

--------------------------------

### Run and Install FindHardcodedPrivateIPAddresses Recipe

Source: https://docs.openrewrite.org/recipes/text/findhardcodedprivateipaddresses

Commands to execute the recipe using the Moderne CLI or install the required JAR if not available locally.

```shell
mod run . --recipe FindHardcodedPrivateIPAddresses
```

```shell
mod config recipes jar install org.openrewrite.recipe:rewrite-java-security:3.35.2
```

--------------------------------

### Clone and install dependencies

Source: https://docs.openrewrite.org/authoring-recipes/javascript-recipe-development-environment

Commands to initialize a new recipe project from the starter template.

```bash
git clone <your-repository-url>
cd your-recipe-project
npm install
```

--------------------------------

### FindApiCalls usage example

Source: https://docs.openrewrite.org/recipes/java/spring/search/findapicalls

Shows the transformation applied to RestTemplate calls, adding markers for GET and POST requests.

```java
import org.springframework.web.client.RestTemplate;  
class Test {  
    RestTemplate restTemplate;  
    void test() {  
        restTemplate.getForObject(base() + "/getThing", String.class);  
        restTemplate.postForEntity(base() + "/postThing", null, String.class);  
    }  
  
    String base() {  
        return "https://base";  
    }  
}  
```

```java
import org.springframework.web.client.RestTemplate;  
class Test {  
    RestTemplate restTemplate;  
    void test() {  
        /*~~(GET base() + "/getThing")~~>*/restTemplate.getForObject(base() + "/getThing", String.class);  
        /*~~(POST base() + "/postThing")~~>*/restTemplate.postForEntity(base() + "/postThing", null, String.class);  
    }  
  
    String base() {  
        return "https://base";  
    }  
}  
```

--------------------------------

### Run and Install FindHardcodedLoopbackAddresses Recipe

Source: https://docs.openrewrite.org/recipes/text/findhardcodedloopbackaddresses

Commands to execute the recipe using the Moderne CLI or install the required recipe JAR if not available locally.

```shell
mod run . --recipe FindHardcodedLoopbackAddresses
```

```shell
mod config recipes jar install org.openrewrite.recipe:rewrite-java-security:3.35.2
```

--------------------------------

### Project Configuration Example

Source: https://docs.openrewrite.org/recipes/quarkus/spring/addspringcompatibilityextensions

Simple project configuration placeholder.

```text
project  
```

--------------------------------

### Configure OpenRewrite plugin and activate a recipe

Source: https://docs.openrewrite.org/reference/gradle-plugin-configuration

Full example showing plugin application, repository setup, dependency declaration, and recipe activation.

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

repositories {
    mavenCentral()
}

dependencies {
    testImplementation("junit:junit:4.13")
    rewrite(platform("org.openrewrite.recipe:rewrite-recipe-bom:latest.release"))
    rewrite("org.openrewrite.recipe:rewrite-testing-frameworks")
}

rewrite {
    activeRecipe("org.openrewrite.java.testing.junit5.JUnit5BestPractices")
}
```

--------------------------------

### Example XML file content

Source: https://docs.openrewrite.org/recipes/xml/search/doesnotusenamespaceuri

An example of an XML file structure that might be targeted by the search.

```xml
<!--~~>--><beans xmlns="http://www.springframework.org/schema/beans"  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
    xsi:schemaLocation="  
        http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd  
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">  
  
    <jaxws:client name="{http://cxf.apache.org/hello_world_soap_http}SoapPort" createdFromAPI="true" xmlns:jaxws="http://cxf.apache.org/jaxws">  
        <jaxws:conduitSelector>  
            <bean class="org.apache.cxf.endpoint.DeferredConduitSelector"/>  
        </jaxws:conduitSelector>  
    </jaxws:client>  
</beans>
```

--------------------------------

### Install DependencyVulnerabilityCheck Recipe

Source: https://docs.openrewrite.org/recipes/java/dependencies/dependencyvulnerabilitycheck

Installs the recipe jar if it is not available locally.

```shell
mod config recipes jar install org.openrewrite.recipe:rewrite-java-security:3.35.2
```

--------------------------------

### Example usage of KeyStore with JKS

Source: https://docs.openrewrite.org/recipes/java/migrate/changedefaultkeystore

Demonstrates initializing a KeyStore instance specifically with the 'jks' type.

```java
import java.io.FileInputStream;  
import java.io.IOException;  
import java.security.Key;  
import java.security.KeyStore;  
  
class Foo {  
 	void bar() {  
 		try{  
 			KeyStore keystore = KeyStore.getInstance("jks");  
 			char[] password = "your_keystore_password".toCharArray();  
 			FileInputStream keystoreFile = new FileInputStream("path_to_your_keystore_file.jks");  
 			keystore.load(keystoreFile, password);  
 		}  
 		catch (Exception e) {  
 			e.printStackTrace();  
 		}  
 	}  
}  
```

--------------------------------

### Example build.gradle configuration

Source: https://docs.openrewrite.org/recipes/gradle/plugins/removebuildplugin

Initial state of the build.gradle file before the plugin is removed.

```gradle
plugins {  
    id "com.jfrog.bintray" version "1.0"  
}  

```

--------------------------------

### Install MigrateCascadeTypes recipe

Source: https://docs.openrewrite.org/recipes/hibernate/update66/migratecascadetypes

Install the recipe jar if it is not available locally.

```shell
mod config recipes jar install io.moderne.recipe:rewrite-hibernate:0.26.2
```

--------------------------------

### Example YAML Document

Source: https://docs.openrewrite.org/reference/jsonpath-and-jsonpathmatcher-reference

Sample YAML content before and after applying a JsonPath-based transformation.

```yaml
---
subjects:
  - kind: User
    name: some-user
  - kind: ServiceAccount
    name: monitoring-tools
```

```yaml
---
subjects:
  - kind: User
    name: some-user
  - kind: Deployment
    name: monitoring-tools
```

--------------------------------

### Install the ApacheMavenDevCenter recipe

Source: https://docs.openrewrite.org/recipes/devcenter/apachemavendevcenter

Install the recipe JAR if it is not available locally.

```shell
mod config recipes jar install io.moderne.recipe:rewrite-devcenter:1.28.1  
```

--------------------------------

### Example Gradle Build File

Source: https://docs.openrewrite.org/recipes/gradle/addjunitplatformlauncher

Initial state of the build.gradle file before the recipe is applied.

```gradle
plugins {  
    id "java-library"  
}  
  
repositories {  
    mavenCentral()  
}
```

--------------------------------

### Example pom.xml configuration

Source: https://docs.openrewrite.org/recipes/java/spring/cloud2022/addloggingpatternlevelforsleuth

Represents the project structure before the recipe is applied.

```xml
    <project>  
    <modelVersion>4.0.0</modelVersion>  
    <groupId>com.example</groupId>  
    <artifactId>explicit-deps-app</artifactId>  
    <version>0.0.1-SNAPSHOT</version>  
    <dependencies>  
        <dependency>  
            <groupId>org.springframework.cloud</groupId>  
            <artifactId>spring-cloud-starter-sleuth</artifactId>  
            <version>3.0.0</version>  
        </dependency>  
    </dependencies>  
</project>  
```

--------------------------------

### Install FindAngularComponent recipe

Source: https://docs.openrewrite.org/recipes/angular/search/findangularcomponent

Installs the recipe jar if it is not available locally.

```shell
mod config recipes jar install io.moderne.recipe:rewrite-angular:1.6.0
```

--------------------------------

### Initialize project directory

Source: https://docs.openrewrite.org/authoring-recipes/javascript-recipe-development-environment

Commands to create the project structure and initialize the npm environment.

```bash
# Create a new directory for your project
mkdir my-openrewrite-recipes
cd my-openrewrite-recipes

# Initialize a new npm project
npm init -y

# Create source and test directories
mkdir -p src test
```

--------------------------------

### Example class definition

Source: https://docs.openrewrite.org/recipes/java/testing/mockito/anystringtonullable

The target class used in the test examples.

```java
class Example {  
    String greet(String name) {  
        return "Hello " + name;  
    }  
}  
```

--------------------------------

### Run SetupPythonToUv via Gradle Init Script

Source: https://docs.openrewrite.org/recipes/github/setuppythontouv

Use an init script to apply the recipe without modifying the project's build files directly.

```gradle
initscript {  
    repositories {  
        maven { url "https://plugins.gradle.org/m2" }  
    }  
    dependencies { classpath("org.openrewrite:plugin:7.37.0") }  
}  
rootProject {  
    plugins.apply(org.openrewrite.gradle.RewritePlugin)  
    dependencies {  
        rewrite("org.openrewrite.recipe:rewrite-github-actions:3.27.0")  
    }  
    rewrite {  
        activeRecipe("org.openrewrite.github.SetupPythonToUv")  
    setExportDatatables(true)  
    }  
    afterEvaluate {  
        if (repositories.isEmpty()) {  
            repositories {  
                mavenCentral()  
            }  
        }  
    }  
}  
```

```shell
gradle --init-script init.gradle rewriteRun  
```

--------------------------------

### Unchanged class example

Source: https://docs.openrewrite.org/recipes/java/spring/data/migratepagingandsortingrepository

Example of a class that remains unaffected by the migration.

```java
public class User {  
    private Long id;  
}  
```

--------------------------------

### Run SetupPythonToUv via Gradle Kotlin Init Script

Source: https://docs.openrewrite.org/recipes/github/setuppythontouv

Use a Kotlin-based init script to apply the recipe to your project.

```kotlin
initscript {  
    repositories {  
        maven { url = uri("https://plugins.gradle.org/m2") }  
    }  
    dependencies { classpath("org.openrewrite:plugin:7.37.0") }  
}  
rootProject {  
    plugins.apply(org.openrewrite.gradle.RewritePlugin::class.java)  
    dependencies {  
        add("rewrite", "org.openrewrite.recipe:rewrite-github-actions:3.27.0")  
    }  
    extensions.configure<org.openrewrite.gradle.RewriteExtension> {  
        activeRecipe("org.openrewrite.github.SetupPythonToUv")  
    setExportDatatables(true)  
    }  
    afterEvaluate {  
        if (repositories.isEmpty()) {  
            repositories {  
                mavenCentral()  
            }  
        }  
    }  
}  
```

```shell
gradle --init-script init.gradle.kts rewriteRun  
```

--------------------------------

### Gradle Enterprise to Develocity Migration Example

Source: https://docs.openrewrite.org/recipes/gradle/plugins/migrategradleenterprisetodevelocity

Shows the configuration before and after applying the migration recipe.

```groovy
plugins {  
    id 'com.gradle.enterprise' version '3.16'  
}  
gradleEnterprise {  
    server = 'https://ge.sam.com/'  
    allowUntrustedServer = true  
    buildScan {  
        publishAlways()  
        uploadInBackground = true  
        capture {  
            taskInputFiles = true  
        }  
    }  
    buildCache {  
        remote(gradleEnterprise.buildCache) {  
            enabled = true  
            push = System.getenv("CI") != null  
        }  
    }  
}  
```

```groovy
plugins {  
    id 'com.gradle.develocity' version '3.17.6'  
}  
develocity {  
    server = 'https://ge.sam.com/'  
    allowUntrustedServer = true  
    buildScan {  
        uploadInBackground = true  
        capture {  
            fileFingerprints = true  
        }  
    }  
    buildCache {  
        remote(develocity.buildCache) {  
            enabled = true  
            push = System.getenv("CI") != null  
        }  
    }  
}  
```

--------------------------------

### Unchanged pom.xml example

Source: https://docs.openrewrite.org/recipes/java/dependencies/search/findminimumdependencyversion

An example of a pom.xml file that does not trigger a change.

```xml
<project>  
  <groupId>org.openrewrite</groupId>  
  <artifactId>server</artifactId>  
  <version>0.1.0-SNAPSHOT</version>  
  <dependencies>  
      <dependency>  
          <groupId>com.fasterxml.jackson.core</groupId>  
          <artifactId>jackson-core</artifactId>  
          <version>2.15.0</version>  
      </dependency>  
  </dependencies>  
</project>  
```

--------------------------------

### Unchanged Class Example

Source: https://docs.openrewrite.org/recipes/java/dependencies/dependencyvulnerabilitycheck

A placeholder class example showing no changes.

```java

public class A {}  



```

--------------------------------

### Add Repository Example

Source: https://docs.openrewrite.org/recipes/maven/addrepository

Demonstrates the transformation of a pom.xml file before and after applying the AddRepository recipe.

```xml
<project>  
  <groupId>com.mycompany.app</groupId>  
  <artifactId>my-app</artifactId>  
  <version>1</version>  
</project>  
```

```xml
<project>  
  <groupId>com.mycompany.app</groupId>  
  <artifactId>my-app</artifactId>  
  <version>1</version>  
  <repositories>  
    <repository>  
      <id>myRepo</id>  
      <url>http://myrepo.maven.com/repo</url>  
    </repository>  
  </repositories>  
</project>  
```

--------------------------------

### Example file content before and after

Source: https://docs.openrewrite.org/recipes/core/findduplicatesourcefiles

Shows the transformation applied to a properties file.

```text
hello=world  
```

```text
~~>hello=world  
```

```text
--- hello.properties  
+++ hello.properties  
@@ -1,1 +1,1 @@  
-hello=world  
+~~>hello=world  
```

--------------------------------

### Install FindMessagingConnections recipe jar

Source: https://docs.openrewrite.org/recipes/prethink/calm/findmessagingconnections

Install the recipe artifact if it is not available locally.

```shell
mod config recipes jar install io.moderne.recipe:rewrite-prethink:0.10.0
```

--------------------------------

### Example import ordering transformation

Source: https://docs.openrewrite.org/recipes/java/orderimports

Demonstrates the before and after state of Java imports when the recipe is applied.

```java
import java.util.List;  
import java.util.ArrayList;  
import java.util.regex.Pattern;  
import java.util.Objects;  
import java.util.Set;  
import java.util.Map;  
```

```java
import java.util.*;  
import java.util.regex.Pattern;  
```

```diff
@@ -1,2 +1,1 @@  
-import java.util.List;  
-import java.util.ArrayList;  
+import java.util.*;  
import java.util.regex.Pattern;  
@@ -4,3 +3,0 @@  
import java.util.ArrayList;  
import java.util.regex.Pattern;  
-import java.util.Objects;  
-import java.util.Set;  
-import java.util.Map;  
```

--------------------------------

### Install ChangeListMethodAndVerify recipe jar

Source: https://docs.openrewrite.org/recipes/compiled/verification/changelistmethodandverify

Installs the recipe jar if it is not available locally.

```shell
mod config recipes jar install org.openrewrite.recipe:rewrite-compiled-analysis:0.14.3
```

--------------------------------

### XML Namespace Change Example

Source: https://docs.openrewrite.org/recipes/xml/changenamespacevalue

Demonstrates the before and after state of an XML file when applying the ChangeNamespaceValue recipe.

```xml
<web-app xmlns="http://java.sun.com/xml/ns/javaee" version="2.4"  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"  
    id="WebApp_ID">  
    <display-name>testWebDDNamespace</display-name>  
</web-app>  
```

```xml
<web-app xmlns="http://java.sun.com/xml/ns/j2ee" version="2.4"  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"  
    id="WebApp_ID">  
    <display-name>testWebDDNamespace</display-name>  
</web-app>  
```

--------------------------------

### Docker file conversion example

Source: https://docs.openrewrite.org/recipes/docker/useexecformentrypoint

Shows the transformation from shell form to exec form for an ENTRYPOINT instruction.

```docker
FROM ubuntu:22.04  
ENTRYPOINT /app/server  

```

```docker
FROM ubuntu:22.04  
ENTRYPOINT ["/app/server"]  

```

```diff
@@ -2,1 +2,1 @@  
FROM ubuntu:22.04  
-ENTRYPOINT /app/server  
+ENTRYPOINT ["/app/server"]  
  

```

--------------------------------

### Java RestController Class Example

Source: https://docs.openrewrite.org/recipes/quarkus/spring/addspringcompatibilityextensions

Example of a Spring RestController class before the migration.

```java
import org.springframework.stereotype.Service;  
import org.springframework.web.bind.annotation.RestController;  
import org.springframework.web.bind.annotation.GetMapping;  
  
@RestController  
class DemoController {  
  
    @GetMapping("/hello")  
    public String hello() {  
        return "Hello World";  
    }  
}  
```

--------------------------------

### Unchanged Java class example

Source: https://docs.openrewrite.org/recipes/maven/search/modulehasdependency

Example of a Java class where the dependency is not found.

```java
class B {}  
```

--------------------------------

### Example settings.gradle output

Source: https://docs.openrewrite.org/recipes/gradle/plugins/addsettingspluginrepository

The resulting structure added to the settings.gradle file after applying the recipe.

```gradle
pluginManagement {  
    repositories {  
        maven {  
            url = "https://repo.example.com/snapshots"  
        }  
    }  
}  
```

--------------------------------

### Install recipe dependency

Source: https://docs.openrewrite.org/running-recipes/popular-recipe-guides/automatically-fix-checkstyle-violations

Downloads the required JAR for the static analysis recipe if it is not available locally.

```shell
mod config recipes jar install org.openrewrite.recipe:rewrite-static-analysis:2.39.0
```

--------------------------------

### Create a sample Dockerfile

Source: https://docs.openrewrite.org/running-recipes/running-text-based-recipes

A sample Dockerfile using a Java 17 base image to be targeted by the text replacement recipe.

```dockerfile
FROM eclipse-temurin:17-jdk-jammy  
  
WORKDIR /app  
  
COPY .mvn/ .mvn  
COPY mvnw pom.xml ./  
RUN ./mvnw dependency:resolve  
  
COPY src ./src  
  
CMD ["./mvnw", "spring-boot:run"]
```

--------------------------------

### NeedBraces Java transformation example

Source: https://docs.openrewrite.org/recipes/staticanalysis/needbraces

Demonstrates the before and after state of Java code when applying the NeedBraces recipe.

```java
class Test {  
    static void addToWhile() {  
        while (true) ;  
    }  
  
    static void addToWhileWithBody() {  
        while (true) return;  
    }  
  
    static void addToIf(int n) {  
        if (n == 1) return;  
        // foo  
    }  
  
    static void addToIfElse(int n) {  
        if (n == 1) return;  
        else return;  
    }  
  
    static void addToIfElseIfElse(int n) {  
        if (n == 1) return;  
        else if (n == 2) return;  
        else return;  
    }  
  
    static void addToDoWhile(Object obj) {  
        do obj.notify(); while (true);  
    }  
  
    static void addToIterativeFor(Object obj) {  
        for (int i = 0; ; ) obj.notify();  
    }  
  
    static void addToForEach(int[] arr) {  
        for (int i : arr) System.out.println(i);  
    }  
}  
```

```java
class Test {  
    static void addToWhile() {  
        while (true) {  
        }  
    }  
  
    static void addToWhileWithBody() {  
        while (true) {  
            return;  
        }  
    }  
  
    static void addToIf(int n) {  
        if (n == 1) {  
            return;  
        }  
        // foo  
    }  
  
    static void addToIfElse(int n) {  
        if (n == 1) {  
            return;  
        } else {  
            return;  
        }  
    }  
  
    static void addToIfElseIfElse(int n) {  
        if (n == 1) {  
            return;  
        } else if (n == 2) {  
            return;  
        } else {  
            return;  
        }  
    }  
  
    static void addToDoWhile(Object obj) {  
        do {  
            obj.notify();  
        } while (true);  
    }  
  
    static void addToIterativeFor(Object obj) {  
        for (int i = 0; ; ) {  
            obj.notify();  
        }  
    }  
  
    static void addToForEach(int[] arr) {  
        for (int i : arr) {  
            System.out.println(i);  
        }  
    }  
}  
```

--------------------------------

### XML namespace example

Source: https://docs.openrewrite.org/recipes/xml/search/findnamespaceprefix

An example of an XML file containing namespace declarations.

```xml
<!--~~>--><beans xmlns="http://www.springframework.org/schema/beans"  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
    xsi:schemaLocation="  
        http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd  
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">  
  
    <jaxws:client name="{http://cxf.apache.org/hello_world_soap_http}SoapPort" createdFromAPI="true" xmlns:jaxws="http://cxf.apache.org/jaxws">  
        <jaxws:conduitSelector>  
            <bean class="org.apache.cxf.endpoint.DeferredConduitSelector"/>  
        </jaxws:conduitSelector>  
    </jaxws:client>  
</beans>  
```

--------------------------------

### Add Gradle Plugin Example Output

Source: https://docs.openrewrite.org/recipes/gradle/plugins/addbuildplugin

The resulting build.gradle file after applying the AddBuildPlugin recipe.

```gradle
plugins {  
    id 'java-library'  
}  

```

--------------------------------

### Install recipe via Moderne CLI

Source: https://docs.openrewrite.org/recipes/apache/camel/upgrade/camel40/properties/rejectedpolicy

Install the recipe jar if it is not available locally.

```shell
mod config recipes jar install org.openrewrite.recipe:rewrite-third-party:0.43.0  
```

--------------------------------

### Initialize a new project

Source: https://docs.openrewrite.org/authoring-recipes/recipe-development-environment

Commands to generate the directory structure and build files for a new project.

```bash
gradle init
```

```bash
mvn -B archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.5
```

--------------------------------

### Install FindCyclomaticComplexity recipe jar

Source: https://docs.openrewrite.org/recipes/analysis/java/controlflow/search/findcyclomaticcomplexity

Install the required recipe artifact if it is not available locally.

```shell
mod config recipes jar install io.moderne.recipe:rewrite-program-analysis:0.13.5
```

--------------------------------

### Implement a legacy Recipe using random file access

Source: https://docs.openrewrite.org/changelog/earlier-releases/8-1-2-Release

This example demonstrates the pre-8.1.2 approach using Recipe.visit to access multiple files, which is now discouraged for large source sets.

```java
// imports  
  
@Value  
@EqualsAndHashCode(callSuper = false)  
public class AddProperty extends Recipe {  
  
    @Option(displayName = "Property name",  
            description = "The name of the property to add.",  
            example = "org.gradle.caching")  
    String key;  
  
    @Option(displayName = "Property value",  
            description = "The value of the property to add.")  
    String value;  
  
    @Option(displayName = "Overwrite if exists",  
            description = "If a property with the same key exists, overwrite.",  
            example = "Enable the Gradle build cache")  
    @Nullable  
    Boolean overwrite;  
  
    @Override  
    public String getDisplayName() {  
        return "Add Gradle property";  
    }  
  
    @Override  
    public String getDescription() {  
        return "Add a property to the `gradle.properties` file.";  
    }  
  
    @Override  
    protected TreeVisitor<?, ExecutionContext> getApplicableTest() {  
        return new FindGradleProject(FindGradleProject.SearchCriteria.Marker).getVisitor();  
    }  
  
    @Override  
    protected List<SourceFile> visit(List<SourceFile> before, ExecutionContext ctx) {  
        AtomicBoolean exists = new AtomicBoolean();  
        List<SourceFile> after = ListUtils.map(before, sourceFile -> {  
            if (sourceFile.getSourcePath().endsWith(Paths.get("gradle.properties"))) {  
                exists.set(true);  
                Tree t = !Boolean.TRUE.equals(overwrite) ?  
                        sourceFile :  
                        new ChangePropertyValue(key, value, null, false, null, null)  
                                .getVisitor().visitNonNull(sourceFile, ctx);  
                return (SourceFile) new org.openrewrite.properties.AddProperty(key, value, null, null)  
                        .getVisitor()  
                        .visitNonNull(t, ctx);  
            }  
            return sourceFile;  
        });  
  
        if (!exists.get()) {  
            after = ListUtils.concatAll(before, PropertiesParser.builder().build()  
                    .parseInputs(singletonList(Parser.Input.fromString(Paths.get("gradle.properties"),  
                            key + "=" + value)), null, ctx));  
        }  
  
        return after;  
    }  
}  
```

--------------------------------

### Install FindAgentsInUse recipe jar

Source: https://docs.openrewrite.org/recipes/ai/findagentsinuse

Installs the recipe jar if it is not already available locally.

```shell
mod config recipes jar install io.moderne.recipe:rewrite-ai:0.4.3
```

--------------------------------

### Add Project Build Output Timestamp Example

Source: https://docs.openrewrite.org/recipes/maven/cleanup/addprojectbuildoutputtimestamp

Shows the before and after state of a pom.xml file when applying the recipe.

```xml
<project>  
  <groupId>com.mycompany.app</groupId>  
  <artifactId>my-app</artifactId>  
  <version>1</version>  
</project>  
```

```xml
<project>  
  <groupId>com.mycompany.app</groupId>  
  <artifactId>my-app</artifactId>  
  <version>1</version>  
  <properties>  
    <project.build.outputTimestamp>1980-01-01T00:00:00Z</project.build.outputTimestamp>  
  </properties>  
</project>  
```
Tokens:
Raw