laydown VS lemmy-help

I just hit 2.0 of my small CLI app - https://github.com/badjr13/laydown - after switching from standard library to Clap for the argument parsing which ever so slightly changed the API. Right now I'm focusing on wrapping up some testing and completing a basic CI/CD pipeline using GitHub actions.

Here is the PR with the refactor if it helps answer my question.

A little over a week ago, I shared my first Rust project, laydown on this subreddit and the response from all of you was amazing. It was a super simple idea that I used to help dip my toe into Rust. I shared it with you all as a "final step" to make it feel complete without any expectations and honestly was anticipating a very minimal reaction from the community if any. Ten days later, the GitHub repo has 63 stars, multiple issues and pull requests have been created, there is another contributor on the project, and as of yesterday, there is now a Changelog and version 1.1.0 has been released with some additional features requested by you!

Interesting. Feel free to create an issue on the repo - https://github.com/badjr13/laydown/issues - and perhaps I'll get to it.

So let me tell you about my experience! In the stone ages of lua plugins, I was maintaining a markdown file to note down all the APIs but as the plugin was constantly changing, docs were getting out of sync very quickly and it was a royal pain to update them. So, in my case emmylua was the obvious choice for the docs, so I began searching for tools that convert emmylua to vim-help, luckily I found tree-sitter-lua#docgen and mini.doc. But in the end, I decided to write my own tool, and thus lemmy-help was born. Here a help file generated by it

When I added some EmmyLua docs to one of my plugins (to generate Vimdoc using lemmy-help), I noticed lua-language-server was giving me diagnostics based on my documentation. This was something I was not getting from linters like luacheck. So I asked myself, "Can I leverage lua-language-server and EmmyLua to statically type check my Lua code?"

This will drastically improve the UX of help files. I am adding support for this in lemmy-help here https://github.com/numToStr/lemmy-help/pull/65 and I hope other doc generators can leverage this to provide beautiful help docs :)

If you want to provide vim doc, I recommend to use lemmy-help as soon as possible.

Rust is great for parsing text. I created https://github.com/numToStr/lemmy-help to parse emmylua from lua code and convert it into vim help doc. I am also reading https://craftinginterpreters.com/ to expand my parsing knowledge and using Rust as the implementation language.

I just released lemmy-help v0.8.0 which now has support for all* emmylua types. That means you can use any complex types in you emmylua annotations and it will be parsed correctly and vimdoc will be rendered as expected

And if you are writing lua plugin which have public API, I would recommend writing emmylua and covert that into vimdoc using https://github.com/numToStr/lemmy-help (Self Plug)

multiline ---@field description

I've just released https://github.com/numToStr/lemmy-help :)

That's just too much. You can just download the binaries from the releases page https://github.com/numToStr/lemmy-help/releases