← All recipes
Open source

Find within comments and literals

Recipe IDorg.openrewrite.java.search.FindComments
Artifactorg.openrewrite:rewrite-java

Find regular expression matches within comments and literals. "Literals" includes string literals, character literals, and numeric literals.

Single recipeApache 2.0

Usage

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

mod run . --recipe org.openrewrite.java.search.FindComments --recipe-option "patterns=-----BEGIN RSA PRIVATE KEY-----"

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

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

Options

NameTypeDescription
patternsrequiredListA list of regular expressions to search for.
e.g. -----BEGIN RSA PRIVATE KEY-----

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