Find file
Fetching contributors…
Cannot retrieve contributors at this time
144 lines (123 sloc) 5.17 KB
*sideways.txt* Move an item in a delimiter-separated list left or right
CONTENTS *sideways* *sideways-contents*
Installation............................: |sideways-installation|
Usage...................................: |sideways-usage|
Issues..................................: |sideways-issues|
INSTALLATION *sideways-installation*
There are several ways to install the plugin. The recommended one is by using
Tim Pope's pathogen ( In
that case, you can clone the plugin's git repository like so:
git clone git:// ~/.vim/bundle/sideways
If your vim configuration is under git version control, you could also set up
the repository as a submodule, which would allow you to update more easily.
The command is (provided you're in ~/.vim):
git submodule add git:// bundle/sideways
Another way is to simply copy all the essential directories inside the ~/.vim
directory: plugin, autoload, doc.
USAGE *sideways-usage*
The plugin defines two commands, |:SidewaysLeft| and |:SidewaysRight|, which
move the item under the cursor left or right, where an "item" is defined by a
delimiter. As an example:
def function(one, two, three):
Placing the cursor on "two" and executing |:SidewaysLeft|, the "one" and "two"
arguments will switch their places, resulting in this:
def function(two, one, three):
In this case, the delimiter is a comma. The plugin currently works with
various other cases and it's intended to make the process configurable. While
this particular example is in python, this should work for arguments in many
different languages that use round braces to denote function calls.
For ruby and eruby, it detects method calls without braces as well:
link_to user_registration_path, 'Something'
# changes to:
link_to 'Something', user_registration_path
Apart from functions, it works for square-bracket lists in dynamic languages:
list = [one, [two, four, five], three]
If you experiment with this example, you'll find that you can move the entire
second list around, as long as the cursor is on one of the inner brackets. The
plugin takes into consideration nested structures.
It's highly recommended to map the two main commands to convenient keys. For
example, mapping them to <c-h> and <c-l> would look like this:
nnoremap <c-h> :SidewaysLeft<cr>
nnoremap <c-l> :SidewaysRight<cr>
Other things that sideways works for:
Lists in CSS declarations:
border-radius: 20px 0 0 20px;
Single-line CSS declarations:
a { color: #fff; background: blue; text-decoration: underline; }
HTML attributes:
<input name="one" id="two" class="three" />
Cucumber tables:
| input_1 | input_2 | button | output |
| 20 | 30 | add | 50 |
| 2 | 5 | add | 7 |
| 0 | 40 | add | 40 |
Go lists:
[]string{"One", "Two", "Three"}
Javascript-like objects:
dict = {one: 1, two: 2, three: 3}
The plugin is customizable, though at this point you'd need to look at the
source to do this.
Bonus functionality: ~
The plugin's machinery makes it easy to implement an "argument" text object.
There are two mappings provided:
These are the outer and inner text objects, respectively. To use them, you
need to create mappings in your configuration files. Something like this:
omap aa <Plug>SidewaysArgumentTextobjA
xmap aa <Plug>SidewaysArgumentTextobjA
omap ia <Plug>SidewaysArgumentTextobjI
xmap ia <Plug>SidewaysArgumentTextobjI
This will map the "a" text object to operate on an "argument". So, you can
perform `daa` to delete an argument, `cia` to change an argument, and so on.
See |text-objects| for more information.
The plugin also provides the commands |:SidewaysJumpLeft| and
|:SidewaysJumpRight|, which move the cursor left and right by items.
Also, a useful plugin to use alongside sideways is `fieldtrip`
( This defines a submode
( for sideways.vim.
ISSUES *sideways-issues*
Any issues and suggestions are very welcome on the github bugtracker: