diff --git a/README.md b/README.md index e991947..7be6969 100644 --- a/README.md +++ b/README.md @@ -87,3 +87,13 @@ for (let file of files) { coverage_data.push(...parse_coverage(json_content)) } ``` + +## CLI + +Use the CLI tool (`css-coverage`) to check if coverage meets minimum requirements, globally and/or per file. + +```sh +css-coverage --coverage-dir= --min-coverage= [options] +``` + +[CLI docs](src/cli/README.md) diff --git a/src/cli/README.md b/src/cli/README.md new file mode 100644 index 0000000..100e3d4 --- /dev/null +++ b/src/cli/README.md @@ -0,0 +1,35 @@ +# CSS Code Coverage CLI + +``` +USAGE + $ css-coverage --coverage-dir= --min-coverage= [options] + +OPTIONS +Required: + --coverage-dir Where your Coverage JSON files are + --min-coverage Minimum overall CSS coverage [0-1] + +Optional: + --min-file-coverage Minimal coverage per file [0-1] + + --show-uncovered Which files to show when not meeting + the --min-file-line-coverage threshold + • violations [default] show under-threshold files + • all show partially covered files + • none do not show files + + --reporter How to show the results + • pretty [default] + • tap + • json + +EXAMPLES + # analyze all .json files in ./coverage; require 80% overall coverage + $ css-coverage --coverage-dir=./coverage --min-coverage=0.8 + + # Require 50% coverage per file + $ css-coverage --coverage-dir=./coverage --min-coverage=0.8 --min-file-coverage=0.5 + + Report JSON + $ css-coverage --coverage-dir=./coverage --min-coverage=0.8 --reporter=json +```