fix: escape $unknown in generated enum toJson error message#455
Merged
Carapacik merged 1 commit intoApr 21, 2026
Merged
Conversation
The generated toJson() method for enums produced a string literal '...for $unknown or @jsonvalue(null)...' inside a non-raw Dart string. Dart then interpreted $unknown as variable interpolation of `unknown`, which does not exist in scope, breaking compilation of every generated enum file when enums_to_json: true. Escape the dollar sign in the template so the generated file contains \$unknown (a literal dollar followed by "unknown"), compiling correctly regardless of the unknown_enum_value setting. Fixes Carapacik#454
There was a problem hiding this comment.
Pull request overview
Fixes Dart enum codegen when enums_to_json: true by ensuring the generated toJson() error message contains a literal $unknown (instead of triggering Dart string interpolation that breaks compilation). This addresses issue #454.
Changes:
- Escape the dollar sign in the enum
toJson()template so generated Dart code contains\$unknown. - Update generator golden expectations to match the new escaped output for multiple enum scenarios.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
swagger_parser/lib/src/generator/templates/dart_enum_dto_template.dart |
Updates enum toJson() template to emit \$unknown safely in generated Dart string literals. |
swagger_parser/test/generator/data_classes_test.dart |
Adjusts expected generated enum output to assert the escaped \$unknown text in toJson() error messages. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Carapacik
approved these changes
Apr 21, 2026
This file contains hidden or 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
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 generated toJson() method for enums produced a string literal '...for $unknown or @jsonvalue(null)...' inside a non-raw Dart string. Dart then interpreted $unknown as variable interpolation of
unknown, which does not exist in scope, breaking compilation of every generated enum file when enums_to_json: true.Escape the dollar sign in the template so the generated file contains $unknown (a literal dollar followed by "unknown"), compiling correctly regardless of the unknown_enum_value setting.
Fixes #454