https://github.com/twada/coverlay.el

Test coverage overlay for Emacs
https://github.com/twada/coverlay.el

Last synced: 25 days ago
JSON representation

Test coverage overlay for Emacs

• Host: GitHub
• URL: https://github.com/twada/coverlay.el
• Owner: twada
• Created: 2011-09-18T06:55:11.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2022-06-24T18:42:56.000Z (over 2 years ago)
• Last Synced: 2024-10-14T20:56:17.375Z (29 days ago)
• Language: Emacs Lisp
• Homepage:
• Size: 223 KB
• Stars: 83
• Watchers: 6
• Forks: 15
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
coverlay.el

================================

Test coverage overlay for Emacs

[![MELPA](https://melpa.org/packages/coverlay-badge.svg)](https://melpa.org/#/coverlay)

DESCRIPTION

---------------------------------------

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

![coverlay demo](https://raw.githubusercontent.com/twada/coverlay.el/master/img/coverlay_demo.png "coverlay demo")

`coverlay.el` supports widely used [LCOV format](http://ltp.sourceforge.net/coverage/lcov/geninfo.1.php). (for example, [Coveralls](https://coveralls.io/) uses lcov format)

INSTALL

---------------------------------------

With GNU Emacs 24 or later, you can use its [package](https://www.gnu.org/software/emacs/manual/html_node/emacs/Packages.html) feature to install coverlay.el from [MELPA](http://melpa.org/).

    M-x package-install coverlay

HOW TO USE

---------------------------------------

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

    M-x global-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

---------------------------------------

* [Takuto Wada](http://github.com/twada)

CONTRIBUTORS

---------------------------------------

* [syohex](https://github.com/syohex)

* [FossiFoo](https://github.com/fossifoo)

* [kytwb](https://github.com/kytwb)

* [tadsan](https://github.com/zonuexe)

* [nloyola](https://github.com/nloyola)

LICENSE

---------------------------------------

Licensed under the GPLv3 license.