Add PlaintextOnly Option to FindAndReplace Recipe #4277
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…e recipe from executing on non-plaintext files and causing Language specific LST information loss.
timtebeek
reviewed
Jun 20, 2024
rewrite-core/src/main/java/org/openrewrite/text/FindAndReplace.java
Outdated
Show resolved
Hide resolved
rewrite-core/src/main/java/org/openrewrite/text/FindAndReplace.java
Outdated
Show resolved
Hide resolved
timtebeek
added a commit
to openrewrite/rewrite-spring
that referenced
this pull request
Jun 24, 2024
As suggested in - openrewrite/rewrite#4277 - #538
|
Also applied downstream in openrewrite/rewrite-spring@7fb21ed |
crankydillo
pushed a commit
to crankydillo/rewrite
that referenced
this pull request
Jul 11, 2024
* Added a PlaintextOnly property to FindAndReplace recipe to prevent the recipe from executing on non-plaintext files and causing Language specific LST information loss. * Removed constructors
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's changed?
Added a Plaintext Only option to the find and replace recipe, which when enabled, limits the recipe to only act on plaintext files. This option defaults to false.
What's your motivation?
FindAndReplace by default replaces text in for most sourcefile types, which may not be desirable in certain cases since this recipe coverts any sourcefile to a plaintext file, thereby causing information loss for the rest of the recipe run. Enabling this flag limits the recipe scope to plaintext files for cases where a user only wants to replace something thats already parsed as a plaintext file.
For example, this flag could prove useful in this PR where we only want to touch manifest and dockerfiles.