LuaLS / LuaLS/lua-language-server

[Feature Request] @alias hover description / search for description

Open
#2,436 0 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

It would be really nice, to have a popup, when hovering over a `@alias`.

```
---@alias DeviceSide
---| '"left"' # The left side of the device
---| '"right"' # The right side of the device
---| '"top"' # The top side of the device
---| '"bottom"' # The bottom side of the device
---| '"front"' # The front side of the device
---| '"back"' # The back side of the device

---@param side DeviceSide
local function checkSide(side) end
```

**Hover description**
eg:
```
checkSide("left")
```
when hovering over "left", display a popup with the text: `The left side of the device`

**Search for description**
When beginning to type:
```
checkSide(left side
```

it would be great, if the IntelliSense would show the entry `"left" -- The left side of the device`

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 tracing how the language server handles @alias declarations, hover information, and IntelliSense search suggestions. Reproduce the DeviceSide example and follow the existing paths for hovering over "left" and searching for "left side". Done means both the hover popup and description-based suggestion work for alias entries.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.