LuaLS / LuaLS/lua-language-server

feature request: markdown field support in aliases

Aberta
#2,259 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

enhancement
Linguagem predominante
Lua
Estrelas
4.4k
Forks
442
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

Currently, when writing an alias such as:
```lua
---@alias fontmeta.alias.NameTableFormat
---| 0 # Always 0 for TrueType, OpenType accept it as well. See [OpenType Name Table Version 0](https://learn.microsoft.com/en-us/typography/opentype/spec/name#naming-table-version-0).
---| 1 # Can only be 1 for OpenType. See [OpenType Name Table Version 1](https://learn.microsoft.com/en-us/typography/opentype/spec/name#naming-table-version-1).
---| integer
```

The markdown of the description text (after the `#`) are not parsed as markdown:
![image](https://github.com/LuaLS/lua-language-server/assets/38175840/92be85a0-81d0-47c3-a260-66754d05b4d3)

Would be neat if the alias was parsed as multiple tags, similar to how it is done with arguments:
(the `data` argument)
![image](https://github.com/LuaLS/lua-language-server/assets/38175840/e6d5fab2-c1a1-41a6-aca0-638d51774a3c)

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

A issue não nomeia arquivos nem testes. Comece rastreando o parsing de aliases e compare-o com o tratamento existente de Markdown de argumentos/dados descrito no relatório; considera-se concluído quando o Markdown nas descrições de aliases é renderizado de forma consistente com as descrições de argumentos.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
lua
Domínio
devtools
Tipo de issue
Funcionalidade
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
42/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.