Allow disabling formatting for a region of code. #1522
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
There are only a few selection test files, and there were a couple of tiles in top_level/ that didn't really have to do with top-level code and were just in there for lack of a better home. I'm about to add tests for disabling formatting, so I figured it makes sense to have an "other" directory for all of these tests. This commit just creates that directory and moves the existing tests there.
There are two special line comments: ``` // dart format off // dart format on ``` Any code between those keeps its original formatting completely, including indentation. It just splats the original unformatted code into the output.
|
Drive-by suggestion: the analyzer offers a few "warnings" for other machine-meaningful comments (mostly |
kallentu
approved these changes
Aug 13, 2024
natebosch
approved these changes
Aug 13, 2024
# Conflicts: # CHANGELOG.md
Co-authored-by: Nate Bosch <nbosch@google.com>
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.
Allow disabling formatting for a region of code.
There are two special line comments:
Any code between those keeps its original formatting completely, including indentation. It just splats the original unformatted code into the output.
Users can have as many of those pairs of comments as they want and formatting is disabled in them. The comments do not nest.
I didn't update the docs or CHANGELOG because this feature only works in the new tall style which is still behind an experiment flag. When it ships, I'll update the docs.
Fix #361.