Find text

org.openrewrite.text.Find

Search for text, treating all textual sources as plain text.

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite

  • artifactId: rewrite-core

  • version: 8.21.0

Options

TypeNameDescriptionExample

String

find

The text to find. This snippet can be multiline.

blacklist

Boolean

regex

Optional. If true, find will be interpreted as a Regular Expression. Default false.

Boolean

caseSensitive

Optional. If true the search will be sensitive to case. Default false.

Boolean

multiline

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.

Boolean

dotAll

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.

String

filePattern

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.

**/*.java

Data Tables (Only available on the Moderne platform)

Text matches

Lines matching simple text search.

Column NameDescription

Source path

The path to the source file.

Match

The text of the match.

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. 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'

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("6.10.0")
}

rewrite {
    activeRecipe("com.yourorg.FindExample")
}

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

See how this recipe works across multiple open-source repositories

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.

Contributors

Sam Snyder, Jonathan Schneider, Tim te Beek

Last updated