Links
Comment on page

Use org.springframework.boot.web.server.LocalServerPort

org.openrewrite.java.spring.boot2.MigrateLocalServerPortAnnotation
Updates the package and adds the necessary dependency if LocalServerPort is in use. The package of LocalServerPort was changed in Spring Boot 2.0, necessitating changes.

Recipe source

  • groupId: org.openrewrite.recipe
  • artifactId: rewrite-spring
  • version: 5.1.2

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-spring:5.1.2 in your build file or by running a shell command (in which case no build changes are needed):
Gradle
Gradle init script
Maven POM
Maven Command Line
Moderne CLI
  1. 1.
    Add the following to your build.gradle file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.5.6")
}
rewrite {
activeRecipe("org.openrewrite.java.spring.boot2.MigrateLocalServerPortAnnotation")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-spring:5.1.2")
}
  1. 2.
    Run gradle rewriteRun to run the recipe.
  1. 1.
    Create a file named init.gradle in the root of your project.
init.gradle
initscript {
repositories {
maven { url "https://plugins.gradle.org/m2" }
}
dependencies { classpath("org.openrewrite:plugin:6.5.6") }
}
rootProject {
plugins.apply(org.openrewrite.gradle.RewritePlugin)
dependencies {
rewrite("org.openrewrite.recipe:rewrite-spring:5.1.2")
}
rewrite {
activeRecipe("org.openrewrite.java.spring.boot2.MigrateLocalServerPortAnnotation")
}
afterEvaluate {
if (repositories.isEmpty()) {
repositories {
mavenCentral()
}
}
}
}
  1. 2.
    Run gradle --init-script init.gradle rewriteRun to run the recipe.
  1. 1.
    Add the following to your pom.xml file:
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.13.0</version>
<configuration>
<activeRecipes>
<recipe>org.openrewrite.java.spring.boot2.MigrateLocalServerPortAnnotation</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-spring</artifactId>
<version>5.1.2</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
  1. 2.
    Run mvn rewrite:run to run the recipe.
shell
mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
-Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-spring:RELEASE \
-Drewrite.activeRecipes=org.openrewrite.java.spring.boot2.MigrateLocalServerPortAnnotation
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe MigrateLocalServerPortAnnotation

Definition

Recipe List
Yaml Recipe List
    • groupId: org.springframework.boot
    • artifactId: spring-boot-starter-web
    • version: 2.0.x
    • onlyIfUsing: org.springframework.boot.web.server.LocalServerPort
    • classifier: org.springframework.boot.web.server.LocalServerPort
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.spring.boot2.MigrateLocalServerPortAnnotation
displayName: Use `org.springframework.boot.web.server.LocalServerPort`
description: Updates the package and adds the necessary dependency if `LocalServerPort` is in use. The package of `LocalServerPort` was changed in Spring Boot 2.0, necessitating changes.
recipeList:
- org.openrewrite.java.dependencies.AddDependency:
groupId: org.springframework.boot
artifactId: spring-boot-starter-web
version: 2.0.x
onlyIfUsing: org.springframework.boot.web.server.LocalServerPort
classifier: org.springframework.boot.web.server.LocalServerPort

See how this recipe works across multiple open-source repositories

Moderne Link Image
The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Contributors