Attempts to balance removal of quotes and braces
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
Perhaps as easy as one, 2.0,...
Clone this project...
mkdir -vp ~/git/hub/vim-utilities
cd ~/git/hub/vim-utilities
git clone [email protected]:vim-utilities/balanced-backspace.git
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
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.
To update in the future use make upgrade
command...
cd ~/git/hub/vim-utilities/balanced-backspace
make upgrade
After installation, plugin documentation may be accessed via Vim's :help
command, eg...
help balanced-backspace.txt
-
{<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
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'
This repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.
Options for contributing to balanced-backspace and vim-utilities
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/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 setfork
as the default remote, eg.git push -u fork main
however, this will also default thefork
remote for pulling from too! Meaning that pulling updates fromorigin
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.
Thanks for even considering it!
Via Liberapay you may 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.
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.