LuaLS / LuaLS/lua-language-server

Is it possible to annotate nodiscard for fields of a class?

オープン
#2,434 コメント 0 件 リアクション 2 件 担当者 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?

Annotations

Expected Behaviour

I hope there is a way to annotate that a field of a class is a @nodiscard function.

Actual Behaviour

currently there is no way to annotate that a field of a class is @nodiscard

Reproduction steps
  1. Go to your code editor and write a class, for example:
---@class Item
---@field getPosition fun(self: Item): table
Item = {}
  1. Try annotate getPosition field as @nodiscard
Additional Notes

No response

Log File

No response

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

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

はじめの一歩

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

調査の方向性

まず、language server が @class および @field アノテーションをどのように解析して適用するかを追跡し、その経路を既存の @nodiscard の処理と比較します。型が関数であるクラスフィールドのアノテーション構文を定義し、そのフィールドからの未使用の結果が期待される診断を生成することを確認します。

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

評価

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

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

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