TASEmulators / TASEmulators/BizHawk
Output Lua annotations for editors
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2.8k
- Forks
- 468
- PR merge metrics
- No merged PRs in 30d
Description
Because Bizhawk's Lua functions are created inside Bizhawk, they can't be seen by external editors like VSCode.
The Lua console already has functions for generating code completion tags for Sublime Text/Notepad++, but this code is unfinished and not part of the Lua language. However, there's a better solution.
What would be awesome is an annotations file that could be added/linked into our projects. That way we could use any editor we like and get language support outside the bizhawk Lua console.
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 locating the Lua console code that generates Sublime Text and Notepad++ completion tags, then compare its available function data with the LuaLS annotation format linked in the issue. Done means producing an annotations file that can be added or linked to BizHawk Lua projects and provides editor language support outside the console.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, lua
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100