LuaLS / LuaLS/lua-language-server

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

未關閉
#3,026 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

主要語言
Lua
星號
4.4k
分支
442
PR 合併指標
30 天內沒有已合併 PR

描述

### 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_

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

透過使用所示的 @see 和 lua:// 範例定義 foo 和 bar 來重現問題,然後將文件匯出為 JSON。檢查將這些連結轉換為絕對來源路徑的匯出路徑。完成的標準是 JSON 保留可讀的 @see 資料,以及適合在產生的 HTML 中建立連結的原始 lua:// 連結資訊。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
lua
領域
documentation
Issue 類型
缺陷
難度
4/5
預估耗時
3-5 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。