LuaLS / LuaLS/lua-language-server

Is it possible to annotate nodiscard for fields of a class?

Ouverte
#2,434 0 commentaires 2 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?

Annotations

### Expected Behaviour

I hope there is a way to annotate that a `field` of a `class` is a `@nodiscard` `function`.

### Actual Behaviour

currently there is no way to annotate that a `field` of a `class` is `@nodiscard`

### Reproduction steps

1. Go to your code editor and write a class, for example:
```lua
---@class Item
---@field getPosition fun(self: Item): table
Item = {}
```

2. Try annotate getPosition `field` as `@nodiscard`

### Additional Notes

_No response_

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

Commencez par retracer la façon dont le language server analyse et applique les annotations @class et @field, puis comparez ce chemin avec sa gestion existante de @nodiscard. Définissez la syntaxe d’annotation pour un champ de classe dont le type est une fonction, et vérifiez que les résultats inutilisés de ce champ produisent le diagnostic attendu.

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

Recevez les nouvelles issues par e-mail

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