From 0faba07179f96cae2ab49cf2cc22ebeb922c1532 Mon Sep 17 00:00:00 2001 From: Alex Yatskov Date: Mon, 7 Feb 2022 19:59:30 -0800 Subject: [PATCH] Update README --- README.md | 338 +++++++++++++++++++++++++++--------------------------- 1 file changed, 171 insertions(+), 167 deletions(-) diff --git a/README.md b/README.md index 21aa3c7..fd98b24 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,14 @@ easily reversible and correctly preserve the indentation of the surrounding code ## Installation and Usage 1. Clone or otherwise download ArgWrap extension. Users of [pathogen.vim](https://github.com/tpope/vim-pathogen) can - clone the repository directly to their bundle directory: \ - `git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap` + clone the repository directly to their bundle directory: + ``` + git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap + ``` 2. Create a keyboard binding for the `ArgWrap` command. For example, to declare a normal mode mapping, add: \ - `nnoremap a :ArgWrap` + ``` + nnoremap a :ArgWrap + ``` 3. Position the cursor inside of the parenthesis, brackets or curly braces you wish to wrap/unwrap. 4. Execute the keyboard binding you defined above to toggle the wrapping and unwrapping of arguments. @@ -33,189 +37,189 @@ global variables (prefixed with `g:`), making them ideal for configuring the beh file basis using `ftplugin` or `autocmd`. For example, the `argwrap_tail_comma` variable has two variants declared as `b:argwrap_tail_comma` and `g:argwrap_tail_comma`, for buffer and global scopes respectively. -### argwrap_line_prefix +* `argwrap_line_prefix` -Specifies a line prefix to be added and removed when working with languages that require newlines to be escaped. + Specifies a line prefix to be added and removed when working with languages that require newlines to be escaped. -Line prefix disabled (default): + Line prefix disabled (default): -``` -Foo( - wibble, - wobble, - wubble -) -``` - -Line prefix enabled for Vimscript (`let g:argwrap_line_prefix = '\'`): - -``` -Foo( - \wibble, - \wobble, - \wubble -\) -``` - -### argwrap_padded_braces - -Specifies which brace types should be padded on the inside with spaces. - -Brace padding disabled (default): - -``` -[1, 2, 3] -{1, 2, 3} -``` - -Brace padding enabled for square brackets only (`let g:argwrap_padded_braces = '['`): - -``` -[ 1, 2, 3 ] -{1, 2, 3} -``` - -Padding can be specified for multiple brace types (`let g:argwrap_padded_braces = '[{'`). - -### argwrap_tail_comma - -Specifies if any closing brace should be preceded with a comma when wrapping lines. - -Tail comma disabled (default):: - -``` -Foo( - wibble, - wobble, - wubble -) -``` - -Tail comma enabled (`let g:argwrap_tail_comma = 1`): - -``` -Foo( - wibble, - wobble, - wubble, -) -``` - -### argwrap_tail_comma_braces - -Specifies which closing brace should be preceded with a comma when wrapping lines. - -Tail comma disabled (default): - -``` -Foo( - wibble, - wobble, - wubble -) -``` - -Tail comma enabled for square brackets only (`let g:argwrap_tail_comma_braces = '['`): - -``` -[ - 1, - 2, - 3, -] -``` - -### argwrap_tail_indent_braces - -Specifies if the closing brace should be indented to argument depth. - -Tail indent disabled: - -``` -Foo( - wibble, - wobble, - wubble -) -``` - -Tail indent enabled for parenthesis (`let g:argwrap_tail_indent_braces = '('`): - -``` -Foo( - wibble, - wobble, - wubble + ``` + Foo( + wibble, + wobble, + wubble ) -``` + ``` -### argwrap_wrap_closing_brace + Line prefix enabled for Vimscript (`let g:argwrap_line_prefix = '\'`): -Specifies if the closing brace should be wrapped to a new line. + ``` + Foo( + \wibble, + \wobble, + \wubble + \) + ``` -Brace wrapping enabled (default): +* `argwrap_padded_braces` -``` -Foo( - wibble, - wobble, - wubble -) -``` + Specifies which brace types should be padded on the inside with spaces. -Brace wrapping disabled (`let g:argwrap_wrap_closing_brace = 0`): + Brace padding disabled (default): -``` -Foo( - wibble, - wobble, - wubble) -``` + ``` + [1, 2, 3] + {1, 2, 3} + ``` -### argwrap_comma_first + Brace padding enabled for square brackets only (`let g:argwrap_padded_braces = '['`): -Specifies if the argument comma delimiter should be placed before arguments. + ``` + [ 1, 2, 3 ] + {1, 2, 3} + ``` -Comma first disabled (default): + Padding can be specified for multiple brace types (`let g:argwrap_padded_braces = '[{'`). -``` -Foo( - wibble, - wobble, - wubble -) -``` +* `argwrap_tail_comma` -Comma first enabled (`let g:argwrap_comma_first = 1`): + Specifies if any closing brace should be preceded with a comma when wrapping lines. -``` -Foo( - wibble - , wobble - , wubble -) -``` + Tail comma disabled (default):: -### argwrap_comma_first_indent + ``` + Foo( + wibble, + wobble, + wubble + ) + ``` -Specifies if the first argument should be indented when used in conjunction with `argwrap_comma_first`. + Tail comma enabled (`let g:argwrap_tail_comma = 1`): -Comma first indent disabled (default): + ``` + Foo( + wibble, + wobble, + wubble, + ) + ``` -``` -Foo( - wibble - , wobble - , wubble -) -``` +* `argwrap_tail_comma_braces` -Comma first indent enabled (`let g:argwrap_comma_first_indent = 1`): + Specifies which closing brace should be preceded with a comma when wrapping lines. -``` -Foo( - wibble - , wobble - , wubble -) -``` + Tail comma disabled (default): + + ``` + Foo( + wibble, + wobble, + wubble + ) + ``` + + Tail comma enabled for square brackets only (`let g:argwrap_tail_comma_braces = '['`): + + ``` + [ + 1, + 2, + 3, + ] + ``` + +* `argwrap_tail_indent_braces` + + Specifies if the closing brace should be indented to argument depth. + + Tail indent disabled: + + ``` + Foo( + wibble, + wobble, + wubble + ) + ``` + + Tail indent enabled for parenthesis (`let g:argwrap_tail_indent_braces = '('`): + + ``` + Foo( + wibble, + wobble, + wubble + ) + ``` + +* `argwrap_wrap_closing_brace` + + Specifies if the closing brace should be wrapped to a new line. + + Brace wrapping enabled (default): + + ``` + Foo( + wibble, + wobble, + wubble + ) + ``` + + Brace wrapping disabled (`let g:argwrap_wrap_closing_brace = 0`): + + ``` + Foo( + wibble, + wobble, + wubble) + ``` + +* `argwrap_comma_first` + + Specifies if the argument comma delimiter should be placed before arguments. + + Comma first disabled (default): + + ``` + Foo( + wibble, + wobble, + wubble + ) + ``` + + Comma first enabled (`let g:argwrap_comma_first = 1`): + + ``` + Foo( + wibble + , wobble + , wubble + ) + ``` + +* `argwrap_comma_first_indent` + + Specifies if the first argument should be indented when used in conjunction with `argwrap_comma_first`. + + Comma first indent disabled (default): + + ``` + Foo( + wibble + , wobble + , wubble + ) + ``` + + Comma first indent enabled (`let g:argwrap_comma_first_indent = 1`): + + ``` + Foo( + wibble + , wobble + , wubble + ) + ```