ROADMAP

[WillLillis]

I'm going to be spending some more time on the project in my spare time and would like to outline my basic plan going forward. Would love to hear any/all feedback from users, other contributors, etc. on what they'd like to see added, fixed, etc.

In no particular order:

Things I'm fairly comfortable tackling:

• Merge/ close existing PRs. ( feat: Hover and Autocomplete for Gas directives #57, Add Z80 Support #59, refactor: Assign Register and Instruction arch field at read time #68 feat: code document format #53)
• Publish 0.7.00.7.1. This release includes some nice feature additions, bug fixes, and signals that the project is still active.
• General cleanup -- Give the code a thorough readover, turn on clippy's pedantic mode and fix some of the style warnings, etc. (General cleanup around the project #87, refactor: Extract main loop in handle fns, add timing logs #88)
• Explore improving data loading at server start using serde (Use serde for deserializing the data sources #75) -- This requires a bit of a refactor, which I've started exploring in this branch. (perf: Use serde to aid in loading docs #91)
• Support compile_commands.json (Support for compile_commands.json #77) (feat: Support compile_commands.json/compile_flags.txt, correct include directories #96)
• Unit testing -- The project currently lacks testing for nearly all of its core functionality. I've spent a little time working on zls and I think the general approach for testing features like hover, autocomplete, etc. in that project could work here as well. (Unit test framework, hover tests, fix hash collision bug #83, Add autocomplete testing framework, tests #84)
• Better logging -- Taking a second look at what's being logged, as well as adding some perf tracing (maybe tracy?) to help find bottlenecks (refactor: Extract main loop in handle fns, add timing logs #88)
• Inline diagnostics -- Parse the output from a build as specified in compile_commands.json and provide inline diagnostics with any warnings/ errors. ([feature] Support inline diagnostics  #85) (Diagnostics #98)

Stretch Goals/ Maybe's

• ARM Support ( Add support for arm / arm64 instruction sets #17) -- This really just requires some RTFMing and writing an xml parser for ARM's docs.
• RISCV Support (RISCV Support #101) -- Same as ARM.
• MASM64 Support Support for MASM64 #72 -- More research/ resources needed
• Explore creating/ contributing to a more accurate tree-sitter grammar. (See this comment by the current tree-sitter maintainer on their own WIP grammar targeting multiple flavors)

Other/Misc

• Add z80-related topics to the repo to help with discoverability. (Added to the crates.io package via Cargo.toml, I don't have permissions to update tags/topics on the github repo)