LuaLS / LuaLS/lua-language-server

When defining global variable using `---@class _G` + `---@field`, no autocompletion in `_G.*` for those injected fields

Ouverte
#2,714 1 commentaire 5 réactions 0 personnes assignées Voir sur GitHub

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?

Completion

Expected Behaviour

The _G class is defined in extension's basic.lua, representing the global vairable. I expected the following should merge the defined fields into the global variable.

---@class _G
---@field player_min integer
---@field player_max integer

print(p--[[should have autocompletion]])
print(_G.p--[[should have autocompletion]])
Actual Behaviour

LuaLs recognized the injected field in the hover preview of _G, however no autocompletion for those fields are provided, unless I write _G._G.*.

---@class _G
---@field player_min integer
---@field player_max integer

print(p--[[no autocompletion]])
print(_G.p--[[no autocompletion]])
print(_G._G.p--[[!!! has autocompletion !!!]])
Reproduction steps

Use the code snippet provided above.

Additional Notes

LuaLS actually recognized the injected fields in the hover preview of _G, just the autocompletion is not working as expected.
image

Meanwhile the workaround is the use ---@type annotation for global variable. However as discussed here, unless the global variable is of table type, otherwise any default value assigned to it will be misleading as the global variable may not be a const.

Log File

No response

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Reproduisez le comportement de complétion dans l’extension Visual Studio Code à l’aide de l’extrait Lua fourni, puis examinez la définition de basic.lua pour _G et le chemin de complétion. Le travail est considéré comme terminé lorsque les champs déclarés avec @field sur _G apparaissent à la fois dans la complétion globale et dans la complétion _G., sans nécessiter _G._G..

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é
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
38/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.