Improve Lua type checking for string enums#5869
Merged
sturnclaw merged 2 commits intopioneerspacesim:masterfrom Jul 18, 2024
Merged
Improve Lua type checking for string enums#5869sturnclaw merged 2 commits intopioneerspacesim:masterfrom
sturnclaw merged 2 commits intopioneerspacesim:masterfrom
Conversation
- Using lua-ls 3.7.0+, any function parameters taking an EnumStrings constant will have full completion and type checking - This provides much stronger validation that a function is receiving a correct string constant
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
1 participant
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.
Lua-LS released a new
@enum (key)annotation in version 3.7.0 which much better supports "string constants" as enum values. Functions which take an EnumStrings constant as a parameter will have full autocompletion for the list of constant values which make up that string enumeration, and the language server will render a diagnostic if an inappropriate enumeration value is used in that function call.Note that at current, the effect of this change is limited to a very small subset of callsites where a) the function being called takes an EnumStrings constant, and b) full type information is available for the object the function is being called on.