LuaLS / LuaLS/lua-language-server

[Feature Request] @alias hover description / search for description

オープン
#2,436 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Lua
スター
4.4k
フォーク
442
PR マージ指標
30日以内にマージされた PR はありません

説明

It would be really nice, to have a popup, when hovering over a @alias.

---@alias DeviceSide
---| '"left"' # The left side of the device
---| '"right"' # The right side of the device
---| '"top"' # The top side of the device
---| '"bottom"' # The bottom side of the device
---| '"front"' # The front side of the device
---| '"back"' # The back side of the device

---@param side DeviceSide
local function checkSide(side) end

Hover description
eg:

checkSide("left")

when hovering over "left", display a popup with the text: The left side of the device

Search for description
When beginning to type:

checkSide(left side

it would be great, if the IntelliSense would show the entry "left" -- The left side of the device

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、language server が @alias 宣言、ホバー情報、IntelliSense の検索候補をどのように処理するかを追跡します。DeviceSide の例を再現し、"left" にホバーしたときと "left side" を検索したときの既存の経路をたどります。エイリアスエントリについて、ホバーポップアップと説明ベースの候補の両方が機能すれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
lua
領域
devtools
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。