LuaLS / LuaLS/lua-language-server

Request: Limit "Fields cannot be injected" to exact classes

Đang mở
#3,361 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
Lua
Star
4.4k
Fork
442
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

### How are you using the lua-language-server?

NeoVim

### Which OS are you using?

Windows

### What is the issue affecting?

Annotations

### Expected Behaviour

The [docs say](https://luals.github.io/wiki/annotations/#class):

> Marking the class as (exact) means fields cannot be injected after the definition.

So when I use `@class`, I expect to not get any injection warnings unless I use `(exact)`. I see this came up before in #2710, so I'd add: I should be able to get a warning for injections in exact classes while silencing warnings in non-exact classes.

### Actual Behaviour

Any time I add a field outside of the constructor (and sometimes even ones that are defined in my class constructor), I get this warning:

> Fields cannot be injected into the reference of `ClassX` for `field_y`. To do so, use `---@class` for `instance_z`.

The `@class` annotation makes lua too strict. I'm using lua because I _want_ to be able to inject fields.

Using annotations has multiple effects:
1. It improves completion.
1. It improves symbol lookups like goto definition.
1. It does type checking.

But it's not great that adding annotations to get 1+2 results in tons of warnings from 3.

I understand that people may not want to add `(exact)` all over their codebase, but I don't want to add `---@field [any] any` to all of mine.

I'd propose a change to diagnostic flags to allow independently controlling these two cases:
* `inject-field`: suppress inject field diagnostic for non-exact classes.
* `inject-field-exact`: suppress inject field diagnostic for exact classes.

### Reproduction steps

Using neovim and installed luals with Mason. Version: `pkg:github/luals/lua-language-server@3.17.1`

```lua
-- Stripped-down version of https://github.com/rxi/classic/blob/master/classic.lua with an annotation added to be close to real-world class usage.
--
-- classic
--
-- Copyright (c) 2014, rxi
--
-- This module is free software; you can redistribute it and/or modify it under
-- the terms of the MIT license. See LICENSE for details.

--- @class Object
local Object = {}
Object.__index = Object

function Object:new()
end

function Object:extend()
local cls = {}
for k, v in pairs(self) do
if k:find("__") == 1 then
cls[k] = v
end
end
cls.__index = cls
cls.super = self
setmetatable(cls, self)
return cls
end

function Object:__call(...)
local obj = setmetatable({}, self)
obj:new(...)
return obj
end

-- /end classic

--- @class Item : Object
local Item = Object:extend()

function Item:new(id, category)
self.id = id
self.category = category
self.count = 0
end

function Item:Print()
print("Item", self.id, self.category, self.count)
end

--- @param item Item
function FlagDebugItem(item)
item:Print() -- with the annotation, this completes. Yay!
item.is_cheater = true -- Warning :( "Fields cannot be injected into the reference of `Item` for `is_cheater`."
end
```

If I configure luals to add `inject-field` to the `Lua.diagnostics.disable` list, then the warning goes away. But the warning doesn't come back when I make Item an exact class with this annotation: `--- @class (exact) Item : Object`

**Workaround:** Add a fake field of any type:
```lua
--- @class Item : Object
--- @field [any] any
local Item = Object:extend()
```

### Additional Notes

_No response_

### Log File

```
[WARN][2026-02-23 11:41:41] ...lsp/handlers.lua:564 "More than 100000 files have been scanned. The current scanned directory is `D:\\code\\project\\br`. Please see the [FAQ](https://luals.github.io/wiki/faq/#how-can-i-improve-startup-speeds) to see how you can include fewer files. It is also possible that your [configuration is incorrect](https://luals.github.io/wiki/faq#why-is-the-server-scanning-the-wrong-folder)."
[WARN][2026-02-23 14:32:31] .../lua/vim/lsp.lua:52 "method textDocument/typeDefinition is not supported by any of the servers registered for the current buffer"
[START][2026-02-23 15:29:24] LSP logging initiated
[ERROR][2026-02-23 15:29:24] ...m/lsp/client.lua:620 "LSP[lua_ls]" "Cannot find request with id 125 whilst attempting to cancel"
```

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách chạy bản tái hiện NeoVim được cung cấp với LuaLS 3.17.1 và so sánh `@class` với `@class (exact)`. Sau đó, lần theo cách chẩn đoán `inject-field` được áp dụng; công việc được xem là hoàn tất khi các lớp không exact và exact có thể được điều khiển độc lập như đề xuất, trong khi hành vi hoàn tất và tra cứu được ghi trong tài liệu vẫn khả dụng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
lua
Lĩnh vực
devtools
Loại issue
Tính năng
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
38/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.