Generate enum method results - #297
Merged
Merged
Conversation
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.
If an enum has methods like
label()ordescription(), Wayfinder now calls them for each case at generation time and writes the results to a companion constant.It's keyed by case value rather than case name, so a value coming back from the server works as the lookup key:
OrderStatusMeta[post.status].label.Only methods with no required arguments get called. Static, magic, protected and private methods are skipped, along with anything returning
voidornever. Strings, numbers, booleans, null, arrays, backed enums,JsonSerializable,ArrayableandStringableall convert; anything else is dropped. If a method throws for a single case, only that case loses the entry.Nothing existing changes shape. The case constants, the enum object and the
App.Enums.*union types are untouched, and no companion constant is emitted for an enum with no eligible methods.Since this runs your code at generation time it's off by default, behind
WAYFINDER_GENERATE_ENUM_METHODS. Worth knowing that alabel()returning__('post.draft')bakes in whichever locale the command ran under.