Experimental find text with multiselect

org.openrewrite.text.FindMultiselect

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

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-core

• version: 8.24.0

Options

Type	Name	Description	Example
String	find	The text to find. This snippet can be multiline.	blacklist
Boolean	regex	Optional. If true, find will be interpreted as a Regular Expression. Default false.
Set	regexOptions	Optional. Regex 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. Valid options: Case-sensitive, Multiline, Dot all
String	filePattern	A 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.	**/*.java

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.FindMultiselectExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.FindMultiselectExample
displayName: Experimental find text with multiselect example
recipeList:
  - org.openrewrite.text.FindMultiselect:
      find: blacklist
      filePattern: '**/*.java'

Now that com.yourorg.FindMultiselectExample has been defined activate it in your build file:

Gradle

1. Add the following to your build.gradle file:

build.gradle

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

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

repositories {
    mavenCentral()
}

2. Run gradle rewriteRun to run the recipe.

Maven

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.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.FindMultiselectExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe FindMultiselectExample

See how this recipe works across multiple open-source repositories

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

Sam Snyder, Tim te Beek