LuaLS / LuaLS/lua-language-server

Properties (getter/setter) support

Ouverte
#2,874 1 commentaire 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

Lua's variables can act as C#-like properties by setting `__newindex` appropriately.

Getters and setters occasionally have different type signatures. However, the `@field` annotation can only represent one type.

```lua
-- hoge.meta.lua

---@meta

---@class Point
---@field x number
---@field y number
Point = {}

---@class Hoge
---@field position Point ⚠️ actually a property
Hoge = {}

---@return Hoge
function new_hoge() end
```

```lua
-- main.lua

local hoge = new_hoge()
hoge.position = { 3, 7 } -- emits "Missing required fields in type `Point`: `x`, `y`"
print(hoge.position.x) -- 3.0
print(hoge.position.y) -- 7.0
```

(Full sample program is [here](https://codeberg.org/haruomaki/luaproperty))

It should be annotated as "`position`'s setter receives a `table`, and its getter returns a `Point`."

How about adding a new syntax to describe this?

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 les exemples d’annotations dans hoge.meta.lua et main.lua, puis reproduisez le diagnostic pour l’affectation d’une table à hoge.position. L’issue ne mentionne aucun fichier ni test du dépôt ; il faut donc localiser les points d’entrée pertinents pour les annotations et la vérification des types. C’est terminé lorsque la syntaxe d’annotation peut exprimer des types de setter et de getter distincts et que l’affectation d’exemple ne signale plus l’absence de champs Point.

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é
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

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