← All recipes
Moderne licensed

Mark additional files as Spring configuration

Recipe IDorg.openrewrite.java.spring.MarkAdditionalSpringConfigFilesArtifactorg.openrewrite.recipe:rewrite-spring

Attach a SpringConfigFile marker to YAML/properties files matching the provided glob patterns so that Spring property recipes such as ChangeSpringPropertyKey, DeleteSpringProperty, ChangeSpringPropertyValue, and CommentOutSpringPropertyKey will visit files that live outside standard resource source sets. Files that already pass the SourceSet-based check are skipped to avoid redundant markers.

Single recipeMSAL

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

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

rewrite {
    activeRecipe("org.openrewrite.java.spring.MarkAdditionalSpringConfigFiles")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-spring:6.40.0")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.spring.MarkAdditionalSpringConfigFiles --recipe-option "pathPatterns=**/properties/*.properties"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-spring:RELEASE

Options

NameTypeDescription
pathPatternsrequiredListGlob patterns (relative to the repository root) identifying YAML or properties files that should be treated as Spring configuration even though they live outside a standard src/main/resources source set. Files already carrying a SourceSet marker are left alone.
e.g. **/properties/*.properties

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats