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

Bumped up Dart min version to 3.0.0 for json_serializable #20493

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

al-kimmel-serj
Copy link

Bumped up Dart min version to 3.0.0 for json_serializable, because json_serializable requires Dart 3.5 since 6.9.0.

Error out about bump up Dart version has been added to json_serializable release 6.9.3

@jaumard @josh-burton @amondnet @sbu-WBT @kuhnroyal @agilob @ahmednfwela, could you review my PR?

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328
Copy link
Member

wing328 commented Jan 17, 2025

thanks for the PR

please follow step 3 to update the samples.

…on_serializable requires Dart 3.5 since 6.9.0
@al-kimmel-serj
Copy link
Author

thanks for the PR

please follow step 3 to update the samples.

@wing328, thank you. I've updated samples in PR.

@@ -4,7 +4,7 @@ description: OpenAPI API client
homepage: homepage

environment:
sdk: '>=2.17.0 <4.0.0'
sdk: '>=3.0.0 <4.0.0'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the PR

does it mean the output (dart API client) no longer work with Dart 2.x?

Copy link
Author

@al-kimmel-serj al-kimmel-serj Jan 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. I use json_serializable as serializationLibrary and I see error when I try to generate code via dart run build_runner build with json_serializable:6.9.0. Here is example of error:

line 18, column 30 of .: Expected to find ')'.
   ╷
18 │         if (instance.message case final value?) 'message': value,
   │                              ^^^^
   ╵

json_serializable generates code with case clauses in if statements since 6.9.0.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about adding an option supportDart2 (default to false) for backward compatibility?

we can't ship a change that breaks all Dart 2.x users.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. I will add the option to PR.

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

Successfully merging this pull request may close these issues.

2 participants