LuaLS / LuaLS/lua-language-server
Alias doesn't handle `#` character in string
Open
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?
NeoVim
Which OS are you using?
Linux
What is the issue affecting?
Diagnostics/Syntax Checking
Expected Behaviour
Enum members can contain # character
Actual Behaviour
The LSP diagnostic reports an error on using it
Reproduction steps
- Create an enum alias with members containing
#
Given the following alias
---| "/vfx#impact_fx_creator"
---| "/sfx"
---| "/player#player_upgrader"
---| "/cauli"
---| "/game_over_ui"
---| "/in_game_ui"
- Notice that the type check considers the right-hand of
#as a comment even though it's in the string
---@type component_url
local d = "/vfx#impact_fx_creator"
- See error
Diagnostics:
1. Cannot assign `string` to parameter `"/cauli"|"/game_over_ui"|"/in_game_ui"|"/player#"|"/sfx"...(+1)`.
- `string` cannot match `"/cauli"|"/game_over_ui"|"/in_game_ui"|"/player#"|"/sfx"...(+1)`
Additional Notes
No response
Log File
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the enum-alias example from the issue in the Lua language server with the reported NeoVim setup, focusing on how # is parsed inside quoted members during diagnostics. Done means the full strings containing # remain enum members and the shown assignment no longer produces the reported type-check error.
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
- 35/100