← All recipes
Open source

Find and replace literals in HCL files

Recipe IDorg.openrewrite.hcl.search.FindAndReplaceLiteral
Artifactorg.openrewrite:rewrite-hcl

Find and replace literal values in HCL files. This recipe parses the source files on which it runs as HCL, meaning you can execute HCL language-specific recipes before and after this recipe in a single recipe run.

Single recipeApache 2.0

Usage

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

mod run . --recipe org.openrewrite.hcl.search.FindAndReplaceLiteral --recipe-option "find=blacklist"

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

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

Options

NameTypeDescription
findrequiredStringThe literal to find (and replace)
e.g. blacklist
replaceStringThe replacement literal for find. This snippet can be multiline.
e.g. denylist
regexBooleanDefault false. If true, find will be interpreted as a Regular Expression, and capture group contents will be available in replace.
caseSensitiveBooleanIf true the search will be sensitive to case. Default false.

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