LuaLS / LuaLS/lua-language-server

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

未关闭
#2,434 0 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
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. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先追踪 language server 如何解析和应用 @class 与 @field 注解,然后将这一路径与其现有的 @nodiscard 处理方式进行比较。定义类型为函数的类字段的注解语法,并验证该字段产生的未使用结果会生成预期的诊断信息。

由索引模型根据 Issue 内容生成。

评估

技术栈
lua
领域
devtools
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。