LuaLS / LuaLS/lua-language-server
Class inheriting a generic class with specified type not recognized as inherited class (assign-type-mismatch)
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 4.4k
- Forks
- 442
- PR merge metrics
- No merged PRs in 30d
Description
How are you using the lua-language-server?
Visual Studio Code Extension (sumneko.lua)
Which OS are you using?
Windows
What is the issue affecting?
Type Checking
Expected Behaviour
The type of a class inheriting a generic class (when specifying the type) should be recognized as the same type as the class it inherits.
If that generic class inherits another class, that should also be recognized.
As such, the following code should have no problems.
--- @class Test_Base
--- @field Str_A string
local Test_Base = {}
--- @generic T
--- @class Test_Generic<T> : Test_Base
--- @field Gen_T T
local Test_Generic = {}
--- @class Test_Class : Test_Generic<string>
local Test_Class = {}
--- @type Test_Base[]
local testArray = {
Test_Base,
Test_Generic,
Test_Class,
}
Actual Behaviour
"Test_Class" isn't recognized as either "Test_Generic" or "Test_Base", therefore showing as an "assign-type-mismatch" error.
However, inheriting the generic class without specifying the type is completely fine.
--- @class Test_Base
--- @field Str_A string
local Test_Base = {}
--- @generic T
--- @class Test_Generic<T> : Test_Base
--- @field Gen_T T
local Test_Generic = {}
--- @class Test_Class : Test_Generic
local Test_Class = {}
--- @type Test_Base[]
local testArray = {
Test_Base,
Test_Generic,
Test_Class,
}
Reproduction steps
--- @class Test_Base
--- @field Str_A string
local Test_Base = {}
--- @generic T
--- @class Test_Generic<T> : Test_Base
--- @field Gen_T T
local Test_Generic = {}
--- @class Test_Class1 : Test_Generic<string>
local Test_Class1 = {}
--- @class Test_Class2 : Test_Generic
local Test_Class2 = {}
--- @type Test_Base[]
local testArray = {
Test_Base,
Test_Generic,
Test_Class1,
Test_Class2,
}
Additional Notes
This problem showed up after the release of version 3.17.0
I know that the implementation of generics is complicated, and I've already found a workaround for my use-case by casting the inheriting classes to the type of the underlying base class. But that may not work for others.
Log File
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Lua reproduction in the issue and run it through the Visual Studio Code extension's type checking to observe the assign-type-mismatch diagnostic. Trace generic-class inheritance handling, then verify that Test_Class1 is accepted as both Test_Generic and Test_Base, including the transitive inheritance case, while the existing Test_Class2 behavior remains valid.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100