Skip to content

Widening cast has no effect #2215

Open
Open
@curiosity-a

Description

@curiosity-a

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Linux

What is the issue affecting?

Annotations, Type Checking, Hover

Expected Behaviour

Cast unconditionally overwrites the variable's type with the new type.

Actual Behaviour

Cast is ignored and in some cases causes additional type check errors.

Reproduction steps

---@param str string
local function foo(str)
    ---@cast str +?
    if str == '' then str = nil end
end

Note how it produces an error on assignment:

This variable is defined as type `string`. Cannot convert its type to `nil`.
- `nil` cannot match `string`
- Type `nil` cannot match `string` Lua Diagnostics.(cast-local-type)

Note also that the tooltip for str in the comparison says correctly that it is a string?. But this has no observable effect on the actual type.

Example two (attempted workaround):

---@param str string
local function foo(str)
    ---@cast str string?
    if str == '' then str = nil end
end

Note how the cast causes a type check error now, which makes no sense.

Example three (from the wiki on cast, modified to actually verify that the cast worked):

---@type integer
local x

---@cast x +boolean
x = false

Note how it produces an error, similarly to the first example. You would expect at least the example from the official documentation itself to work, but it doesn't. This leads me to conclude this is a bug.

Additional Notes

No response

Log File

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions