LuaLS / LuaLS/lua-language-server
String should be sanitized on hover
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?
Visual Studio Code Extension (sumneko.lua)
Which OS are you using?
Linux
What is the issue affecting?
Hover
Expected Behaviour
Consider the following code:
s = "one\ntwo\nthree"
When hovering over it, I'd expect to see the newline characters just as I wrote them in.
Actual Behaviour
Instead, the newlines and tabs would get "expanded", breaking the way the hover looks.
Reproduction steps
- Create a string variable with newline (\n) or tab characters (\t)
- hover over the variable
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
Reproduce the issue by creating a Lua string containing newline or tab characters and hovering over the variable in the Visual Studio Code extension. Start at the language server's hover handling and trace how the string is formatted; done means the hover preserves the intended escaped characters without breaking its layout.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua, vscode
- Domain
- devtools
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100