Skip to main content

Find and replace

org.openrewrite.text.FindAndReplace

Textual find and replace, optionally interpreting the search query as a Regular Expression (regex). When operating on source files that are language-specific Lossless Semantic Tree, such as Java or XML, this operation converts the source file to plain text for the rest of the recipe run. So if you are combining this recipe with language-specific recipes in a single recipe run put all the language-specific recipes before this recipe.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringfindThe text to find (and replace). This snippet can be multiline.blacklist
StringreplaceOptional. The replacement text for find. This snippet can be multiline.denylist
BooleanregexOptional. Default false. If true, find will be interpreted as a Regular Expression, and capture group contents will be available in replace.
BooleancaseSensitiveOptional. If true the search will be sensitive to case. Default false.
BooleanmultilineOptional. When performing a regex search setting this to true allows "^" and "$" to match the beginning and end of lines, respectively. When performing a regex search when this is false "^" and "$" will match only the beginning and ending of the entire source file, respectively.Has no effect when not performing a regex search. Default false.
BooleandotAllOptional. When performing a regex search setting this to true allows "." to match line terminators.Has no effect when not performing a regex search. Default false.
StringfilePatternOptional. 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
BooleanplaintextOnlyOptional. Only alter files that are parsed as plaintext to prevent language-specific LST information loss. Defaults to false.

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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.FindAndReplaceExample. 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.FindAndReplaceExample
displayName: Find and replace example
recipeList:
  - org.openrewrite.text.FindAndReplace:
      find: blacklist
      replace: denylist
      filePattern: '**/*.java'

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

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.5.0")
}

rewrite {
    activeRecipe("com.yourorg.FindAndReplaceExample")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Sam Snyder, Nick McKinney, Tim te Beek, Ryan Hudson, Jonathan Schneider