GitXplorerGitXplorer
L

vcov

public
4 stars
1 forks
0 issues

Commits

List of commits on branch master.
Verified
121fc372822de97784ec587f71677798be8d0c67

Update README.md

LLumaKernel committed 5 years ago
Verified
c535dffbf3c6768bc8513a945410bdbf03f6459e

Fix README.md

LLumaKernel committed 5 years ago
Verified
eaa3e8950bf4878f20ed826108d823d87b958726

Add example with coveralls and GHA

LLumaKernel committed 5 years ago
Verified
999cf62ada77c3176b42828d3d1317d04d3ef220

Update README.md

LLumaKernel committed 5 years ago
Verified
45dcb5e36809ebb37864c7ff5e46b78d542532e7

Update README.md

LLumaKernel committed 5 years ago
Verified
b14f2a8784f74b3fd1112e2282c516aa9824f19b

Update README.md

LLumaKernel committed 5 years ago

README

The README file for this repository.

vcov - Vim Script coverage tool

Powered by vital.vim

Dependencies

  • Vim or neovim

Installation

Clone and pass the vcov/bin path to PATH environment.

Usage

  1. Take a profile by yourself.
" vimscript
profile start vim.profile
profile! file autoload/**/*.vim

" ...
  1. Transform vim profile into lcov info file by vcov.
$ vcov vim.profile  # -> vim.profile.lcov.info
$ # or you can specify output file
$ vcov vim.profile -o lcov.info
  1. Send it by coverage tools or genhtml to see the result locally.
$ genhtml lcov.info
$ # open index.html in your favorite browser

Mereg multiple profiles

Accepts multiple profiles.

$ vcov vim1.profile vim2.profile vim3.profile -o merged.info

For more information

$ vcov --help

Configuration

Set below environment variables to change the behavior.

  • VCOV_VIM : Vim/neovim executable path. ( default: vim )
  • VCOV_HOME : The directory of this repository.

Examples

Recommended you use as newer version of vim as possible. Older versions of vim is not supported to produce the proper profile data. (Checked: Vim 8.2 or above, neovim v0.4.3 or above)

Also please use newer version of vcov.

vcov with vim-themis on Linux and Windows

GitHub Actions with coverallsapp/github-action

on Linux

# Take profile to vim.profile

  - name: Install vcov
    run: git clone --depth 1 --branch v0.2.0 --single-branch https://github.com/LumaKernel/vcov $HOME/vcov


  - name: Make coverage report
    run: |
      export PATH=$HOME/vcov/bin:$PATH
      vcov --version
      vcov vim.profile -o lcov.info

  - name: Coveralls
    uses: coverallsapp/github-action@master
    with:
      path-to-lcov: ./lcov.info
      github-token: ${{ secrets.GITHUB_TOKEN }}

on Windows

# Take profile to vim.profile

  - name: Install vcov
    run: git clone --depth 1 --branch v0.2.0 --single-branch https://github.com/LumaKernel/vcov $env:USERPROFILE/vcov


  - name: Make coverage report
    run: |
      $env:PATH = "$env:USERPROFILE/vcov/bin;$env:PATH"
      vcov --version
      vcov vim.profile -o lcov.info

  - name: Coveralls
    uses: coverallsapp/github-action@master
    with:
      path-to-lcov: ./lcov.info
      github-token: ${{ secrets.GITHUB_TOKEN }}

Contributing

Any of patches, issues, and wiki pages are welcome !

VS Vimjas/covimerage

  • Work with the number of line hits.
  • Based on lcov(1), so you can use genhtml(1) to check the result.

Thanks

Licenese

Unlicense