Skip to main content

Find text

org.openrewrite.text.Find

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

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringfindThe text to find. This snippet can be multiline.blacklist
BooleanregexOptional. If true, find will be interpreted as a Regular Expression. Default false.
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
BooleandescriptionOptional. Add the matched value(s) as description on the search result marker. Default false.
IntegercontextSizeOptional. 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.50

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.FindExample. 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.FindExample
displayName: Find text example
recipeList:
  - org.openrewrite.text.Find:
      find: blacklist
      filePattern: '**/*.java'
      contextSize: 50

Now that com.yourorg.FindExample 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.7.0")
}

rewrite {
    activeRecipe("com.yourorg.FindExample")
    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​

Text matches​

org.openrewrite.table.TextMatches

Lines matching simple text search.

Column NameDescription
Source pathThe path to the source file.
MatchThe text of the match.

Contributors​

Sam Snyder, Knut Wannheden, Jonathan Schneider, Jacob van Lingen, Niels de Bruin, Tim te Beek