fix: use return_overload annotations in std libs, to fix overload return type inference#1030
Open
EfveZombie wants to merge 1 commit intoEmmyLuaLs:mainfrom
Open
fix: use return_overload annotations in std libs, to fix overload return type inference#1030EfveZombie wants to merge 1 commit intoEmmyLuaLs:mainfrom
EfveZombie wants to merge 1 commit intoEmmyLuaLs:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the Lua standard library annotations by replacing @return tags with @return_overload in global.lua, io.lua, package.lua, and utf8.lua. A review comment points out that package.searchpath was incorrectly modified to return a file object instead of a string, which is a regression from the previous state.
d0e9677 to
e91e316
Compare
…urn type inference for functions like load, io.open, etc.
e91e316 to
d72e6e3
Compare
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.
Summary
Replace
---@return type?patterns with---@return_overloadannotations in standard library definitions, to fix overload return type inference for functions that return either a success value ornil, error_message.Changed files
load,loadstring,loadfileio.open,io.write,file:close,file:flush,file:seek,file:writepackage.searchpathutf8.lenMotivation
The previous
---@return type?annotations merged all return values into a single nullable type, which caused the type checker to lose overload information. By using---@return_overload, each return variant is expressed as a distinct overload, allowing the analyzer to correctly narrow types based on success/failure branches.