LuaLS / LuaLS/lua-language-server
Add a shortcut annotation for adding a `nil,string` return type to functions (`@error`)
オープン
まだ誰も着手していません。
- 主要言語
- Lua
- スター
- 4.4k
- フォーク
- 442
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Returning of errors from Lua functions is often done by returning nil + error message (nil,string):
---@return table
---@overload fun(): nil, string
local function doSomething()
but this syntax can get complex when function takes parameters, or has other overloads. An old solution from LDoc was to use a @error annotation - I propose to add something similar to LuaLS.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
このペイロードでは LuaLS のファイル、テスト、エントリポイントが指定されていないため、まずリンク先の LDoc マニュアルで @error の動作を読み、LuaLS のアノテーション解析と戻り値の型処理の場所を特定してください。Done では、パラメーター化された関数および他のオーバーロードを持つ関数に対して、@error が nil,string の戻り値をどのように表現するかを定義し、テストする必要があります。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- lua
- 領域
- devtools
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 30/100