vim-registry(5) vim addons vim-registry(5)NAME
vim-registry - syntax for vim-addons registry files
SYNOPSIS
PACKAGE-NAME.yaml
DESCRIPTION
A registry file is a multi-document YAML file (i.e. it can be composed by several different YAML documents separated by "---" lines). Each
YAML document represents a registry entry, that is the information describing a single addon.
Ideally, the registry directory contains one file per package shipping addons; with a filename obeying to the convention PACKAGE-NAME.yaml.
Hence a single package can contribute to the registry with multiple entries described in a single YAML file.
For example, the "vim-scripts" package should ship a single /usr/share/vim/registry/vim-scripts.yaml file, containing one YAML document per
shipped addon. The first lines of such file can look like the following:
addon: alternate
description: "alternate pairing files (e.g. .c/.h) with short ex-commands"
basedir: /usr/share/vim-scripts/
disabledby: "let loaded_alternateFile = 1"
files:
- plugin/a.vim
- doc/alternate.txt
---
addon: whatdomain
description: "query the meaning of a Top Level Domain"
basedir: /usr/share/vim-scripts/
disabledby: "let loaded_whatdomain = 1"
files:
- plugin/whatdomain.vim
---
Each registry entry may contain the following fields, to be typeset according to the YAML specification:
addon (Required)
Name of the addon.
description (Required)
Human understandable textual description of the addon.
files (Required)
List of the files which compose the addon and are required to be present in a component of the Vim runtime path for the addon to be
enabled. Each file is specified relative to a component of the Vim runtime path.
basedir (Optional)
Directory where the files shipped by the addon (i.e., where the symlinks of the user/sysadm should point to) reside on the filesys-
tem. Default is /usr/share/vim/addons.
disabledby (Optional)
Vim script command that can be used (usually by adding it to ~/.vimrc) to prevent the addon from being used even when it is
installed. The intended usage of this field is to "blacklist" an undesired addon whose files are available, and hence automatically
loaded by Vim, in a component of the Vim runtime path.
AUTHOR
James Vega <jamessan@debian.org>
SEE ALSO vim-addons(1), YAML specification <http://www.yaml.org/>
COPYRIGHT
Copyright (C) 2010 James Vega
This program is free software, you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as pub-
lished by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
Debian Project January 2010 vim-registry(5)
Check Out this Related Man Page
Devel::Cover::Report::Vim(3pm) User Contributed Perl Documentation Devel::Cover::Report::Vim(3pm)NAME
Devel::Cover::Report::Vim - Backend for displaying coverage data in Vim
VERSION
version 0.89
SYNOPSIS
cover -report vim
DESCRIPTION
This module provides a reporting mechanism for displaying coverage data in Vim. It is designed to be called from the "cover" program.
By default, the output of this report is a file named "coverage.vim" in the directory of the coverage database. To use it, run
:so cover_db/coverage.vim
and you should see signs in the left column indicating the coverage status of that line.
The signs are as follows:
P - Pod coverage
S - Statement coverage
R - Subroutine coverage
B - Branch coverage
C - Condition coverage
The last of the criteria, in the order given above, is the one which is displayed. Correctly covered criteria are shown in green.
Incorrectly covered criteria are shown in red. Any incorrectly covered criterion will override a correctly covered criterion.
If the coverage for the file being displayed is out of date the a fucntion called g:coverage_old() is called and passed the name of the
file. Similarly, for current coverage data file file g:coverage_valid is called.
Signs may be overridden in a file named devel-cover.vim located somewhere underneath the ~/.vim directory.
For example, I use the solarized theme and keep the following comamnds in my local configuration file ~/.vim/local/devel-cover.vim:
let s:fg_cover = "#859900"
let s:fg_error = "#dc322f"
let s:bg_valid = "#073642"
let s:bg_old = "#342a2a"
let s:types = [ "pod", "subroutine", "statement", "branch", "condition", ]
for s:type in s:types
exe "highlight cov_" . s:type . " ctermbg=1 cterm=bold gui=NONE guifg=" . s:fg_cover
exe "highlight cov_" . s:type . "_error ctermbg=1 cterm=bold gui=NONE guifg=" . s:fg_error
endfor
exe "highlight SignColumn ctermbg=0 guibg=" . s:bg_valid
" highlight cov ctermbg=8 guibg=#002b36
" highlight err ctermbg=0 guibg=#073642
function! s:set_bg(bg)
for s:type in s:types
exe "highlight cov_" . s:type . " guibg=" . a:bg
exe "highlight cov_" . s:type . "_error guibg=" . a:bg
endfor
exe "highlight SignColumn ctermbg=0 guibg=" . a:bg
endfunction
function! g:coverage_valid(filename)
call s:set_bg(s:bg_valid)
endfunction
function! g:coverage_old(filename)
call s:set_bg(s:bg_old)
endfunction
This configuration sets the background colour of the signs to a dark red when the coverage data is out of date.
coverage.vim adds two user commands: :Cov and :Uncov which can be used to toggle the state of coverage signs.
The idea and the vim template is shamelessly stolen from Simplecov-Vim. See https://github.com/nyarly/Simplecov-Vim
SEE ALSO
Devel::Cover
Simplecov-Vim (https://github.com/nyarly/Simplecov-Vim)
BUGS
Huh?
LICENCE
Copyright 2012, Paul Johnson (paul@pjcj.net)
This software is free. It is licensed under the same terms as Perl itself.
The latest version of this software should be available from my homepage: http://www.pjcj.net
The template is copied from Simplecov-Vim (https://github.com/nyarly/Simplecov-Vim) and is under the MIT Licence.
The MIT License
Copyright (c) 2011 Judson Lester
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
perl v5.14.2 2012-06-15 Devel::Cover::Report::Vim(3pm)