Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Speed up Vim by updating folds only when just.
VimL
branch: master

README.md

FastFold

Automatic folds (that is, folds generated by a fold method different from manual), bog down VIM noticeably in insert mode and are often recomputed too early (for example, when inserting an opening fold marker whose closing counterpart is yet missing to complete the fold.)

See http://vim.wikia.com/wiki/Keep_folds_closed_while_inserting_text for a discussion.

With this plug-in, the folds in the currently edited buffer are updated by an automatic fold method only

  • when saving the buffer, or
  • when closing or opening folds (off by default), or
  • when typing zuz in normal mode

and are kept as is otherwise (by keeping the fold method set to manual). Each of these triggers for updating folds can be disabled by adding

  • let g:fastfold_savehook = 0, or
  • let g:fastfold_togglehook = 0 (default value), or
  • let g:fastfold_map = 0

to the .vimrc file.

For example, by adding

set foldmethod=syntax

let g:tex_fold_enabled=1
let g:vimsyn_folding='af'
let g:xml_syntax_folding = 1
let g:php_folding = 1
let g:perl_fold = 1

to the .vimrc file and installing this plug-in, the folds in a TeX, Vim, XML, PHP or Perl file are updated by the syntax fold method when saving the buffer or typing zuz in normal mode and are kept as is otherwise.

Configuration

  • If you prefer that folds are only updated manually but not when saving the buffer, then add let g:fastfold_savehook = 0 to your .vimrc.

  • If you prefer that folds are updated whenever you close or open folds by a standard keystroke such as zx,zo or zc, then add let g:fastfold_togglehook = 1 to your .vimrc.

    The exact list of these standard keystrokes is zx,zX,za,zA,zo,zO,zc,zC,zr,zR,zm,zM,zi,zn,zN and it can be customized by changing the global variable g:fastfold_mapsuffixes (that defaults to let g:fastfold_mapsuffixes = ['x','X','a','A','o','O','c','C','r','R','m','M','i','n','N']).

    A suggested setting is to add

    let g:fastfold_togglehook = 1
    let g:fastfold_mapsuffixes = ['x','X','a','A']
    

    to your .vimrc file. This updates folds whenever you update (close all other) or toggle the fold where your cursor is (by zx or za).

  • If you prefer that this plug-in does not add a normal mode mapping that updates folds (that defaults to zuz), then add let g:fastfold_map = 0 to your .vimrc.

    You can remap zuz to your favorite keystroke, say <F5>, by adding nmap <F5> <Plug>(FastFoldUpdate) to your .Vimrc.

    There is also a command FastFoldUpdate that updates all folds and its variant FastFoldUpdate! that updates all folds and echos by which fold method the folds were updated.

Addons

  • Related Plug-ins

FastFold integrates with both vim-stay and restore_view.Vim that both store and restore the last folds by the :Mkview and :Loadview. How they compare is discussed at

https://github.com/kopischke/vim-stay/issues/2

Note that restore_view.vim integrates only from version 1.2 and above and must load AFTER FastFold. (To ensure the correct autocmd execution order.)

  • CustomFoldText

A CustomFoldText() function that displays the percentage of the number of buffer lines that the folded text takes up and indents folds according to their nesting level is available at

http://www.github.com/Konfekt/FoldText

Something went wrong with that request. Please try again.