Infer correct types from custom include functions #3919
Merged
Conversation
This file contains 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
Udpate settings for lua lanugage server so that it treats VFS.Include as require and correctly types the return value.
1 task
WatchTheFort
approved these changes
Nov 10, 2024
rhys-vdw
changed the title
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.
Work done
Configure lua language server to treat
VFS.Include,includeandshard_includeas aliases ofrequire, meaning that the correct types are applied to the return value.Note that this only affects type inference in IDE and does not have any impact on execution.
Suggested by @saurtron here: #3905 (comment)
Approach advised by lua language server contributor here: LuaLS/lua-language-server#2947
Test steps
VFS.Includeand see that it is correctly typed.Screenshots:
BEFORE:
AFTER: