← All recipes
Open source

Experimental find text with multiselect

Recipe IDorg.openrewrite.text.FindMultiselectArtifactorg.openrewrite:rewrite-core

Search for text, treating all textual sources as plain text. This version of the recipe exists to experiment with multiselect recipe options.

Single recipeApache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.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.text.FindMultiselect")
}

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:rewrite-core:8.92.8")
}

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.text.FindMultiselect --recipe-option "find=blacklist"

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

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

Options

NameTypeDescription
findrequiredStringThe text to find. This snippet can be multiline.
e.g. blacklist
regexBooleanIf true, find will be interpreted as a Regular Expression. Default false.
regexOptionsSetRegex processing options. Multiple options may be specified. These options do nothing if regex mode is not enabled. * Case-sensitive - The search will be sensitive to letter case. * Multiline - Allows ^ and $ to match the beginning and end of lines, respectively.* Dot all - Allows . to match line terminators.
filePatternStringA glob expression that can be used to constrain which directories or source files should be searched. Multiple patterns may be specified, separated by a semicolon ;. If multiple patterns are supplied any of the patterns matching will be interpreted as a match. When not set, all source files are searched.
e.g. **/*.java

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