Updating doc
This commit is contained in:
parent
9f937dec9c
commit
d40ab2f671
178
doc/argwrap.txt
178
doc/argwrap.txt
@ -1,161 +1,183 @@
|
|||||||
*argwrap.txt* Wrap and unwrap function arguments, lists and dictionaries in Vim
|
*ArgWrap.txt* ArgWrap is an industrial strength argument wrapping and unwrapping extension for the [Vim](http://www.vim.org/) text
|
||||||
|
editor. It can be used for collapsing and expanding everything from function calls to array and dictionary definitions.
|
||||||
|
|
||||||
argwrap.vim
|
|ArgWrap-intro| ArgWrap
|
||||||
|
|ArgWrap-Installation| Installation
|
||||||
|
|ArgWrap-Configuration| Configuration
|
||||||
|
|ArgWrap-Usage| Usage
|
||||||
|
|ArgWrap-Examples| Examples
|
||||||
|
|
||||||
about |argwrap-about|
|
ARGWRAP *ArgWrap-intro*
|
||||||
installation |argwrap-installation|
|
|
||||||
usage |argwrap-usage|
|
|
||||||
examples |argwrap-examples|
|
|
||||||
|
|
||||||
================================================================================
|
ArgWrap is an industrial strength argument wrapping and unwrapping extension for the [Vim](http://www.vim.org/) text
|
||||||
ABOUT *argwrap-about*
|
editor. It can be used for collapsing and expanding everything from function calls to array and dictionary definitions.
|
||||||
|
|
||||||
argwrap.vim is an industrial strength argument wrapping and unwrapping extension
|
|
||||||
for the Vim text editor. It can be used for collapsing and expanding everything
|
|
||||||
from function calls to array and dictionary definitions. The online resources
|
|
||||||
listed below can be accessed to download new versions of this extension and to
|
|
||||||
access other information.
|
|
||||||
|
|
||||||
GitHub: https://github.com/FooSoft/vim-argwrap/
|
INSTALLATION *ArgWrap-Installation*
|
||||||
Homepage: http://foosoft.net/projects/vim-argwrap/
|
|
||||||
Vim Awesome: http://vimawesome.com/plugin/vim-argwrap
|
|
||||||
Vim.org: http://www.vim.org/scripts/script.php?script_id=5062
|
|
||||||
|
|
||||||
================================================================================
|
Clone or otherwise download the latest version of the ArgWrap extension from its
|
||||||
INSTALLATION *argwrap-installation*
|
|
||||||
|
|
||||||
1. Clone or otherwise download the latest version of the argwrap.vim extension
|
[GitHub](https://github.com/FooSoft/vim-argwrap) page. If you are using
|
||||||
from its GitHub page (the script is also available for download through
|
|
||||||
Vim.org. If you are using pathogen.vim for plugin management (you should)
|
|
||||||
you can clone the repository directly to your bundle directory:
|
|
||||||
|
|
||||||
|
[pathogen.vim](https://github.com/tpope/vim-pathogen) for plugin management you can clone the repository directly to
|
||||||
|
|
||||||
|
your bundle directory:
|
||||||
|
|
||||||
|
>
|
||||||
$ git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap
|
$ git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap
|
||||||
|
<
|
||||||
|
|
||||||
2. Create a keyboard binding for the ArgWrap command inside your ~/.vimrc file.
|
Create a keyboard binding for the `ArgWrap` command inside your `~/.vimrc` file. For example, to declare a normal
|
||||||
For example, to declare a normal mode mapping, add the following command:
|
|
||||||
|
|
||||||
|
mode mapping, add the following command:
|
||||||
|
|
||||||
|
>
|
||||||
nnoremap <silent> <leader>a :ArgWrap<CR>
|
nnoremap <silent> <leader>a :ArgWrap<CR>
|
||||||
|
<
|
||||||
|
|
||||||
3. You can customize the wrapping/unwrapping behavior of this extension by
|
|
||||||
setting values for any of the following optional buffer and global
|
|
||||||
variables in your .vimrc file:
|
|
||||||
|
|
||||||
* g:argwrap_wrap_closing_brace or b:argwrap_wrap_closing_brace
|
CONFIGURATION *ArgWrap-Configuration*
|
||||||
|
|
||||||
Specifies if the closing brace should be wrapped to a new line. This
|
You can customize the wrapping/unwrapping behavior of this extension by setting values for any of the following optional
|
||||||
setting is helpful when working with languages such as Google's Go,
|
buffer and global variables in your `.vimrc` file:
|
||||||
which enforce coding style during compliation.
|
|
||||||
|
|
||||||
Brace wrapping enabled (default)
|
`g:argwrap_wrap_closing_brace` or `b:argwrap_wrap_closing_brace`
|
||||||
|
|
||||||
```
|
Specifies if the closing brace should be wrapped to a new line. This setting is helpful when working with languages
|
||||||
|
|
||||||
|
such as Google's [Go](https://golang.org/project/), which enforce coding style during compliation.
|
||||||
|
|
||||||
|
Brace wrapping enabled (default)
|
||||||
|
|
||||||
|
>
|
||||||
Foo(
|
Foo(
|
||||||
wibble,
|
wibble,
|
||||||
wobble,
|
wobble,
|
||||||
wubble
|
wubble
|
||||||
)
|
)
|
||||||
```
|
<
|
||||||
|
|
||||||
Brace wrapping disabled (let g:argwrap_wrap_closing_brace = 0)
|
Brace wrapping disabled (`let g:argwrap_wrap_closing_brace = 0`)
|
||||||
|
|
||||||
```
|
>
|
||||||
Foo(
|
Foo(
|
||||||
wibble,
|
wibble,
|
||||||
wobble,
|
wobble,
|
||||||
wubble)
|
wubble)
|
||||||
```
|
<
|
||||||
|
|
||||||
* g:argwrap_padded_braces or b:argwrap_padded_braces
|
`g:argwrap_padded_braces` or `b:argwrap_wrap_closing_brace`
|
||||||
|
|
||||||
Specifies which brace types should be padded on the inside with spaces:
|
Specifies which brace types should be padded on the inside with spaces:
|
||||||
|
|
||||||
'': do not add padding for any braces (empty string):
|
`''`: do not add padding for any braces (empty string):
|
||||||
|
|
||||||
|
>
|
||||||
[1, 2, 3]
|
[1, 2, 3]
|
||||||
{1, 2, 3}
|
{1, 2, 3}
|
||||||
|
<
|
||||||
|
|
||||||
'[': padding for square braces only (curly braces are not padded):
|
`'['`: padding for square braces only (curly braces are not padded):
|
||||||
|
|
||||||
|
>
|
||||||
[ 1, 2, 3 ]
|
[ 1, 2, 3 ]
|
||||||
{1, 2, 3}
|
{1, 2, 3}
|
||||||
|
<
|
||||||
|
|
||||||
Padding can be specified for multiple brace types as follows:
|
Padding can be specified for multiple brace types as follows:
|
||||||
|
|
||||||
|
>
|
||||||
let g:argwrap_padded_braces = '[{'
|
let g:argwrap_padded_braces = '[{'
|
||||||
|
<
|
||||||
|
|
||||||
================================================================================
|
|
||||||
USAGE *argwrap-usage*
|
|
||||||
|
|
||||||
1. Position the cursor inside of the scope of the parenthesis, brackets or
|
USAGE *ArgWrap-Usage*
|
||||||
curly braces you wish to wrap/unwrap (not on top, before or after them).
|
|
||||||
|
|
||||||
2. Execute the keyboard binding you defined above to toggle the wrapping and
|
Position the cursor *inside* of the scope of the parenthesis, brackets or curly braces you wish to wrap/unwrap (not
|
||||||
unwrapping of arguments.
|
|
||||||
|
|
||||||
================================================================================
|
on top, before or after them).
|
||||||
EXAMPLES *argwrap-examples*
|
|
||||||
|
|
||||||
Below are some examples of common use cases demonstrating the capabilities of
|
Execute the keyboard binding you defined above to *toggle* the wrapping and unwrapping of arguments.
|
||||||
argwrap.vim. Note that the extension functions identically regardless if it is
|
|
||||||
being applied to a function call, list or dictionary definition.
|
|
||||||
|
|
||||||
Let's begin with a simple function invocation. When there are many arguments
|
|
||||||
being passed to the function, we often wish to wrap them to improve code
|
|
||||||
readability. If you position your cursor anywhere between the parenthesis and
|
|
||||||
execute the ArgWrap command, the argument list will be wrapped to one per line.
|
|
||||||
|
|
||||||
Foo(wibble, wobble, wubble)
|
EXAMPLES *ArgWrap-Examples*
|
||||||
|
|
||||||
|
Below are some examples of common use cases demonstrating the capabilities of ArgWrap. Note that the extension functions
|
||||||
|
identically regardless if it is being applied to a function call, list or dictionary definition.
|
||||||
|
|
||||||
|
Let's begin with a simple function invocation. When there are many arguments being passed to the function, we often wish
|
||||||
|
to wrap them to improve code readability. If you position your cursor anywhere between the parenthesis and execute the
|
||||||
|
`ArgWrap` command, the argument list will be wrapped to one per line.
|
||||||
|
|
||||||
|
>
|
||||||
|
Foo(wibble, wobble, wubble)
|
||||||
|
<
|
||||||
|
|
||||||
Becomes this:
|
Becomes this:
|
||||||
|
|
||||||
Foo(
|
>
|
||||||
|
Foo(
|
||||||
wibble,
|
wibble,
|
||||||
wobble,
|
wobble,
|
||||||
wubble
|
wubble
|
||||||
)
|
)
|
||||||
|
<
|
||||||
|
|
||||||
List definitions work in a similar fashion:
|
List definitions work in a similar fashion:
|
||||||
|
|
||||||
foo = [bar, baz, qux, quux, corge]
|
>
|
||||||
|
foo = [bar, baz, qux, quux, corge]
|
||||||
|
<
|
||||||
|
|
||||||
Becomes this:
|
Becomes this:
|
||||||
|
|
||||||
foo = [
|
>
|
||||||
|
foo = [
|
||||||
bar,
|
bar,
|
||||||
baz,
|
baz,
|
||||||
qux,
|
qux,
|
||||||
quux,
|
quux,
|
||||||
corge
|
corge
|
||||||
]
|
]
|
||||||
|
<
|
||||||
|
|
||||||
Dictionaries also work the way you expected them to:
|
Dictionaries also work the way you expected them to:
|
||||||
|
|
||||||
foo = {bar: 1, baz: 3, qux: 3, quux: 7}
|
>
|
||||||
|
foo = {bar: 1, baz: 3, qux: 3, quux: 7}
|
||||||
|
<
|
||||||
|
|
||||||
Becomes this:
|
Becomes this:
|
||||||
|
|
||||||
foo = {
|
>
|
||||||
|
foo = {
|
||||||
bar: 1,
|
bar: 1,
|
||||||
baz: 3,
|
baz: 3,
|
||||||
qux: 3,
|
qux: 3,
|
||||||
quux: 7
|
quux: 7
|
||||||
}
|
}
|
||||||
|
<
|
||||||
|
|
||||||
Finally, nested combinations of all the above are also supported:
|
Finally, nested combinations of all the above are also supported:
|
||||||
|
|
||||||
Foo([wibble, wobble, wubble], spam, {bar: baz, qux: [1, 3, 3, 7]})
|
>
|
||||||
|
Foo([wibble, wobble, wubble], spam, {bar: baz, qux: [1, 3, 3, 7]})
|
||||||
|
<
|
||||||
|
|
||||||
Becomes this:
|
Becomes this:
|
||||||
|
|
||||||
Foo(
|
>
|
||||||
|
Foo(
|
||||||
[wibble, wobble, wubble],
|
[wibble, wobble, wubble],
|
||||||
spam,
|
spam,
|
||||||
{bar: baz, qux: [1, 3, 3, 7]}
|
{bar: baz, qux: [1, 3, 3, 7]}
|
||||||
)
|
)
|
||||||
|
<
|
||||||
|
|
||||||
You can continue argument expansion to:
|
You can continue argument expansion to:
|
||||||
|
|
||||||
Foo(
|
>
|
||||||
|
Foo(
|
||||||
[
|
[
|
||||||
wibble,
|
wibble,
|
||||||
wobble,
|
wobble,
|
||||||
@ -171,9 +193,13 @@ Foo(
|
|||||||
7
|
7
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
<
|
||||||
|
|
||||||
The argument wrapping and unwrapping operations demonstrated above are easily
|
The argument wrapping and unwrapping operations demonstrated above are easily reversible and correctly preserve the
|
||||||
reversible and correctly preserve the indentation of the surrounding code. This
|
indentation of the surrounding code. This extension has been tested to work in scenarios of various complexity, but if
|
||||||
extension has been tested to work in scenarios of various complexity, but if you
|
you discover a problem don't hesitate to report it.
|
||||||
discover a problem don't hesitate to report it.
|
|
||||||
|
|
||||||
|
|
||||||
|
vim:tw=78:ts=8:ft=help:norl:
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user