LuaLS / LuaLS/lua-language-server

Request: Support `@field` in both enum and table definitions.

Ouverte
#2,960 8 commentaires 0 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

Request: Allow adding a field type to tables and enum definitions using the @field annotation.

This is useful for generating meta files from C code where there is no Lua table literal to copy.

See current behaviour below:

@class

✅ Using @field
---@class Foo
---@field myField 5
Foo = {}
✅ Using literal code
---@class Foo
Foo = {
  myField = 5,
}
✅ Using type annotation
---@class Foo
Foo = {
  ---@type 5
  myField = nil,
}

@enum

❌ Using field
---@enum Foo
---@field myField 5
Foo = {}

Error: The field must be defined after the class.Lua Diagnostics.(doc-field-no-class)

✅ Using literal code
---@enum Foo
Foo = {
  myField = 5,
}
✅ Using type annotation
---@enum Foo
Foo = {
  ---@type 5
  myField = nil,
}

Untyped table

❌ Using field
---@field myField 5
Foo = {}

Error: The field must be defined after the class.Lua Diagnostics.(doc-field-no-class)

✅ Using literal code
Foo = {
  myField = 5,
}
✅ Using type annotation
Foo = {
  ---@type 5
  myField = nil,
}

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

Commencez par suivre le traitement de @field associé au diagnostic doc-field-no-class ; l'issue fournit des exemples Lua pour @class, @enum et les tables non typées. C'est terminé lorsque les définitions de @field fonctionnent pour des définitions d'enum et de table comme dans les exemples sans ce diagnostic, tout en conservant la prise en charge du comportement existant des classes.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
lua
Domaine
devtools
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

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