LuaLS / LuaLS/lua-language-server
@see attribute and lua:// links not exposed in exported json
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Lua
- Estrellas
- 4.4k
- Forks
- 442
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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
- Make a new lua file.
- Add two functions:
function foo() end
--- @see foo
--- This function links to [`foo`](lua://foo)
function bar() end
- Export the documentation to json
- Observe the attribute and markdown link having been replaced with:
[`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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Reproduce el problema definiendo foo y bar con los ejemplos mostrados de @see y lua://, y después exporta la documentación a JSON. Inspecciona la ruta de exportación que convierte estos enlaces en rutas de origen absolutas. La tarea estará terminada cuando el JSON conserve datos @see legibles e información sin procesar de los enlaces lua:// adecuada para crear enlaces en HTML generado.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- lua
- Área
- documentation
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100