Open source

Find text

Recipe IDorg.openrewrite.text.Find

Artifactorg.openrewrite:rewrite-core

Textual search, optionally using Regular Expression (regex) to query.

Single recipeOpenRewriteApache License Version 2.0

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

8 parameters

1 required7 optional

Parameter	Example	Type	Required
find	blacklist	String	Required
The text to find. This snippet can be multiline.
caseSensitive	—	Boolean	Optional
If true the search will be sensitive to case. Default false.
contextSize	50	Integer	Optional
The number of characters to include in the datatable before and after the match. Default 0, -1 indicates that the whole text should be used.
description	—	Boolean	Optional
Add the matched value(s) as description on the search result marker. Default false.
dotAll	—	Boolean	Optional
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	**/*.java	String	Optional
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.
multiline	—	Boolean	Optional
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.
regex	—	Boolean	Optional
If true, find will be interpreted as a [Regular Expression](https://en.wikipedia.org/wiki/Regular_expression). Default false.

Usage

Run this recipe

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

shell

mod run . --recipe Find --recipe-option "find=blacklist" --recipe-option "filePattern='**/*.java'" --recipe-option "contextSize=50"

If the recipe is not available locally, then you can install it using:

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

Data tables

Text matches

org.openrewrite.table.TextMatches

Lines matching simple text search.

Column	Description
Source path	The path to the source file.
Match	The text of the match.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A 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 changes	In 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 changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.