LuaLS / LuaLS/lua-language-server

Syntax highlighting issue when using plugin.lua

Open
#1,949 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Formatting, Plugins

### Expected Behaviour

Syntax colouring should be preserved when using plugin.lua transformations

### Actual Behaviour

I'm having an issue with syntax colouring when using plugin.lua, note the colour of the inline `any` annotation.

![image](https://user-images.githubusercontent.com/1103761/221464622-5cad3bdf-f45c-4796-9574-e2a96562cd2c.png)

### Reproduction steps

plugin.lua:

```lua
function OnSetText(uri, text)
if uri == "file:///c%3A/dev/test/annotation_test/any.lua" then
return {{
start = 15,
finish = 18,
text = " --[[@type any]]"
}}
end
```

Source file (note the new line)
```lua
local anything:any
-- new line --
```

### 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

Reproduce the issue with the shown plugin.lua OnSetText transformation and the Lua source containing the inline any annotation, using the Visual Studio Code extension on Windows. Compare syntax colouring before and after the transformation, and consider the issue done when the inline annotation retains the expected colouring after the inserted text and following new line.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.