Skip to main content

Find and replace literals in HCL files

org.openrewrite.hcl.search.FindAndReplaceLiteral

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.

Recipe source

GitHub, Issue Tracker, Maven Central

Options

TypeNameDescriptionExample
StringfindThe literal to find (and replace)blacklist
StringreplaceOptional. The replacement literal for find. This snippet can be multiline.denylist
BooleanregexOptional. Default false. If true, find will be interpreted as a Regular Expression, and capture group contents will be available in replace.
BooleancaseSensitiveOptional. If true the search will be sensitive to case. Default false.

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.FindAndReplaceLiteralExample. 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.FindAndReplaceLiteralExample
displayName: Find and replace literals in HCL files example
recipeList:
- org.openrewrite.hcl.search.FindAndReplaceLiteral:
find: blacklist
replace: denylist

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

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

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column NameDescription
Source pathThe file that failed to parse.
Recipe that made changesThe specific recipe that made a change.
Stack traceThe stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column NameDescription
The recipeThe recipe whose stats are being measured both individually and cumulatively.
Source file countThe number of source files the recipe ran over.
Source file changed countThe number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning timeThe total time spent across the scanning phase of this recipe.
99th percentile scanning time99 out of 100 scans completed in this amount of time.
Max scanning timeThe max time scanning any one source file.
Cumulative edit timeThe total time spent across the editing phase of this recipe.
99th percentile edit time99 out of 100 edits completed in this amount of time.
Max edit timeThe max time editing any one source file.

Contributors

l-ferguson, Tim te Beek, Jonathan Schnéider