LuaLS / LuaLS/lua-language-server

Feature request: Infer overload annotations for subsequent overloads

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

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

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

説明

It would be useful for subsequent function overload definitions to use prior annotations unless a new annotation is provided.

Such as:

---An example function
---@param a integer
---@param b string
---@param c function Some documentation about c
---@return boolean
---@overload fun(c)
---@overload fun(a): nil
function foo(a, b, c) end

being equivalent to

---An example function
---@param a integer
---@param b string
---@param c function Some documentation about c
---@return boolean
function foo(a, b, c) end

---An example function
---@param c function Some documentation about c
---@return boolean
function foo(c)

---An example function
---@param a integer
---@return nil
function foo(a)

With auto-generated documentation this isn't so much of a problem, but it's a bit of a chore when it's something to be done by hand.

Appreciate all the work you've done! This makes writing Lua so much more confident.

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

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

はじめの一歩

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

調査の方向性

issue ではファイルやテストが指定されていません。まず @overload とパラメーター/戻り値アノテーションの処理箇所を見つけ、次に、以前のアノテーションを継承し、overload が新しいアノテーションを指定した場合はそれらで上書きすることを重点的にカバレッジへ追加します。元の定義を変更せず、例の 2 つの overload が文書化された継承アノテーションと明示的なアノテーションを受け取れば完了です。

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

評価

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

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

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