Find text
Recipe ID
org.openrewrite.text.FindArtifact
org.openrewrite:rewrite-coreTextual search, optionally using Regular Expression (regex) to query.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.text.Find --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.0Options
| Name | Type | Description |
|---|---|---|
findrequired | String | The text to find. This snippet can be multiline. e.g. blacklist |
regex | Boolean | If true, find will be interpreted as a Regular Expression. Default false. |
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 |
description | Boolean | Add the matched value(s) as description on the search result marker. Default false. |
contextSize | Integer | 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.e.g. 50 |
Data tables
Structured output this recipe can produce.
- Text matchesLines matching simple text search.
org.openrewrite.table.TextMatches - 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