LuaLS / LuaLS/lua-language-server

Suggestion: Make `@param;@return` available as code action

Ouverte
#2,517 0 commentaires 3 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

One really nice feature of the lua-lsp is that by typing --- above a function, we get the @param;@return suggestions which auto-inserts function annotation.

Would it be possible to make this feature available via code action as well? Right now, it takes a bit of repetitive work to get the annotations inserted. When at the function head: up, -. -, -, enter. By using a code action, this could be reduced to one hotkey (and depending on your editor, maybe one extra enter).

Another benefit would be that making this available as code action would increase the discoverability of this feature. For a while, I didn't know that this very useful feature even existed. By being a code action, it would be far easier to discover for new users.

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 les suggestions existantes déclenchées par --- qui insèrent des annotations @param et @return, puis examinez où le serveur de langage expose les actions de code. C’est terminé lorsque la même insertion d’annotations est disponible via une action de code et reste détectable au niveau de l’en-tête d’une fonction.

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é
3/5
Temps estimé
1-2 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.