Skip to content

Commit

Permalink
Removed: ert-runner requirement for automatic report generation
Browse files Browse the repository at this point in the history
  • Loading branch information
sviridov committed Oct 8, 2014
1 parent 76b5115 commit ff1529a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 11 deletions.
10 changes: 2 additions & 8 deletions README.md
Expand Up @@ -6,7 +6,7 @@ A test coverage library for [Emacs Lisp](http://www.gnu.org/software/emacs/manua

`undercover.el` is on earlier stage of development and has some important issues:

- it assumes a certain development cycle of your package (using [Cask](https://github.com/cask/cask), [ert-runner](https://github.com/rejeep/ert-runner.el), [Travis CI](https://travis-ci.org/) and [Coveralls](https://coveralls.io/));
- it assumes a certain development cycle of your package (using [Cask](https://github.com/cask/cask), [Travis CI](https://travis-ci.org/) and [Coveralls](https://coveralls.io/));
- it based on `edebug` and can have some issues with errors and macros coverage.

## Installation
Expand All @@ -23,7 +23,7 @@ A test coverage library for [Emacs Lisp](http://www.gnu.org/software/emacs/manua
(depends-on "undercover"))
```

- Before `load` or `require` your package in `test/test-helper.el`, call `undercover` with regular expression that will match package files:
- Before `load` or `require` your package in `test/test-helper.el` (or analogue), call `undercover` with regular expression that will match package files:

```lisp
(require 'undercover)
Expand All @@ -32,10 +32,4 @@ A test coverage library for [Emacs Lisp](http://www.gnu.org/software/emacs/manua
(require 'awesome-package)
```

- Add this line unless you are using [ert-runner](https://github.com/rejeep/ert-runner.el):

```lisp
(undercover-report-on-kill)
```

- Add your repository to [Coveralls](https://coveralls.io/).
5 changes: 2 additions & 3 deletions undercover.el
Expand Up @@ -296,12 +296,11 @@ Posible values of REPORT-TYPE: coveralls."
;;;###autoload
(defun undercover (regexp)
"Enable test coverage for files matched by REGEXP.
If running under `ert-runner' and Travic CI automatically generate report
If running under Travic CI automatically generate report
on `kill-emacs' and send it to coveralls.io."
(when (undercover--coverage-enabled-p)
(undercover--set-edebug-handlers)
(when (getenv "ERT_RUNNER_ARGS")
(undercover-report-on-kill))
(undercover-report-on-kill)
(undercover--edebug-files regexp)))

(provide 'undercover)
Expand Down

0 comments on commit ff1529a

Please sign in to comment.