LuaLS / LuaLS/lua-language-server
Alias comments only show for strings and numbers
オープン
まだ誰も着手していません。
- 主要言語
- Lua
- スター
- 4.4k
- フォーク
- 442
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
(Split from: https://github.com/LuaLS/lua-language-server/issues/2279)
Aliases have a feature where they can be multiline and you can write comments for different available values. However, this only works for string and numbers. For example in this code:
---@class TestClass
---@enum TestEnum
TestEnum = {
TEST1 = 1,
TEST2 = 2,
TEST3 = 3,
}
---@alias TestAlias
---| 'TEST1' # TEST1 comment
---| 'TEST2' # TEST2 comment
---| 'TEST3' # TEST3 comment
---| TestClass # TestClass comment
---| TestEnum # TestEnum comment
---| TestEnum.TEST1 # TestEnum.TEST1 comment
---| 1 # TestNumber Comment
---@param test TestAlias
local function test(test)
end
test()
I get this
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Issue にある alias の例を使って LuaLS で報告内容を再現し、次に、文字列値と数値に対する alias コメントがどのように収集され、表示されるかを追跡します。TestClass、TestEnum、TestEnum.TEST1 についても同じ動作を確認します。これらの alias 値に対して、文字列と数値の場合と同様にコメントが表示されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- lua
- 領域
- devtools
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100