cl-coverage-tools

cl-coverage-tools is a Common Lisp library that provides utilities to build and integrate coverage analysis tools. It is designed as a foundation for higher-level coverage reporting systems.

Features

• Collects coverage data during execution.
• Provides processing utilities to associate data with source files.
• Can be used as a backend for custom coverage tools or integrations.

Usage

1. Enable coverage collection:

   (cl-coverage-tools:enable-coverage)

2. Run your test suite as usual. During execution, coverage data will be recorded.

3. Process the collected coverage data:

   (cl-coverage-tools:process-coverage-data (find-package :my-package) "src/my-file.lisp")

• :my-package → the package being tested.
• "src/my-file.lisp" → the file associated with that package.

This will produce structured coverage data that can be used for reporting or further analysis.

Installation

Clone this repository and load it with ASDF:

(asdf:load-system "cl-coverage-tools")

Or include it in your project via Quicklisp once it’s available there.

Reporters available

CLI Reporter

(asdf:load-system "cl-coverage-reporter.cli")

(cl-coverage-reporter.cli:report systems)

COV Reporter

The cov reporter write a file with an .cov extension next to the actual file. This file can be loaded by an emacs plug-in to show all the lines been covered.

(asdf:load-system "cl-coverage-reporter.cov")

(cl-coverage-reporter.cov:report systems)

License

This project is licensed under the Unlicense. You are free to use, modify, and distribute it without restriction.