LuaLS / LuaLS/lua-language-server

Defining optional globals doesn't trigger nil check warning

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

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

主要言語
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?

Type Checking

Expected Behaviour

I have some code that runs in different environments that have different global variables available.

For example, environment1 may have a global table C_GameRules available with a function in it. environment2 does not have the global available.

I'm trying to write a meta file that makes this optional nature of this global available:

---@meta

---@type table?
C_GameRules = nil

---@return boolean
function C_GameRules.IsHardcoreActive() end

I've also tried to define a class, no change in behavior

Actual Behaviour

C_GameRules.IsHardcoreActive() does not trigger a need-nil-check warning, but the type of C_GameRules gets shown as table?

Reproduction steps

see above

Additional Notes

i don't want the inner field as nilable, environment 1 has "C_GameRules" as global available and the function is guaranteed to be in there, environment 2 has the global set to nil

Log File

No response

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

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

はじめの一歩

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

調査の方向性

示されている Lua メタファイル宣言を使用して Visual Studio Code Extension で報告を再現し、C_GameRules.IsHardcoreActive() の型チェック診断を確認します。オプショナルなグローバルが nil チェック警告を生成し、その内部関数は引き続き nil 不可のままであれば完了です。

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

評価

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

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

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