LuaLS / LuaLS/lua-language-server

inject-field diagnostics when defining LOVE callbacks.

Open
#2,316 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

Description

### 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, Libraries

### Expected Behaviour

This should be clean.

```lua
local love = require("love")

function love.load() -- no diagnostics here
end
```

### Actual Behaviour

```lua
local love = require("love")

function love.load() -- Fields cannot be injected into the reference of `love` for `load`. To do so, use `---@class` for `love`. (inject-field)
end
```

### Reproduction steps

1. Ensure to have LOVE Definition addon.
2. Create new `main.lua` with content above.

### Additional Notes

LOVE addon `@class` is not defined with `(exact)`.

### Log File

[file_d%3A_Data_Development_love-11.3-win64_inochi2d.log](https://github.com/LuaLS/lua-language-server/files/12561875/file_d.3A_Data_Development_love-11.3-win64_inochi2d.log)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the diagnostic in a new main.lua using the LOVE Definition addon and the shown love.load callback, then review the linked log for context. The work is done when this valid LOVE callback no longer reports an inject-field diagnostic while diagnostics remain available for genuine cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.