rhys-vdw / rhys-vdw/lua-doc-extractor
Support full table definitions as a type
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 3
- Avg merge
- 2m
- Merged PRs (30d)
- 1
Description
e.g.
/***
* @alias RmlUi.EventParametersProxy {
* button: RmlUi.EventParametersProxy.MouseButton,
* mouse_x: integer,
* mouse_y: integer,
* scroll_lock_key: RmlUi.EventParametersProxy.TrueFalse,
* meta_key: RmlUi.EventParametersProxy.TrueFalse,
* ctrl_key: RmlUi.EventParametersProxy.TrueFalse,
* shift_key: RmlUi.EventParametersProxy.TrueFalse,
* caps_lock_key: RmlUi.EventParametersProxy.TrueFalse,
* alt_key: RmlUi.EventParametersProxy.TrueFalse,
* }
*/
Contributor guide
No contributing guide indexed for this repository
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 reading the extractor's handling of @alias declarations and existing type parsing, then use the supplied Lua example as the input case. Done means a full table definition with named fields and nested referenced types is recognized as a type without breaking existing extraction behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua, typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100