LuaLS / LuaLS/lua-language-server

[Bug]: Addon Not Working

Open
#1,968 25 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
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?

Annotations, Libraries

Expected Behaviour

The addon's definitions and comments should be displayed.

Actual Behaviour

The library's comments above functions are being displayed.

Reproduction steps
  1. Download and add this for an addon:

  2. Download batteries and place them inside of libraries/batteries:
    image

  3. Add require("libraries.batteries"):export() to the top of your lua file

  4. Hovering :export() shows the library's documented info and not from the addon

Additional Notes

I might have the addon set up incorrectly, but I am genuinely unsure. I've looked at a few of the addon samples and instructions, but can't seem to entirely figure it out properly. My settings.json for the files I'm testing with looks like the following:

{
    "Lua.workspace.library": [
        "G:/GitHub/Lua/batteries/library/batteries"
    ]
}
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 comparing the addon setup with the referenced addon samples and instructions, then reproduce the hover behavior in the VS Code extension using batteries and the shown settings.json configuration. Check whether the addon or library path is being loaded as expected. Done means hovering :export() displays the addon definition and comments rather than the library's documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, vscode
Domain
devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.