LuaLS / LuaLS/lua-language-server
Add the ability to annotate exceptions @raises
Open
Nobody has claimed this yet.
enhancement
feat/LuaCats Annotations
- Dominant language
- Lua
- Stars
- 4.4k
- Forks
- 442
- PR merge metrics
- No merged PRs in 30d
Description
Hello! I have a suggestion to add a new annotation - @raises
I think it would be useful to anyone who has a layer of error classes in their module.
**Example:**
```lua
--- @class NetworkError: cdata
--- @field code number
--- @field body number
--- @raises
---| NetworkError
function some_func() end
```
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
The issue names no files or tests. Start by reviewing how existing annotations are parsed and validated, then determine the intended behavior for @raises and the NetworkError example. Done should mean the annotation is recognized and its declared exception type is handled consistently.
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
- Needs clarification
- Newbie friendliness
- 32/100