Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Please start passing in a language version to dart_style #3871

Closed
Tracked by #56688
munificent opened this issue Sep 10, 2024 · 0 comments · Fixed by #3875
Closed
Tracked by #56688

Please start passing in a language version to dart_style #3871

munificent opened this issue Sep 10, 2024 · 0 comments · Fixed by #3875
Assignees
Labels
P2 A bug or feature request we're likely to work on type-infra A repository infrastructure change or enhancement

Comments

@munificent
Copy link
Member

Greetings dartdoc team friends!

The formatter is moving to being language version aware. This means that when it's parsing some code, it needs to be told what language version to parse it as. The DartFormatter constructor now takes an optional parameter where you can pass in the language version. In a future version of dart_style, that parameter will become mandatory.

If you own code that uses dart_style as a library, you should update your code to pass in a language version. To migrate:

  1. Update your constraint on dart_style to ^2.3.7. That's the version where the new parameter was added.

  2. If you know the precise language version the code should be parsed as, then pass in that version (as an instance of the pub_semver package's Version class). This is what "real" tools should do.

    For simple one-off scripts and other utilities where precise behavior doesn't matter much, you can pass in DartFormatter.latestLanguageVersion to unconditionally parse the code as the latest language version that the formatter itself supports.

When the --tall-style experiment flag ships, the passed in language version will also be used to determine whether you get the current formatting style or the new "tall" style.

The constructor calls that I think are relevant are:

dartdoc/tool/mustachio/codegen_aot_compiler.dart:
   63:   return DartFormatter().format('''

dartdoc/tool/mustachio/codegen_runtime_renderer.dart:
   32:   return DartFormatter().format(raw);

Thank you!

@srawlins srawlins added P2 A bug or feature request we're likely to work on type-infra A repository infrastructure change or enhancement labels Sep 10, 2024
@srawlins srawlins self-assigned this Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P2 A bug or feature request we're likely to work on type-infra A repository infrastructure change or enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants