LuaLS / LuaLS/lua-language-server

Annotations with mixins?

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

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

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

説明

Hi I'm trying to make annotations that must require the user to have certain fields in a table as a requirement.

For instance, I want a table that needs to have x,y fields, or certain functions.

Here is some pseudo-code that might explain what I mean:

---@class Spinnable
---@field spin fun()

---@class Positionable
---@field x number
---@field y number
---@field setPos fun(x: number, y: number)

---@generic T : Spinnable, Positionable
---@param p1 `T`
---@return T
local function doFunction(p1) return p1 end

local entity = { x = 5 }          -- A table that is missing the other fields
local check = doFunction(entity) -- I want a warning here saying it doesn't have, `y`, `setPos()`, or `spin()`

Is this currently possible to require certain fields in a table?

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

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

はじめの一歩

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

調査の方向性

まず、issue にある注釈付きの疑似コードを再現し、language server がクラス注釈、ジェネリクス、テーブルフィールドのチェックをどのように処理するかを確認します。doFunction に渡されたときに y、setPos、または spin が欠けているテーブルが診断を生成し、互換性のあるテーブルが受け入れられれば完了です。

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

評価

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

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

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