LuaLS / LuaLS/lua-language-server
Type checking does not work at all with `` (backtick) literals
Personne n'a encore pris cette issue.
- Langage dominant
- Lua
- Étoiles
- 4.4k
- Forks
- 442
- Métriques de merge des PR
- Aucune PR mergée en 30 j
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
A = 1
B = 2
---@type `A`
local foo = A -- this should be fine
---@type `A`
local bar = B -- but this should give a type error
---@type `A`
local baz = 1 -- ideally, so should this (because you didn't use the literal name "A")
---@type `A`|string
local var = A -- this should be fine
Actual Behaviour
A = 1
B = 2
---@type `A`
local foo = -- A is correctly the only autocomplete suggestion
---@type `A`
local bar = 3 -- but this does not give any type error
---@param a `A`
function f(a) end
local baz = f("Hello") -- nor does this
---@type `A`|string
local var = A --[[Cannot assign `integer` to `string|`A``.
- `integer` cannot match `string|`A``
- Type `integer` cannot match `string`
- Type `number` cannot match `string`
Lua Diagnostics.(assign-type-mismatch)
]]
Reproduction steps
- Extension version v3.9.3
Additional Notes
This is important for things like
A = 1
B = 2
---@alias Enum `A`|`B`
("enums" without tables) to be type checked, like in the "Literal Custom Type" example of https://luals.github.io/wiki/annotations/#alias
I experimented for a bit trying to fix the problem, but I can't quite find where the problem lies. All I know is that the backtick literals aren't being interpreted as types for the purposes of type checking.
In any case, here are some tests for test/diagnostics/assign-type-mismatch.lua to make sure it's fixed:
TEST [[
local A = "Hello"
local B = 2
---@type `A`
local x = A
---@type `B`
local y = B
]]
TEST [[
local A = "Hello"
---@alias myLiteralAliases `A` | integer
---@type myLiteralAliases
local x = A
---@type myLiteralAliases
local y = 3
]]
TEST [[
local B = 2
---@alias myLiteralAliases `B` | string
---@type myLiteralAliases
local x = B
---@type myLiteralAliases
local y = "Hello"
]]
TEST [[
local A = "Hello"
local B = 2
---@alias myLiteralAliases `A`|`B`
---@type myLiteralAliases
--local x = A
---@type myLiteralAliases
--local y = B
]]
TEST [[
local A = "Hello"
local B = "World"
---@alias myLiteralAliases `A`|`B`
---@type myLiteralAliases
--local <!x!> = 1
---@type myLiteralAliases
--local <!y!> = "A"
]]
TEST [[
local A = 1
local B = 2
---@alias myLiteralAliases `A`|`B`
---@type myLiteralAliases
--local <!x!> = "A"
]]
and if we want to disallow the value (only allowing the actual symbol):
TEST [[
local A = "Hello"
---@type `A`
local <!x!> = "Hello"
]]
TEST [[
local A = "Hello"
---@alias myLiteralAliases `A` | integer
---@type myLiteralAliases
local <!x!> = "Hello"
]]
TEST [[
local A = "Hello"
local B = "World"
---@alias myLiteralAliases `A`|`B`
---@type myLiteralAliases
local <!x!> = "Hello"
]]
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par les cas de reproduction dans test/diagnostics/assign-type-mismatch.lua et exécutez ce test de diagnostic. Suivez la manière dont les littéraux avec backticks sont traités lors de la vérification des types, puis faites en sorte que les affectations valides et invalides listées produisent les diagnostics attendus, y compris les alias de littéraux.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- lua
- Domaine
- devtools
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 55/100