LuaLS / LuaLS/lua-language-server

Operators are not included in the output when generating documentation via the --doc CLI argument

Ouverte
#3,194 1 commentaire 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

### How are you using the lua-language-server?

Command Line

### Which OS are you using?

Linux

### What is the issue affecting?

Annotations, Other

### Expected Behaviour

When generating markdown and JSON documentation via the command line argument `--doc`, the output files should contain operators defined by the `@operator` syntax.

### Actual Behaviour

The expected behavior is that the operators are missing in both the markdown and JSON generated files.

### Reproduction steps

Given the following Lua file:

```lua
---@meta

---@class Vector2f
---@operator unm:Vector2f
---@operator add(Vector2f | number):Vector2f
---@operator sub(Vector2f | number):Vector2f
Vector2f = {}
```

When the language server is run with the following args:

```
./LuaS/bin/lua-language-server --doc=./example.lua --doc_out_path=.
```

Then the output `doc.md` and `doc.json` do not contain any of the operators specified.

In the `doc.json` the type `Vector2d` is the following, notice the lack of any operators:

```json
{
"defines": [
{
"async": false,
"deprecated": false,
"file": ".",
"finish": [
2,
18
],
"start": [
2,
10
],
"type": "doc.class",
"view": "Vector2f",
"visible": "public"
}
],
"fields": [],
"name": "Vector2f",
"type": "type",
"view": "Vector2f"
}
```

### 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 au point d’entrée CLI `--doc` et suivez la manière dont l’entrée example.lua est convertie en `doc.md` et `doc.json`. Reproduisez le problème avec l’exemple Vector2f fourni, puis vérifiez que les deux fichiers générés contiennent les définitions `@operator`.

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

Évaluation

Stack technique
lua
Domaine
cli, documentation
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

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