Skip to content

Commit 6d2242e

Browse files
authored
add CLI readme + add to root readme (#48)
* add CLI readme + add to root readme * fix typo
1 parent 2c55c1c commit 6d2242e

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,13 @@ for (let file of files) {
8787
coverage_data.push(...parse_coverage(json_content))
8888
}
8989
```
90+
91+
## CLI
92+
93+
Use the CLI tool (`css-coverage`) to check if coverage meets minimum requirements, globally and/or per file.
94+
95+
```sh
96+
css-coverage --coverage-dir=<dir> --min-coverage=<number> [options]
97+
```
98+
99+
[CLI docs](src/cli/README.md)

src/cli/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# CSS Code Coverage CLI
2+
3+
```
4+
USAGE
5+
$ css-coverage --coverage-dir=<dir> --min-coverage=<number> [options]
6+
7+
OPTIONS
8+
Required:
9+
--coverage-dir Where your Coverage JSON files are
10+
--min-coverage Minimum overall CSS coverage [0-1]
11+
12+
Optional:
13+
--min-file-coverage Minimal coverage per file [0-1]
14+
15+
--show-uncovered Which files to show when not meeting
16+
the --min-file-line-coverage threshold
17+
• violations [default] show under-threshold files
18+
• all show partially covered files
19+
• none do not show files
20+
21+
--reporter How to show the results
22+
• pretty [default]
23+
• tap
24+
• json
25+
26+
EXAMPLES
27+
# analyze all .json files in ./coverage; require 80% overall coverage
28+
$ css-coverage --coverage-dir=./coverage --min-coverage=0.8
29+
30+
# Require 50% coverage per file
31+
$ css-coverage --coverage-dir=./coverage --min-coverage=0.8 --min-file-coverage=0.5
32+
33+
Report JSON
34+
$ css-coverage --coverage-dir=./coverage --min-coverage=0.8 --reporter=json
35+
```

0 commit comments

Comments
 (0)