chore: api snippet formatting #92
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
dart format and the API snippet parser haver incompatible requirements and I'm trying to satisfy both
The dart format utility keeps munging my api examples file such that it iss incompatible with the API snippet parser, so am using find to gather dart files to format and excluding the snippets explicitly.
anitarua
approved these changes
Jan 11, 2024
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.
The
dart formatcommand is enforcing formatting that isn't compatible with the API snippet parser for the API docs examples file. For the parser, I need all my method declarations to be either one or two lines but not both. The dart formatter wants them to be wrapped contingent on line length so keeps mixing 1- and 2-line signatures in the same file. Thedart formatcommand doesn't use an exclude list likedart analyzeso I'm excluding the file by usingfindinstead of lettingdart formatfind the relevant files itself.