google / vimdoc

Helpfile generation for vim
Apache License 2.0
291 stars 29 forks source link

RFC: Basic implementation of vimdoc on top of vim-plugin-metadata lib #138

Open dbarnett opened 2 months ago

dbarnett commented 2 months ago

Demonstrates how vimdoc could leverage https://pypi.org/project/vim-plugin-metadata to simplify away regex logic, make the parsing more robust (probably fixing lots of existing bugs), and lay groundwork for cleanly supporting more complex user requests in the future.

Note: I did a kinda strange partial conversion for this RFC to make the changes slightly easier to follow: even though all the vimscript processing is coming via the vim-plugin-metadata lib, it reconstructs parts of the metadata into pseudo-vimscript (in vimdoc.parser.AffectForVimNode) and feeds them back through some of vimdoc's preexisting regex processing. That's easy enough to clean up if this overall approach looks good and we do decide to finalize and merge it.