LuaLS / LuaLS/lua-language-server
[Annotations] How to set a default value for a function parameter?
Open
Nobody has claimed this yet.
enhancement
feat/LuaCats Annotations
feat/type check
- Dominant language
- Lua
- Stars
- 4.4k
- Forks
- 442
- PR merge metrics
- No merged PRs in 30d
Description
---@param name string
---@param age? number
function addPerson(name, age)
age = age or 18
end
How can I specify that the age parameter is optional and has a default value of 18?
So that in the popup-menu it looks something like this:
function addPerson(name: string [,age = 18: number])
Or
function addPerson(name: string, age = 18: number)
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 tracing how @param annotations are parsed and how function signatures are rendered in the popup menu. Use the addPerson example to investigate whether an optional parameter can express a default value of 18, and consider the work complete when that default is represented in the displayed signature.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100