• Stars
    star
    301
  • Rank 138,451 (Top 3 %)
  • Language
    Vim Script
  • License
    MIT License
  • Created almost 10 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Wrap and unwrap function arguments, lists, and dictionaries in Vim

Vim-ArgWrap

Vim-ArgWrap 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. All operations are 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 can 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>
    
  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.

Configuration

You can customize the behavior of this extension by setting values for any of the following optional buffer and global configuration variables in your .vimrc file. Buffer variables (prefixed with b:) take precedence over global variables (prefixed with g:), making them ideal for configuring the behavior of this extension on a file by 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

    Specifies a line prefix to be added and removed when working with languages that require newlines to be escaped.

    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
        )
    
  • 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
    )
    

More Repositories

1

anki-connect

Anki plugin to expose a remote API for creating flash cards.
Python
1,742
star
2

yomichan

Japanese pop-up dictionary extension for Chrome and Firefox.
JavaScript
1,053
star
3

homemaker

Efficiently manage your dot-file configuration settings.
Go
233
star
4

mangle

Manga processor for the Kindle e-book reader.
Python
122
star
5

zero-epwing

Sane data exporter for an insane dictionary format.
C
93
star
6

yomichan-import

External dictionary importer for Yomichan.
Go
78
star
7

md2vim

Tool for automatically converting markdown to vimdoc format
Go
75
star
8

yomichan-anki

Plugin for sentence/vocab mining Japanese books in Anki.
Python
56
star
9

goldsmith

Static pipeline-based website generator written in Go.
Go
35
star
10

metacall

Cross platform C++ template-based IPC library.
C++
10
star
11

jmdict

Go
8
star
12

lazarus

Modern reimplementation of the Diablo 2 engine.
Go
8
star
13

vfs

Simple versioning file system created for Linux with FUSE.
Go
6
star
14

eb

C
5
star
15

tetrys

Simple Tetris clone written in Python.
Python
5
star
16

restaurant-search

Experiments in semantic search.
Go
4
star
17

mdview

Tool to view Github Flavored Markdown files in your web browser.
CSS
4
star
18

scrawl

Command line CSS selector-based web scraper and downloader.
Go
3
star
19

dotvim

Vim configuration files
Lua
2
star
20

hlm2-wad-extract

Asset extractor for Hotline Miami 2 WAD files.
Python
2
star
21

guid.nvim

Simply common operations when working with GUIDs in Neovim
Lua
2
star
22

goldsmith-components

Set of core plugins to extend Goldsmith functionality.
Go
2
star
23

argonaut.nvim

Lua
1
star
24

revolver.nvim

Lua
1
star
25

ankijoy

Gamepad plugin for Anki 1.x
Python
1
star