tjdevries / vim-vertex

Vim plugin for foldmarker manipulation

vim-vertex

Remove and insert Vim's foldmarkers.

Why Vim-Vertex

Vertex: A point where two or more demarcations meet.

In terms of this plugin, a vertex is a place where two or more de - MARK - ations meet at one point. In VIM, this one point can be considered a fold and the outline is marked by foldmarkers.

As many of us know and have experienced, other editors don't always take advantage of them. For me, that meant not being able to use them in code that I was collaborating on. This plugin attempts to solve this problem by giving you simple commands to both remove and add back in your own foldmarkers.

What It Does

This plugin allows you to keep your markers out of version control (or just files you pass back and forth) so that the non-VIM users do not have the code "cluttered" with Vim foldmarkers.

The main idea is to add the capability of having foldmarkers inside of files, even version controlled files, but not having others have to view them. I think this is best explained via example:

Example

#!/usr/bin/python
# This is a python file

# Regular comment
def new_function():
    pass

# {{{
'''world's coolest python thing'''
# }}}

# Comment with a fold after it {{{ this stuff will go away
class NewClass:
    def __init__(self):
        # {{{ Personal note regarding what is coming up
        # This comment gives insight
        pass
        # }}}

    # {{{ Works on nested folds
    @property
    def cool(self):
        return True
    # }}}
    # }}}

After running VertexRemove, vim-vertex will remove all of the fold markers. It will then look like the file below.

#!/usr/bin/python
# This is a python file

# Regular comment
def new_function():
    pass

'''world's coolest python thing'''

# Comment with a fold after it
class NewClass:
    def __init__(self):
        # This comment gives insight
        pass

    @property
    def cool(self):
        return True

It stores the information required to place those folds back in another file (this could be changed if someone thinks of a better way!). To place them back, simply call VertexInsert. Then the file will look like its original state.

Requirements

For this plugin to be useful to you, these things should be true.

1. foldmethod=marker: I'm not really sure why you would be using this otherwise

Maybe this plugin is now foldmarker agnostic. I'm not sure yet. Still working on some other things currently

TODO

Please see the TODO tracker in this repository's issues section.

Testing

I am using Vader as my testing suite. You can see the tests in the test folder.