Splits Resize

Vim plugin for re-sizing splits swiftly

---

• ⬆️ Top of Document

• 🏗️ Requirements

• ⚡ Quick Start

  • 💾 Clone
  • ➕ Install
  • 🔥 Uninstall
  • ⬆️ Upgrade
  • 📑 Documentation

• 🧰 Usage

• 🗒 Notes

• 📈 Contributing

  • 🔱 Forking
  • 💱 Sponsor

• 📇 Attribution

• ⚖️ Licensing

---

Requirements

This repository requires the [Vim][vim_home] text editor to be installed the source code is available on GitHub -- vim/vim, and most GNU Linux package managers are able to install Vim directly, eg...

• Arch based Operating Systems

sudo packman -Syy

sudo packman -S gawk make vim

• Debian derived Distributions

sudo apt-get update

sudo apt-get install gawk make vim

Note gawk and make are only required if not utilizing a Vim plugin manager.

---

Quick Start

Perhaps as easy as one, 2.0,...

---

Clone

Clone this project...

mkdir -vp ~/git/hub/vim-utilities

cd ~/git/hub/vim-utilities

git clone [email protected]:vim-utilities/splits-resize.git

---

Install

If not using a plugin manager, then this plugin may be installed via make install command...

cd ~/git/hub/vim-utilities/splits-resize

make install

... Which will add symbolic links and update the Vim help tags file.

---

Uninstall

If not using a plugin manager, then this plugin may be uninstalled via make uninstall target...

cd ~/git/hub/vim-utilities/splits-resize

make uninstall

... Which will remove symbolic links and update the Vim help tags file.

---

Upgrade

To update in the future use make upgrade command...

cd ~/git/hub/vim-utilities/splits-resize

make upgrade

... Which will remove symbolic links, pull updates from Git default remote, re-add symbolic links and update Vim help tags file.

---

Documentation

After installation, plugin documentation may be accessed via Vim's :help command, eg...

:help splits-resize

---

Usage

All split actions are relative to current/active split, and intended to be used within Normal mode...

• <ESC>h or <A-h>, re-size active vertical split by -2

• <ESC>j or <A-j>, re-size active horizontal split by +2

• <ESC>k or <A-k>, re-size active horizontal split by -2

• <ESC>l or <A-l>, re-size active vertical split by +2

---

Notes

This repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.

The actions taken by this plugin may be modified with optional an expression, eg. 3<ESC>j will resize by +3

Some terminals have Alt aliased to Esc; this plugin remaps either such that <ESC>h and <A-h> keyboard shortcuts will preform the same action.

---

Contributing

Options for contributing to splits-resize and vim-utilities

---

Forking

Start making a Fork of this repository to an account that you have write permissions for.

• Add remote for fork URL. The URL syntax is [email protected]:<NAME>/<REPO>.git...

cd ~/git/hub/vim-utilities/splits-resize

git remote add fork [email protected]:<NAME>/splits-resize.git

• Commit your changes and push to your fork, eg. to fix an issue...

cd ~/git/hub/vim-utilities/splits-resize


git commit -F- <<'EOF'
:bug: Fixes #42 Issue


**Edits**


- `<SCRIPT-NAME>` script, fixes some bug reported in issue
EOF


git push fork main

Note, the -u option may be used to set fork as the default remote, eg. git push fork main however, this will also default the fork remote for pulling from too! Meaning that pulling updates from origin must be done explicitly, eg. git pull origin main

• Then on GitHub submit a Pull Request through the Web-UI, the URL syntax is https://github.com/<NAME>/<REPO>/pull/new/<BRANCH>

Note; to decrease the chances of your Pull Request needing modifications before being accepted, please check the dot-github repository for detailed contributing guidelines.

---

Sponsor

Thanks for even considering it!

With you may sponsor vim-utilities on a repeating basis.

Regardless of if you're able to financially support projects such as splits-resize that vim-utilities maintains, please consider sharing projects that are useful with others, because one of the goals of maintaining Open Source repositories is to provide value to the community.

---

Attribution

• Vim documentation

  • help :map-operator
  • help :map-commands
  • help :command-range
  • help <range>
  • help :command-count
  • help <count>
  • help <Plug>
  • help <SID>
  • help :map-<expr>

• Linux hints

  • Use sed -n l to debug key inputs

• GitHub -- github-utilities/make-readme

• GitHub -- tpope/vim-commentary

• StackExchange Vi -- How to allow count before my custom operator

• StackExchange Vi -- Make mapping that accepts count independent of line count

• StackOverflow -- Can I map alt key in Vim?

• Vim Fandom -- Get Alt key to work in terminal

• YouTube -- Essential Settings for Neovim

• YouTube -- My Vimrc: Customized for Markdown Writing & Nothing Else

---

License

Vim plugin for re-sizing splits swiftly
Copyright (C) 2020 S0AndS0

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

For further details review full length version of AGPL-3.0 License.