Update README

This commit is contained in:
Alex Yatskov 2022-02-07 19:59:30 -08:00
parent 0c03483702
commit 0faba07179

View File

@ -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 <silent> <leader>a :ArgWrap<CR>`
```
nnoremap <silent> <leader>a :ArgWrap<CR>
```
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,7 +37,7 @@ 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.
@ -57,7 +61,7 @@ Foo(
\)
```
### argwrap_padded_braces
* `argwrap_padded_braces`
Specifies which brace types should be padded on the inside with spaces.
@ -77,7 +81,7 @@ Brace padding enabled for square brackets only (`let g:argwrap_padded_braces = '
Padding can be specified for multiple brace types (`let g:argwrap_padded_braces = '[{'`).
### argwrap_tail_comma
* `argwrap_tail_comma`
Specifies if any closing brace should be preceded with a comma when wrapping lines.
@ -101,7 +105,7 @@ Foo(
)
```
### argwrap_tail_comma_braces
* `argwrap_tail_comma_braces`
Specifies which closing brace should be preceded with a comma when wrapping lines.
@ -125,7 +129,7 @@ Tail comma enabled for square brackets only (`let g:argwrap_tail_comma_braces =
]
```
### argwrap_tail_indent_braces
* `argwrap_tail_indent_braces`
Specifies if the closing brace should be indented to argument depth.
@ -149,7 +153,7 @@ Foo(
)
```
### argwrap_wrap_closing_brace
* `argwrap_wrap_closing_brace`
Specifies if the closing brace should be wrapped to a new line.
@ -172,7 +176,7 @@ Foo(
wubble)
```
### argwrap_comma_first
* `argwrap_comma_first`
Specifies if the argument comma delimiter should be placed before arguments.
@ -196,7 +200,7 @@ Foo(
)
```
### argwrap_comma_first_indent
* `argwrap_comma_first_indent`
Specifies if the first argument should be indented when used in conjunction with `argwrap_comma_first`.