LuaLS / LuaLS/lua-language-server

@overload does not cooperate with @alias

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

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

enhancement feat/LuaCats Annotations
主要言語
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?

Windows

What is the issue affecting?

Annotations, Diagnostics/Syntax Checking

Expected Behaviour

When I define an @alias, an @overload command should be able to use it.

Actual Behaviour

I receive the error:

`fun` expected. Lua Syntax Check.(luadoc-miss-fun-after-overload)
Reproduction steps
---@alias what fun():"ok"

---@class huh
---@overload what
local huh = {}

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

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

はじめの一歩

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

調査の方向性

@alias と @overload の Lua ドキュメントアノテーション処理から始め、issue 内の再現例を最初に実行するケースとして使います。@overload が診断 luadoc-miss-fun-after-overload を生成する理由を追跡します。alias ベースの overload がその診断なしで受け入れられ、既存の overload 構文も引き続き有効であれば完了です。

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

評価

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

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

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