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 #300

Closed
Tracked by #56688
munificent opened this issue Sep 10, 2024 · 1 comment
Closed
Tracked by #56688

Please start passing in a language version to dart_style #300

munificent opened this issue Sep 10, 2024 · 1 comment

Comments

@munificent
Copy link
Member

Greetings web 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 call that I think is relevant is:

web/tool/generator/dart_main.dart:
   47:   return DartFormatter(experimentFlags: [inlineClassExperimentFlag])

Thank you!

@srujzs
Copy link
Contributor

srujzs commented Sep 24, 2024

Thought I closed this, but this has landed. Thanks for the clear steps!

@srujzs srujzs closed this as completed Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants