Only add dart format width comment on format #733
Conversation
Closes #724 A use case with a custom `formatCode` callback can reasonably use a different line width than the default, so only add the width comment when this package is responsible for performing a format. Uses with a custom header will no longer slot the width comment in following the header. Some outputs will no longer have the comment. This is not breaking since there has been no published since the comment was introduced.
Files using the shared part builder will need to resolve format width conflicts using some other mechanism. A shared part file can have outputs contributed from different code generators that are unrelated, and may have different behavior around formatting, so it is not possible to write a single width comment that applies to the combined file.
|
So the idea here is that we don't have a good way to extract the style info from analysis_options, so we're just going to hard-wire? |
Yes. It is not guaranteed that the configuration is in a file that we make readable during builds. |
|
@natebosch, EDIT: Anyway, it could make sense to change the recognition in GitHub Linguist, as that's the tool outside of the Dart ecosystem. However, this change might have affected other tools, not just GitHub Linguist. What are your thoughts? |
|
I'm not sure what it would take to change the ecosystem to allow the comment on the second line. If we need to reorder the lines we either need a breaking change to the signature of the callback (we'd need to pass the header and body separately to put the line width comment between them) or we can do something hacky and hardcode support for the generate content line specifically. I'd lean towards doing the latter so I'll open a PR with that approach, but I haven't fully thought it through and I can't roll out the change. @kevmoo @jakemac53 if you think this is urgent you may want to run with #760 |
|
Thanks for the quick response. For now, I've also opened a request to improve how GitHub Linguist recognizes generated files by looking at the first 3 lines github-linguist/linguist#7448. Like that second idea, I will have a look. |
Closes #724
A use case with a custom
formatCodecallback can reasonably use adifferent line width than the default, so only add the width comment
when this package is responsible for performing a format.
Uses with a custom header will no longer slot the width comment in
following the header.
Some outputs will no longer have the comment. This is not breaking since
there has been no published since the comment was introduced.