Add MarkerMode to select a MarkerPrinter
#4799
Draft
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
Instead of having to redefine MarkerPrinter everywhere we have a few standard `MarkerPrinter`s that can be used. There is a new diff method that uses the enum to select the right marker printer.
rewrite-core/src/main/java/org/openrewrite/PrintOutputCapture.java
Outdated
Show resolved
Hide resolved
knutwannheden
approved these changes
Dec 19, 2024
jkschneider
requested changes
Dec 25, 2024
|
|
||
| @Incubating(since = "8.41.4") | ||
| @RequiredArgsConstructor | ||
| enum MarkerMode { |
There was a problem hiding this comment.
I know naming is hard, but I don't love the name. I think there is a similar design concept in java.nio.charset. There is a Charset abstract class and a separate top level class called StandardCharsets. I think a top level StandardMarkerPrinters might be a slightly better design.
jkschneider
reviewed
Dec 26, 2024
| } | ||
|
|
||
| public String diff(@Nullable Path relativeTo, PrintOutputCapture.@Nullable MarkerPrinter markerPrinter) { | ||
| return diff(relativeTo, markerPrinter, false); | ||
| } | ||
|
|
||
| @Incubating(since = "8.41.4") |
There was a problem hiding this comment.
If we move this StandardMarkerPrinters then we don't need to add these overloads. Indeed I would prefer we don't add more overload variations here unless absolutely necessary. Every new overload is one more item in the IDE autocomplete list.
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.
Instead of having to redefine
MarkerPrintereverywhere we have a few standardMarkerPrinters that can be used. There is a new diff method that uses the enum to select the right marker printer.What's changed?
Add
MarkerModeand defineMarkerPrintersWhat's your motivation?
Reuse
Anything in particular you'd like reviewers to focus on?
the set of marker printers
Anyone you would like to review specifically?
@knutwannheden
Have you considered any alternatives or workarounds?
Not doing this
Any additional context
No