rhys-vdw / rhys-vdw/lua-doc-extractor
Generate sourcemaps to cpp with output
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 3
- Avg merge
- 2m
- Merged PRs (30d)
- 1
Description
- Generate sourcemaps
- Provide a tool that processes emmylua-rust-analyzer output and remaps them
- Provide a tool that transforms emmylua-doc-cli and adds the sourcemap as an extra field to the doc JSON.
- Work out how to easily support "go to definition" either opening the local cpp source file, or the file in github, when editing the project in VSCode.
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 tracing the outputs of emmylua-rust-analyzer and emmylua-doc-cli and deciding how the sourcemap should be represented in the doc JSON. Done means a remapping tool exists, the transformed documentation includes the sourcemap field, and VSCode can use it for go-to-definition against local or GitHub C++ sources.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, typescript, vscode
- Domain
- devtools, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100