Open source

Find and replace

Recipe IDorg.openrewrite.text.FindAndReplace

Artifactorg.openrewrite:rewrite-core

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.

Single recipeApache 2.0

Usage

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

mod run . --recipe org.openrewrite.text.FindAndReplace --recipe-option "find=blacklist"

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

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

Options

Name	Type	Description
`find`required	`String`	The text to find (and replace). This snippet can be multiline. e.g. `blacklist`
`replace`	`String`	The replacement text for `find`. This snippet can be multiline. e.g. `denylist`
`regex`	`Boolean`	Default false. If true, `find` will be interpreted as a Regular Expression, and capture group contents will be available in `replace`.
`caseSensitive`	`Boolean`	If `true` the search will be sensitive to case. Default `false`.
`multiline`	`Boolean`	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`.
`dotAll`	`Boolean`	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`.
`filePattern`	`String`	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. e.g. `*/.java`
`plaintextOnly`	`Boolean`	Only alter files that are parsed as plaintext to prevent language-specific LST information loss. Defaults to false.

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