Skip to content

vim-utilities/balanced-backspace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Balanced Backspace

Attempts to balance removal of quotes and braces

Byte size of Balanced Backspace Open Issues Open Pull Requests Latest commits



Requirements

This repository requires the Vim 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 vim
  • Debian derived Distributions
sudo apt-get update

sudo apt-get install vim

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/balanced-backspace.git

Install

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

cd ~/git/hub/vim-utilities/balanced-backspace

make install

Uninstall

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

cd ~/git/hub/vim-utilities/balanced-backspace

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/balanced-backspace

make upgrade

Documentation

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

help balanced-backspace.txt

Usage

  • {<BS>} Backspace within empty curly-brace will delete the closing brace along with opening brace

  • (<BS>) Backspace within empty parenthesis will delete the closing parenthesis along with opening parenthesis

  • [<BS>] Backspace within empty square-braces will delete the closing brace along with opening brace

  • "<BS>" Backspace within empty double-quotes will delete the closing quote along with opening quote

  • '<BS>' Backspace within empty single-quotes will delete the closing quote along with opening quote

  • <BS> Backspace within empty backtick will delete the closing backtick along with opening backtick


Configuration

Existing defaults may be modified or extended by assigning g:balanced_backspace variable within the ~/.vimrc file for a given account. Example of defaults...

let g:balanced_backspace = {
      \   'exclude': [],
      \   'all': {
      \     'parentheses': { 'open': '(', 'close': ')' },
      \     'curly-brace': { 'open': '{', 'close': '}' },
      \     'square-bracket': { 'open': '[', 'close': ']' },
      \     'single-quote': { 'open': "'" },
      \     'double-quote': { 'open': '"' },
      \     'backtick': { 'open': "`" },
      \   },
      \ }

Exclude example...

let g:balanced_backspace = {
     \   'exclude': [ 'help', 'markdown' ],
     \ }

Example of adding angle-bracket support...

let g:balanced_backspace = {
      \   'all': {
      \     'angle-bracket': { 'open': '<', 'close': '>' },
      \   },
      \ }

Filetype customization example

let g:balanced_backspace = {
      \   'html': {
      \     'angle-bracket': { 'open': '<', 'close': '>' },
      \   },
      \ }

Remove all entry example...

let g:balanced_backspace = {
     \   'all': {
     \     'square-bracket': false,
     \   },
     \ }

Alternatively one may instead assign a JSON file path to the g:balanced_backspace variable to customize configurations, eg...

{
  "exclude": [ "help", "markdown" ],
  "all": {
    "parentheses": {
      "open": "(",
      "close": ")"
    },
    "curly-brace": {
      "open": "{",
      "close": "}"
    },
    "square-bracket": {
      "open": "[",
      "close": "]"
    },
    "single-quote": {
      "open": "'"
    },
    "double-quote": {
      "open": "\""
    },
    "backtick": {
      "open": "`"
    }
  },
  "html": {
    "angle-bracket": {
      "open": "<",
      "close": ">"
    }
  }
}

Configuration via JSON file path example...

let g:balanced_backspace = '~/.vim/configs/balanced-backspace.json'

Notes

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


Contributing

Options for contributing to balanced-backspace and vim-utilities


Forking

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

cd ~/git/hub/vim-utilities/balanced-backspace

git remote add fork [email protected]:<NAME>/balanced-backspace.git
  • Commit your changes and push to your fork, eg. to fix an issue...
cd ~/git/hub/vim-utilities/balanced-backspace


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 -u 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!

Via Liberapay you may sponsor__shields_io__liberapay on a repeating basis.

Regardless of if you're able to financially support projects such as balanced-backspace 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


License

Attempts to balance removal of quotes and braces
Copyright (C) 2021 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.

About

Attempts to balance removal of quotes and braces

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published