/coverlay.el

Test coverage overlay for Emacs

Primary LanguageEmacs Lisp

coverlay.el

Test coverage overlay for Emacs

MELPA

DESCRIPTION

coverlay.el is an emacs plugin to highlight untested lines.

coverlay demo

coverlay.el supports widely used LCOV format. (for example, Coveralls uses lcov format)

INSTALL

With GNU Emacs 24 or later, you can use its package feature to install coverlay.el from MELPA.

M-x package-install coverlay

HOW TO USE

Coverlay contains a global mode that will highlight missed lines on every covered file.

M-x coverlay-mode

Load a lcov file and keep watching it for changes.

M-x coverlay-watch-file /path/to/lcov-file

Alternativly just read the coverage file once.

M-x coverlay-load-file /path/to/lcov-file

This command is bound to "C-c C-l f" by default.

And reread current coverage file

M-x coverlay-reload-file

This command is bound to "C-c C-l g" by default.

Coverage information about all files included in the coverage file can be displayed in a list.

M-x coverlay-display-stats

This command is bound to "C-c C-l s" by default.

You can also manually toggle the overlays in the current buffer.

M-x coverlay-toggle-overlays

This command is bound to "C-c C-l l" by default.

customization

Some values can be customized via customize. This includes the possibility to set a base path if the filenames in the coverage file are relative.

AUTHOR

CONTRIBUTORS

LICENSE

Licensed under the GPLv3 license.