LuaLS / LuaLS/lua-language-server

Go to definition goes to ---@field instead of source

Open
#2,684 0 comments 1 reaction 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?

Other

Expected Behaviour

I expect the go to definition to go to the actual definition of the function

Actual Behaviour

Instead, in the case of using metatables and classes, it brings me to the ---@field definition (found twice btw)
image

Reproduction steps
  1. Write a code that calls a function for your metatable
  2. CTRL + Click the function call
  3. See result
Additional Notes

No response

Log File

No response

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

Start by reproducing the issue in the Visual Studio Code extension on Windows with a metatable or class that calls a function, then use Ctrl+Click on the call. Compare the navigation target with the actual function definition and confirm that completion lands there rather than on the duplicated ---@field definition.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 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.