LuaLS / LuaLS/lua-language-server

Type narrowing for unioned classes

Ouverte
#2,109 2 commentaires 6 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

enhancement
Langage dominant
Lua
Étoiles
4.4k
Forks
442
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

I have a large number of classes that look something like this:
```lua
---@class Foo
---@field type "foo"
---@field name string
---@field property string
-- more unique fields

---@class Bar
---@field type "bar"
---@field name string
---@field stuff string
-- more unique fields

-- more classes
```

I have a function that takes an array of any of these classes as a parameter, so naturally I've unioned all of the classes.
```lua
---@alias Prototypes
---|Foo
---|Bar
-- all of the other classes

---@param prototypes Prototypes[]
local function extend(prototypes)
-- stuff and things
end
```

However, when I try to make `prototypes` a table literal, I get autocomplete for the other classes because the union operator behaves like intersection instead of union.

![image](https://github.com/LuaLS/lua-language-server/assets/88168191/6ec8340a-2921-4a5d-b781-5f36094b8bdb)

Is there any way to get it to show only the fields of the class indicated by the `type` field? I can't seem to find way to do a proper union of types.
`@type` seems to only work on variables, and even if it did work on table literals, it would be cumbersome to write out the type for every entry in the array.

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 reproduire l’exemple annoté Foo/Bar Prototypes[] de cette issue et examinez le rétrécissement des types union et le comportement de la complétion des littéraux de table du serveur de langage. Le travail est terminé lorsqu’une union discriminée, réduite à l’aide du champ type, ne présente dans la complétion que les champs de la classe sélectionnée, tout en conservant une complétion valide pour les autres membres de l’union.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
lua
Domaine
developer-experience, tooling
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.