RFC: Basic implementation of vimdoc on top of vim-plugin-metadata lib #138
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.