Repository navigation
code health: enum_string_switch advisory - #668
Merged
Merged
Conversation
…ing switches A switch over Enum::VALUE cases whose every case returns a string literal should use EnumStringMap<T>; it slipped through in fork #667 (screen_event_name, warp_fade_name).
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.
A hand-written enum-to-string switch (screen_event_name, warp_fade_name in #667) slipped through review. This adds an advisory
enum_string_switchto review_rules.py: on added lines, a switch overEnum::VALUEcases whose every case returns a string literal is reported with a pointer toEnumStringMap<T>; the reverse direction is not checked. Tested with the code_health self-tests (one hit, one miss), on #667's ScreenEvents.cpp at 5ce86af (both functions fire, fade_events does not) and over origin/main (0 hits; int switches like HttpServer's status names are skipped).