LuaLS / LuaLS/lua-language-server

[Feature request] Annotation for referring to superclass

Aperta
#2,490 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Lua
Stelle
4.4k
Fork
442
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

I'm trying to add annotations to [classic](https://github.com/rxi/classic/blob/master/classic.lua), but encounter a few problems when doing so.

For example, the `super` field refers to the superclass. If I were to annotate super like this
```lua
---@class Object
---@field protected super Object
```
then subclasses will have a `super` field, but it will always refer to `Object`, instead of their superclass. The best solution I can come up with the current implementation is to set the `super` field each time a class is created.
```lua
---@class Animal : Object
---@field super Object
local Animal = Object:extend()

---@class Bird : Animal
---@field super Animal
local Bird = Object:extend()
```
This is a repetition of steps, which tells me DRY. I suggest something like a `super` annotation, which always refers to the superclass relative to which class it is being used.
```lua
---@class Object
---@field protected super super

---@class Animal : Object
local Animal = Object:extend()
-- Animal.super refers to Object

---@class Bird: Object
local Bird = Animal:extend()
-- Bird.super refers to Animal
```

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando gli esempi di annotazioni e il modello di ereditarietà di classic.lua citati nell’issue. Determina dove vengono risolte le annotazioni dei campi di classe e definisci come dovrebbe comportarsi un’annotazione relativa alla superclasse per Object, Animal e Bird; l’issue non indica file o test di LuaLS, quindi i criteri di completamento devono essere stabiliti prima dell’implementazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
lua
Ambito
devtools
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.