LuaLS / LuaLS/lua-language-server
Add a way of marking a function as overidable
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Lua
- Stars
- 4.4k
- Forks
- 442
- PR merge metrics
- No merged PRs in 30d
Description
Some engines/libraries let user override global functions, but then adding API headers for them gives a "duplicate field" warning.
eg
Header file for engine API:
--- Engine API
global_table = {}
---Overidable function
---@param test_data string
---@return boolean
function global_table.do_stuff(test_data) end
Code that use this engine:
--- Currently raises the duplicated field warning
function global_table.do_stuff(test_data)
-- Handle stuff differently
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, tests, or entry points. Start by tracing how duplicate-field warnings are produced for Lua functions and review existing annotation or override handling. Done means a documented way to mark an API function as overridable so user implementations no longer trigger the duplicate-field warning.
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
- 30/100