https://github.com/andymass/vim-tradewinds
the missing window movement
https://github.com/andymass/vim-tradewinds
Last synced: 10 months ago
JSON representation
the missing window movement
- Host: GitHub
- URL: https://github.com/andymass/vim-tradewinds
- Owner: andymass
- License: mit
- Created: 2018-07-15T15:38:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-05T13:08:45.000Z (over 6 years ago)
- Last Synced: 2025-01-22T07:28:35.042Z (12 months ago)
- Language: Vim script
- Size: 13.7 KB
- Stars: 94
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-list - vim-tradewinds
README
# vim trade winds
The missing window movement.
This plugin is best explained with a diagram. In the following example,
suppose you are in "current win" and would like to move it beneath the
left most window. This normally would require you to move to the left
window, split it, open the correct buffer, and then finally close the
original window.
trade winds simplifies this procedure by introducing a series of maps
which allow you to move windows into other windows, causing them to be
split. They are `ctrl-w g` followed by the usual `hjkl` motions.
+-------------+---------------+ +-------------+---------------+
| | | | | |
| | | | | |
| +---------------+ | | |
| | | ctrl-w gh | +---------------+
| | | | | |
| +---------------+ +-------------+ |
| | | +-------> | | |
| | current win | | current win | |
| | | | | |
+-------------+---------------+ +-------------+---------------+
This is referred to as a soft move, as opposed to vim's hard moves
`ctrl-w HJKL` which place windows as far as possible in the given
direction.
Likewise, if you would like to move windows down into a split,
+-------------+-------+-------+ +-----------------+-----------+
| | | | | | |
| | | | | | |
| current win | | | | | |
| | | | ctrl-w gj | | |
| | | | | | |
+-------------+-------+-------+ +-------------+---+-----------+
| | +-------> | | |
| | | current win | |
| | | | |
+-----------------------------+ +-------------+---------------+
trade winds also locally converts horizontal splits into vertical ones and
vice-versa.
+---+-----------------+-------+ +---+---------+-------+-------+
| | | | | | | | |
| | | 4 | | 1 | current | some | |
| | current win | | | | win | buffer| |
| | | | ctrl-w gj | | | | |
| | | | | | | | |
| +-----------------+ | + | | | |
| | | | +-------> | | | | |
| | some buffer | | | | | | |
| | | | | | | | |
+---+-----------------+-------+ +---+---------+-------+-------+
Of course, you may have to resize the windows yourself. You may prefer
to use the option `equalalways`.
If the window is already touching a side of the tab page, `ctrl-w gh`
behaves just like `ctrl-w H` (etc). This means if you use a soft move
repeatedly, a window will eventually end up all the way in a particular
direction.
+-------------+-------+-------+ +-------------+-------+-------+
| | | | | | | |
| | | | | | | |
| current win | | | | | | |
| | | | ctrl-w gh | | | |
| | | | | current win | | |
|-------------+-------+-------| | +-------+-------+
| | +-------> | | |
| | | | |
| | | | |
+-----------------------------+ +-------------+---------------+
## Installation
Requires vim 8.0.1364 or neovim (exact version uncertain).
If you use [vim-plug](https://github.com/junegunn/vim-plug), then add the
following line to your vimrc file:
```vim
Plug 'andymass/vim-tradewinds'
```
and then use `:PlugInstall`. Or, you can use vim's built-in plugin system
(`:help packadd`) or any other plugin manager.
## Maps
gh: soft move left
gj: soft move down
gk: soft move up
gl: soft move right
To disable all maps, use
```vim
let g:tradewinds_no_maps = 1
```
If you would like to change the map prefix from `ctrl-w g`, use for
instance,
```vim
let g:tradewinds_prefix = 'e'
```
If you want full control, make your own mappings
```vim
nmap h (tradewinds-h)
nmap j (tradewinds-j)
nmap k (tradewinds-k)
nmap l (tradewinds-l)
```
trade winds won't try to make its usual maps if you have made your own,
and it wont step on your existing maps.
Alternatively, you can make maps which use the `TradewindsMove` command:
```vim
let g:tradewinds_no_maps = 1
nnoremap g :TradewindsMove h
nnoremap g :TradewindsMove j
nnoremap g :TradewindsMove k
nnoremap g :TradewindsMove l
```
## Customization
Before moving a window, trade winds looks for a variable named
`g:tradewinds#prepare`. This can be set to a reference or name of a
function which takes two arguments: the current window number and the
target window number. Returning 1 will cancel the movement.
After a window move is performed, trade winds fires the `User` autocmd
`TradeWindsAfterVoyage`. This can be used, for example, to fix up
statuslines or other window properties:
autocmd User TradeWindsAfterVoyage call DoSomething()
## Caveats
The windows are not actually moving. Instead, a new window is created
containing the correct buffer and then old one is closed. This could lead
to unpredictable results. For example, plugins which rely on `w:`
variables being set in particular ways may have trouble.
If you notice any problems, please open an issue.
## Self-promotion
Check out my other plugin,
[match-up](https://github.com/andymass/vim-matchup).
## Acknowledgments
This plugin was inspired by Scott Pierce's [vim-window][1]. In that
plugin, the `ctrl-w g[hjkl]` are referred to as "glue window" and behave
very differently.
[1]: https://github.com/ddrscott/vim-window