https://github.com/spacewander/luacov-console
Combine luacov with your development cycle and CI
https://github.com/spacewander/luacov-console
Last synced: over 1 year ago
JSON representation
Combine luacov with your development cycle and CI
- Host: GitHub
- URL: https://github.com/spacewander/luacov-console
- Owner: spacewander
- License: mit
- Created: 2016-10-01T13:24:07.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-12-08T05:11:24.000Z (over 1 year ago)
- Last Synced: 2025-03-28T15:04:33.512Z (over 1 year ago)
- Language: Lua
- Homepage:
- Size: 53.7 KB
- Stars: 17
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# luacov-console
Luacov-console is a luacov reporter makes it easier for your development cycle and CI.
## Usage
1. Run tests with [luacov](https://github.com/keplerproject/luacov) enabled.
2. Run `luacov-console [workdir]` to generate `luacov.report.out` and `luacov.report.out.index`.
Unlike luacov, luacov-console also counts lua files under `workdir` which weren't touched by tests.
3. Run `luacov-console -s` to see the summary of coverage results.
4. Run `luacov-console -l [lua pattern1] [lua pattern2]` to see the report of matched files.
5. Run `luacov-console -s -l [lua pattern1] [lua pattern2]` to see the summary only for matched files.
## Installation
`[sudo] luarocks install luacov-console`
## Commandline options
```
$ luacov-console -h
Usage: luacov-console [--no-colored] [-s] [-h] []
[-l [] ...]
Combine luacov with your development cycle and CI
Arguments:
workdir Specific the source directory (default: .)
Options:
--no-colored Don't print with color.
-l [] ..., --list [] ...
List coverage results of files matched given lua pattern(s).
-s, --summary Show coverage summary.
-h, --help Show this help message and exit.
```
## TODO
- [ ] Make index file optional.
- [ ] Customize color schema.