LuaLS / LuaLS/lua-language-server
Over-zealous 'Field `_field` is protected' warning in class-created closure functions
还没有人认领这个 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?
Diagnostics/Syntax Checking
### Expected Behaviour
Functions created from within class methods should be allowed to access protected (and private) members of that class.
Essentially, any functions inside a class method should inheret that method's access- this is a simple pattern that maintains encapsulation of exactly those private/protected fields, as the code is still clearly "owned" by the encapsulating class.
### Actual Behaviour
In some scenarios, functions within class methods that access protected members of that class are being marked with the 'Field `_field` is protected' warning. See Repro Steps for code sample.
### Reproduction steps
```
---@class DynamicDude
---@field _field string?
local DynamicDude = {}
function DynamicDude:demo()
self:setup(function(self)
-- This disable shouldn't be necessary
---@diagnostic disable-next-line: invisible
self._field = 'test'
end)
---@param self DynamicDude
local function closure(self)
-- This disable shouldn't be necessary
---@diagnostic disable-next-line: invisible
self._field = 'test'
end
self.dynamic_fn = function(self)
self._field = 'test'
end
end
---@param fn fun(self:DynamicDude)
function DynamicDude:setup(fn)
self.dynamic_fn = fn
end
```
### Additional Notes
FEATURE REQUEST: I'd actually love to have a setting that just said "all variables named `self` are assumed to indicate valid access to private/protected members", to cover all my bases. Happy to dig up some examples / explain myself more if that's useful.
### Log File
_No response_
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先在 Visual Studio Code 扩展中复现所提供的 DynamicDude 示例,并检查 diagnostics 如何对在类方法内部创建的 closures 进行分类。当这些 closures 能够访问类的 protected 或 private members 而不会出现不可见的警告,同时无关的访问仍然会被诊断时,即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- lua
- 领域
- devtools
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100