LuaLS / LuaLS/lua-language-server

Feature Request: Add constant annotation to show a warning when modifying variables marked as const

Open
#2,054 4 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

Description

Constant modifications can be detected in the editor in advance.

example:
```lua

---@const_type ErrorCode
local errorCode = {}

errorCode.NOT_FOUND = 10 --- show warnings attemp modify constant variables.

```

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 reviewing how LuaLS parses annotations and produces editor diagnostics, then trace the example's local table from its const annotation to the field assignment. Done means a const-marked variable produces a warning when modified, with behavior covered for the shown example.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Feature
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.