LuaLS / LuaLS/lua-language-server

@see attribute and lua:// links not exposed in exported json

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

Ninguém assumiu esta issue ainda.

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

Descrição

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

Visual Studio Code Extension (sumneko.lua)

### Which OS are you using?

Linux

### What is the issue affecting?

Other

### Expected Behaviour

`@see` attribute data and `lua://` links are written to the exported json documentation. Preferably being easily readable and containing the raw data to enable linking between different parts of a generated html documentation site.

### Actual Behaviour

The `@see` attribute and `lua://` links are transformed to raw markdown links that link directly to the source code using an absolute path.

### Reproduction steps

1. Make a new lua file.
2. Add two functions:
```lua
function foo() end
--- @see foo
--- This function links to [`foo`](lua://foo)
function bar() end
```
3. Export the documentation to json
4. Observe the attribute and markdown link having been replaced with:
```md
[`foo`]({path}#{location})
See: [foo]({path}#{location})
```

### Additional Notes

I have been working on definition files for CC:T, and having been using the `@see` attribute and `lua://` links as equivalents for the current links on https://tweaked.cc .
However, after trying to actually export the declarations, I've noticed that all links point directly towards absolute paths on disk. This is fine (or even needed) for editors to work, but it's undesirable for markdown output, and even worse for json.
If this method of exporting is intended to allow for things like generating static html pages, this information should be exposed better to allow for this.

### Log File

_No response_

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

Reproduza o problema definindo foo e bar com os exemplos mostrados de @see e lua:// e, em seguida, exporte a documentação para JSON. Inspecione o caminho de exportação que converte esses links em caminhos de origem absolutos. O trabalho estará concluído quando o JSON preservar dados @see legíveis e informações brutas dos links lua:// adequadas para a criação de links no HTML gerado.

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

Avaliação

Stack de tecnologia
lua
Domínio
documentation
Tipo de issue
Bug
Dificuldade
4/5
Tempo estimado
3-5 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

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