Links

Delete key

org.openrewrite.json.DeleteKey Delete a JSON mapping entry key.

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-json
  • version: 7.35.0

Options

Type
Name
Description
String
keyPath
A JsonPath expression to locate a JSON entry.
String
fileMatcher
Optional. Matching files will be modified. This is a glob expression.

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.DeleteKeyExample. 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.DeleteKeyExample
displayName: Delete key example
recipeList:
- org.openrewrite.json.DeleteKey:
keyPath: $.subjects.kind
fileMatcher: '**/application-*.json'
Now that com.yourorg.DeleteKeyExample has been defined activate it and take a dependency on org.openrewrite:rewrite-json:7.35.0 in your build file:
Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.34.0")
}
rewrite {
activeRecipe("com.yourorg.DeleteKeyExample")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite:rewrite-json:7.35.0")
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.39.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.DeleteKeyExample</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite</groupId>
<artifactId>rewrite-json</artifactId>
<version>7.35.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
Recipes can also be activated directly from the command line by adding the argument -Drewrite.activeRecipes=com.yourorg.DeleteKeyExample

See how this recipe works across multiple open-source repositories

Moderne Link Image
The Moderne public SaaS instance 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.
Last modified 13d ago