LuaLS / LuaLS/lua-language-server

[Feature request] Annotation for referring to superclass

Ouverte
#2,490 0 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

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
```

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 examiner les exemples d’annotations et le modèle d’héritage de classic.lua référencés dans l’issue. Déterminez où les annotations des champs de classe sont résolues et définissez le comportement attendu d’une annotation relative à la superclasse pour Object, Animal et Bird ; l’issue ne nomme aucun fichier ni test de LuaLS, les critères d’achèvement doivent donc être établis avant l’implémentation.

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
35/100

Recevez les nouvelles issues par e-mail

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