This is the cl-coveralls Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 04:48:00 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-coverallsCoverage tracker for Coveralls
Eitaro Fukamachi
BSD 2-Clause
# CL-Coveralls
CL-Coveralls is a helper library to post test coverage to [Coveralls](https://coveralls.io).
## Warning
This software is still ALPHA quality. The APIs will be likely to change.
## Limitations
### Supported implementations
* SBCL
* Clozure CL 1.4-1.9 (Not support 1.10 because it’s broken)
### Supported CI services
* [Travis CI](https://travis-ci.org)
* [CircleCI](https://circleci.com)
* [GitHub Actions](https://docs.github.com/en/actions), there is also
a ready to use action [40ants/run-tests](https://github.com/40ants/run-tests).
### Number of entered
Coveralls allows us to track the number of entered times for each lines, however all Common Lisp coverage tools don’t provide the information. CL-Coveralls posts it as ‘1‘ for all lines entered.
## Usage
CL-Coveralls see if ‘$COVERALLS‘ is bound for deciding whether recording test coverage or not. Don’t forget to set the environment variable before running tests.
“‘
$ COVERALLS=true sbcl –load test-script.lisp –eval ’(sb-ext:exit)’
“‘
In your test script, wrap your test code with ‘coveralls:with-coveralls‘.
“‘common-lisp
(coveralls:with-coveralls ()
;; Run tests
(prove:run :your-app))
“‘
## Examples
* [Lack’s circle.yml](https://github.com/fukamachi/lack/blob/master/circle.yml)
## Author
* Eitaro Fukamachi (e.arrows@gmail.com)
## Copyright
Copyright (c) 2015 Eitaro Fukamachi (e.arrows@gmail.com)
## License
Licensed under the BSD 2-Clause License.
0.1
sb-cover (system).
ironclad (system).
lquery (system).
jonathan (system).
dexador (system).
uiop (system).
cl-ppcre (system).
flexi-streams (system).
alexandria (system).
split-sequence (system).
src (module).
Modules are listed depth-first from the system components tree.
cl-coveralls/srccl-coveralls (system).
cl-coveralls.lisp (file).
service.lisp (file).
git.lisp (file).
impls (module).
util.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-coveralls/cl-coveralls.asdcl-coveralls/src/cl-coveralls.lispcl-coveralls/src/service.lispcl-coveralls/src/git.lispcl-coveralls/src/impls/sbcl.lispcl-coveralls/src/util.lispcl-coveralls/cl-coveralls.asdcl-coveralls (system).
cl-coveralls/src/cl-coveralls.lispservice.lisp (file).
git.lisp (file).
impls (module).
src (module).
calc-coverage (function).
calc-system (function).
with-coveralls (macro).
ensure-string (function).
get-coverage (function).
mask-secret (function).
normalize-exclude-path (function).
parse-report-files (function).
pathname-in-directory-p (function).
report-to-coveralls (function).
cl-coveralls/src/service.lispsrc (module).
commit-sha (function).
project-dir (function).
pull-request-num (function).
service-job-id (function).
service-name (function).
cl-coveralls/src/git.lispservice.lisp (file).
src (module).
author-email (function).
author-name (function).
commit-message (function).
committer-email (function).
committer-name (function).
git-branch (function).
git-sha (function).
git (function).
cl-coveralls/src/impls/sbcl.lispimpls (module).
disable-coverage (function).
enable-coverage (function).
finalize-coverage (function).
get-coverage-from-report-file (function).
initialize-coverage (function).
report-files (function).
source-path-of-report-file (function).
cl-coveralls/src/util.lispsrc (module).
get-report-directory (function).
generate-random-string (function).
Packages are listed by definition order.
cl-coverallscl-coveralls.impls.sbclcl-coveralls.gitcl-coveralls.servicecl-coveralls.utilcl-coveralls-asdcl-coverallscoveralls
common-lisp.
calc-coverage (function).
calc-system (function).
with-coveralls (macro).
ensure-string (function).
get-coverage (function).
mask-secret (function).
normalize-exclude-path (function).
parse-report-files (function).
pathname-in-directory-p (function).
report-to-coveralls (function).
cl-coveralls.impls.sbclcl-coveralls.impls
common-lisp.
disable-coverage (function).
enable-coverage (function).
finalize-coverage (function).
get-coverage-from-report-file (function).
initialize-coverage (function).
report-files (function).
source-path-of-report-file (function).
cl-coveralls.gitcommon-lisp.
author-email (function).
author-name (function).
commit-message (function).
committer-email (function).
committer-name (function).
git-branch (function).
git-sha (function).
git (function).
cl-coveralls.servicecommon-lisp.
commit-sha (function).
project-dir (function).
pull-request-num (function).
service-job-id (function).
service-name (function).
cl-coveralls.utilcommon-lisp.
get-report-directory (function).
generate-random-string (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Sends coverage report to the Coveralls.
If dry run specified or code started not inside one of supported CI service,
then just prints JSON prepared for sending.
| Jump to: | A C D E F G I M N P R S W |
|---|
| Jump to: | A C D E F G I M N P R S W |
|---|
| Jump to: | C F G I M P S U |
|---|
| Jump to: | C F G I M P S U |
|---|