Fix formatting of String Array literals containing right parens #4297
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
This fixes a bug where the formatter will automatically replace the
String Array literal tokens with parens regardless of whether the content
already contains a `)`. In the case where a `)` already exists, the
resultant code is not compilable. This patch keeps the author's original
choice of token if a `)` exists in the content, as they made a conscious
decision to choose that alternate token so that the code can compile.
Otherwise, the formatter will choose parens for code consistency as was
done previously.
For example,
```
%w{
one)
two)
}
```
would have previously had the curly braces replaced with parens, which
would no longer compile. Now, it will stay with curly braces, and be
properly formatted.
|
@Fryguy Thanks! The formatter always used |
|
@asterite Thanks! Very interesting. I had assumed the Crystal core team chose parens as the default style since the formatter is opinionated (I actually prefer if the formatter is more opinionated...one less thing to bikeshed about) |
|
@Fryguy The formatter is opinionated regarding whitespace, but it never changes visible user input. For example |
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 fixes a bug where the formatter will automatically replace the
String Array literal tokens with parens regardless of whether the content
already contains a
). In the case where a)already exists, theresultant code is not compilable. This patch keeps the author's original
choice of token if a
)exists in the content, as they made a consciousdecision to choose that alternate token so that the code can compile.
Otherwise, the formatter will choose parens for code consistency as was
done previously.
For example,
would have previously had the curly braces replaced with parens, which
would no longer compile. Now, it will stay with curly braces, and be
properly formatted.