Fix markdown #8564
Open
Fix markdown #8564
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
cketti
reviewed
Nov 14, 2024
| @@ -40,7 +40,11 @@ fun SpotlessExtension.configureMarkdownCheck( | |||
| targets: List<String>, | |||
| ) { | |||
| format("markdown") { | |||
| prettier() | |||
| prettier("3.3.3").config( | |||
There was a problem hiding this comment.
Is there any evidence that pinning the version to 3.3.3 fixes an issue? If so, we should add a comment explaining why this particular version was picked. If not, I think it's best to avoid explicitly specifying a version.
There was a problem hiding this comment.
Why should we avoid specifying a version?
There was a problem hiding this comment.
Because then we'll have to manage updates ourselves. In practice this probably means we'll keep using this version until spotless drops support for it and we're forced to deal with a potentially massive upgrade. In the meantime we might miss out on improvements we'd otherwise get for free.
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.
This is an attempt to fix the markdown formatting check failure by settings the prettier version explicitly and limit the parser to markdown.