zhongwei/gh-openrewrite-rewrite-docs-openrewrite-recipe-writer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
Zhongwei Li
2025-11-30 08:45:33 +08:00
commit 480d09eec9
27 changed files with 8336 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
skills/writing-openrewrite-recipes/references/recipes-xml-yaml-json-common.csv Normal file
View File

@@ -0,0 +1,51 @@
Fully Qualified Recipe Name,Recipe Name,Description
org.openrewrite.java.logging.containerized.ContainerizeLog4j2PropertiesConfiguration,Containerize Log4j2 Properties configuration,Transforms Log4j2 Properties configuration to write logs to stdout instead of files suitable for containerized environments.
org.openrewrite.java.logging.containerized.ContainerizeLog4j2XmlConfiguration,Containerize Log4j2 XML configuration,Transforms Log4j2 XML configuration to write logs to stdout instead of files suitable for containerized environments.
org.openrewrite.java.logging.containerized.ContainerizeLog4j2YamlConfiguration,Containerize Log4j2 YAML configuration,Transforms Log4j2 YAML configuration to write logs to stdout instead of files suitable for containerized environments. (Implementation in progress)
io.moderne.kafka.RemoveDeprecatedKafkaProperties,Remove deprecated Kafka property,Removes a specific Kafka property that is no longer supported in Kafka 4.0.
org.openrewrite.gradle.AddProperty,Add Gradle property,Add a property to the `gradle.properties` file.
org.openrewrite.json.AddKeyValue,Add value to JSON Object,Adds a `value` at the specified `keyPath` with the specified `key` if the key doesn't already exist.
org.openrewrite.json.ChangeKey,Change key,Change a JSON mapping entry key while leaving the value intact.
org.openrewrite.json.ChangeValue,Change value,Change a JSON mapping entry value leaving the key intact.
org.openrewrite.json.DeleteKey,Delete key,Delete a JSON mapping entry key.
org.openrewrite.json.format.AutoFormat,Format JSON,Format JSON code using a standard comprehensive set of JSON formatting recipes.
org.openrewrite.json.format.Indents,JSON indent,Format tabs and indents in JSON.
org.openrewrite.json.format.WrappingAndBraces,JSON new lines,Split members into separate lines in JSON.
org.openrewrite.json.search.FindKey,Find JSON object members,Find JSON object members by JsonPath expression.
org.openrewrite.json.CreateJsonFile,Create JSON file,Create a new JSON file.
org.openrewrite.maven.AddProfile,Add Maven profile,Add a maven profile to a `pom.xml` file.
org.openrewrite.maven.ChangePropertyValue,Change Maven project property value,Changes the specified Maven project property value leaving the key intact.
org.openrewrite.maven.RemoveProperty,Remove Maven project property,Removes the specified Maven project property from the pom.xml.
org.openrewrite.maven.search.FindScm,Find SCM tag,Finds any `<scm>` tag directly inside the `<project>` root of a Maven pom.xml file.
org.openrewrite.properties.AddProperty,Add a new property,Adds a new property to a property file. Attempts to place the new property in alphabetical order by the property keys. Whitespace before and after the `=` must be included in the property and value.
org.openrewrite.properties.AddPropertyComment,Add comment before property key,Add a new comment before a property key if not already present optionally commenting out the property.
org.openrewrite.properties.ChangePropertyKey,Change property key,Change a property key leaving the value intact.
org.openrewrite.properties.ChangePropertyValue,Change property value,Change a property value leaving the key intact.
org.openrewrite.properties.DeleteProperty,Delete property by key,Deletes key/value pairs from properties files as well as any comments that immediately precede the key/value pair. Comments separated by two or more newlines from the deleted key/value pair are preserved.
org.openrewrite.properties.search.FindProperties,Find property,Finds occurrences of a property key.
org.openrewrite.properties.CreatePropertiesFile,Create Properties file,Create a new Properties file.
org.openrewrite.xml.AddCommentToXmlTag,Add a comment to an XML tag,Adds a comment as the first element in an XML tag.
org.openrewrite.xml.AddOrUpdateChildTag,Add or update child tag,Adds or updates a child element below the parent(s) matching the provided `parentXPath` expression. If a child with the same name already exists it will be replaced by default. Otherwise a new child will be added. This ensures idempotent behaviour.
org.openrewrite.xml.AddTagAttribute,Add new XML attribute for an Element,Add new XML attribute with value on a specified element.
org.openrewrite.xml.ChangeNamespaceValue,Change XML attribute of a specific resource version,Alters XML Attribute value within specified element of a specific resource versions.
org.openrewrite.xml.ChangeTagAttribute,Change XML attribute,Alters XML attribute value on a specified element.
org.openrewrite.xml.ChangeTagName,Change XML tag name,Alters the name of XML tags matching the provided expression.
org.openrewrite.xml.ChangeTagValue,Change XML tag value,Alters the value of XML tags matching the provided expression. When regex is enabled the replacement happens only for text nodes provided the pattern matches.
org.openrewrite.xml.RemoveEmptyXmlTags,Remove empty XML Tag,Removes XML tags that do not have attributes or children including self closing tags.
org.openrewrite.xml.RemoveTrailingWhitespace,Remove trailing whitespace,Remove any extra trailing whitespace from the end of each line.
org.openrewrite.xml.RemoveXmlTag,Remove XML tag,Removes XML tags matching the provided expression.
org.openrewrite.xml.XsltTransformation,XSLT transformation,Apply the specified XSLT transformation on matching files. Note that there are no format matching guarantees when running this recipe.
org.openrewrite.xml.format.AutoFormat,Format XML,Indents XML using the most common indentation size and tabs or space choice in use in the file.
org.openrewrite.xml.format.LineBreaks,Blank lines,Add line breaks at appropriate places between XML syntax elements.
org.openrewrite.xml.format.NormalizeFormat,Normalize format,Move whitespace to the outermost LST element possible.
org.openrewrite.xml.format.NormalizeLineBreaks,Normalize line breaks,Consistently use either Windows style (CRLF) or Linux style (LF) line breaks. If no `GeneralFormatStyle` is specified this will use whichever style of line endings are more common.
org.openrewrite.xml.format.NormalizeTabsOrSpaces,Normalize to tabs or spaces,Consistently use either tabs or spaces in indentation.
org.openrewrite.xml.format.TabsAndIndents,Tabs and indents,Format tabs and indents in XML code.
org.openrewrite.xml.search.DoesNotUseNamespaceUri,Find files without Namespace URI,Find XML root elements that do not have a specific Namespace URI optionally restricting the search by an XPath expression.
org.openrewrite.xml.search.FindNamespacePrefix,Find XML namespace prefixes,Find XML namespace prefixes optionally restricting the search by a XPath expression.
org.openrewrite.xml.search.FindTags,Find XML tags,Find XML tags by XPath expression.
org.openrewrite.xml.search.HasNamespaceUri,Find XML namespace URIs,Find XML namespace URIs optionally restricting the search by a XPath expression.
org.openrewrite.xml.security.AddOwaspDateBoundSuppressions,Add date bounds to OWASP suppressions,Adds an expiration date to all OWASP suppressions in order to ensure that they are periodically reviewed. For use with the OWASP `dependency-check` tool. More details: https://jeremylong.github.io/DependencyCheck/general/suppression.html.
org.openrewrite.xml.security.IsOwaspSuppressionsFile,Find OWASP vulnerability suppression XML files,These files are used to suppress false positives in OWASP [Dependency Check](https://jeremylong.github.io/DependencyCheck).
org.openrewrite.xml.security.RemoveOwaspSuppressions,Remove out-of-date OWASP suppressions,Remove all OWASP suppressions with a suppression end date in the past as these are no longer valid. For use with the OWASP `dependency-check` tool. More details on OWASP suppression files can be found [here](https://jeremylong.github.io/DependencyCheck/general/suppression.html).
org.openrewrite.xml.security.UpdateOwaspSuppressionDate,Update OWASP suppression date bounds,Updates the expiration date for OWASP suppressions having a matching cve tag. For use with the OWASP `dependency-check` tool. More details: https://jeremylong.github.io/DependencyCheck/general/suppression.html.
1 Fully Qualified Recipe Name Recipe Name Description
2 org.openrewrite.java.logging.containerized.ContainerizeLog4j2PropertiesConfiguration Containerize Log4j2 Properties configuration Transforms Log4j2 Properties configuration to write logs to stdout instead of files suitable for containerized environments.
3 org.openrewrite.java.logging.containerized.ContainerizeLog4j2XmlConfiguration Containerize Log4j2 XML configuration Transforms Log4j2 XML configuration to write logs to stdout instead of files suitable for containerized environments.
4 org.openrewrite.java.logging.containerized.ContainerizeLog4j2YamlConfiguration Containerize Log4j2 YAML configuration Transforms Log4j2 YAML configuration to write logs to stdout instead of files suitable for containerized environments. (Implementation in progress)
5 io.moderne.kafka.RemoveDeprecatedKafkaProperties Remove deprecated Kafka property Removes a specific Kafka property that is no longer supported in Kafka 4.0.
6 org.openrewrite.gradle.AddProperty Add Gradle property Add a property to the `gradle.properties` file.
7 org.openrewrite.json.AddKeyValue Add value to JSON Object Adds a `value` at the specified `keyPath` with the specified `key` if the key doesn't already exist.
8 org.openrewrite.json.ChangeKey Change key Change a JSON mapping entry key while leaving the value intact.
9 org.openrewrite.json.ChangeValue Change value Change a JSON mapping entry value leaving the key intact.
10 org.openrewrite.json.DeleteKey Delete key Delete a JSON mapping entry key.
11 org.openrewrite.json.format.AutoFormat Format JSON Format JSON code using a standard comprehensive set of JSON formatting recipes.
12 org.openrewrite.json.format.Indents JSON indent Format tabs and indents in JSON.
13 org.openrewrite.json.format.WrappingAndBraces JSON new lines Split members into separate lines in JSON.
14 org.openrewrite.json.search.FindKey Find JSON object members Find JSON object members by JsonPath expression.
15 org.openrewrite.json.CreateJsonFile Create JSON file Create a new JSON file.
16 org.openrewrite.maven.AddProfile Add Maven profile Add a maven profile to a `pom.xml` file.
17 org.openrewrite.maven.ChangePropertyValue Change Maven project property value Changes the specified Maven project property value leaving the key intact.
18 org.openrewrite.maven.RemoveProperty Remove Maven project property Removes the specified Maven project property from the pom.xml.
19 org.openrewrite.maven.search.FindScm Find SCM tag Finds any `<scm>` tag directly inside the `<project>` root of a Maven pom.xml file.
20 org.openrewrite.properties.AddProperty Add a new property Adds a new property to a property file. Attempts to place the new property in alphabetical order by the property keys. Whitespace before and after the `=` must be included in the property and value.
21 org.openrewrite.properties.AddPropertyComment Add comment before property key Add a new comment before a property key if not already present optionally commenting out the property.
22 org.openrewrite.properties.ChangePropertyKey Change property key Change a property key leaving the value intact.
23 org.openrewrite.properties.ChangePropertyValue Change property value Change a property value leaving the key intact.
24 org.openrewrite.properties.DeleteProperty Delete property by key Deletes key/value pairs from properties files as well as any comments that immediately precede the key/value pair. Comments separated by two or more newlines from the deleted key/value pair are preserved.
25 org.openrewrite.properties.search.FindProperties Find property Finds occurrences of a property key.
26 org.openrewrite.properties.CreatePropertiesFile Create Properties file Create a new Properties file.
27 org.openrewrite.xml.AddCommentToXmlTag Add a comment to an XML tag Adds a comment as the first element in an XML tag.
28 org.openrewrite.xml.AddOrUpdateChildTag Add or update child tag Adds or updates a child element below the parent(s) matching the provided `parentXPath` expression. If a child with the same name already exists it will be replaced by default. Otherwise a new child will be added. This ensures idempotent behaviour.
29 org.openrewrite.xml.AddTagAttribute Add new XML attribute for an Element Add new XML attribute with value on a specified element.
30 org.openrewrite.xml.ChangeNamespaceValue Change XML attribute of a specific resource version Alters XML Attribute value within specified element of a specific resource versions.
31 org.openrewrite.xml.ChangeTagAttribute Change XML attribute Alters XML attribute value on a specified element.
32 org.openrewrite.xml.ChangeTagName Change XML tag name Alters the name of XML tags matching the provided expression.
33 org.openrewrite.xml.ChangeTagValue Change XML tag value Alters the value of XML tags matching the provided expression. When regex is enabled the replacement happens only for text nodes provided the pattern matches.
34 org.openrewrite.xml.RemoveEmptyXmlTags Remove empty XML Tag Removes XML tags that do not have attributes or children including self closing tags.
35 org.openrewrite.xml.RemoveTrailingWhitespace Remove trailing whitespace Remove any extra trailing whitespace from the end of each line.
36 org.openrewrite.xml.RemoveXmlTag Remove XML tag Removes XML tags matching the provided expression.
37 org.openrewrite.xml.XsltTransformation XSLT transformation Apply the specified XSLT transformation on matching files. Note that there are no format matching guarantees when running this recipe.
38 org.openrewrite.xml.format.AutoFormat Format XML Indents XML using the most common indentation size and tabs or space choice in use in the file.
39 org.openrewrite.xml.format.LineBreaks Blank lines Add line breaks at appropriate places between XML syntax elements.
40 org.openrewrite.xml.format.NormalizeFormat Normalize format Move whitespace to the outermost LST element possible.
41 org.openrewrite.xml.format.NormalizeLineBreaks Normalize line breaks Consistently use either Windows style (CRLF) or Linux style (LF) line breaks. If no `GeneralFormatStyle` is specified this will use whichever style of line endings are more common.
42 org.openrewrite.xml.format.NormalizeTabsOrSpaces Normalize to tabs or spaces Consistently use either tabs or spaces in indentation.
43 org.openrewrite.xml.format.TabsAndIndents Tabs and indents Format tabs and indents in XML code.
44 org.openrewrite.xml.search.DoesNotUseNamespaceUri Find files without Namespace URI Find XML root elements that do not have a specific Namespace URI optionally restricting the search by an XPath expression.
45 org.openrewrite.xml.search.FindNamespacePrefix Find XML namespace prefixes Find XML namespace prefixes optionally restricting the search by a XPath expression.
46 org.openrewrite.xml.search.FindTags Find XML tags Find XML tags by XPath expression.
47 org.openrewrite.xml.search.HasNamespaceUri Find XML namespace URIs Find XML namespace URIs optionally restricting the search by a XPath expression.
48 org.openrewrite.xml.security.AddOwaspDateBoundSuppressions Add date bounds to OWASP suppressions Adds an expiration date to all OWASP suppressions in order to ensure that they are periodically reviewed. For use with the OWASP `dependency-check` tool. More details: https://jeremylong.github.io/DependencyCheck/general/suppression.html.
49 org.openrewrite.xml.security.IsOwaspSuppressionsFile Find OWASP vulnerability suppression XML files These files are used to suppress false positives in OWASP [Dependency Check](https://jeremylong.github.io/DependencyCheck).
50 org.openrewrite.xml.security.RemoveOwaspSuppressions Remove out-of-date OWASP suppressions Remove all OWASP suppressions with a suppression end date in the past as these are no longer valid. For use with the OWASP `dependency-check` tool. More details on OWASP suppression files can be found [here](https://jeremylong.github.io/DependencyCheck/general/suppression.html).
51 org.openrewrite.xml.security.UpdateOwaspSuppressionDate Update OWASP suppression date bounds Updates the expiration date for OWASP suppressions having a matching cve tag. For use with the OWASP `dependency-check` tool. More details: https://jeremylong.github.io/DependencyCheck/general/suppression.html.