Skip to content

fix: update --coverage-dir examples #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bartveneman merged 2 commits into from
Apr 19, 2026
Merged

fix: update --coverage-dir examples #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
637b171
fix: rm `--coverage-dir` examples
bartveneman Apr 19, 2026
bc34532
rm more `$ ` cli example prefixes
bartveneman Apr 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ for (let file of files) {
Use the CLI tool (`css-coverage`) to check if coverage meets minimum requirements, globally and/or per file.

```sh
css-coverage --coverage-dir=<dir> --min-coverage=<number> [options]
css-coverage <coverage-dir> --min-coverage=<number> [options]
```

[CLI docs](src/cli/README.md)
11 changes: 7 additions & 4 deletions src/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@

```
USAGE
$ css-coverage --coverage-dir=<dir> --min-coverage=<number> [options]
css-coverage <coverage-dir> --min-coverage=<number> [options]

ARGUMENTS
<coverage-dir> Where your Coverage JSON files are

OPTIONS
Required:
Expand All @@ -25,11 +28,11 @@ Optional:

EXAMPLES
# analyze all .json files in ./coverage; require 80% overall coverage
$ css-coverage --coverage-dir=./coverage --min-coverage=0.8
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
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
css-coverage --coverage-dir=./coverage --min-coverage=0.8 --reporter=json
```
10 changes: 5 additions & 5 deletions src/cli/help.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ import { styleText } from 'node:util'
export function help() {
return `
${styleText(['bold'], 'USAGE')}
$ css-coverage <coverage-dir> --min-coverage=<number> [options]
css-coverage <coverage-dir> --min-coverage=<number> [options]

${styleText('bold', 'ARGUMENTS')}
<coverage-dir> Where your Coverage JSON files are
<coverage-dir> Where your coverage JSON files are

${styleText('bold', 'OPTIONS')}
Required:
Expand All @@ -28,12 +28,12 @@ Optional:

${styleText('bold', 'EXAMPLES')}
${styleText('dim', '# analyze all .json files in ./coverage; require 80% overall coverage')}
$ css-coverage ./coverage --min-coverage=0.8
css-coverage ./coverage --min-coverage=0.8

${styleText('dim', '# Require 50% coverage per file')}
$ css-coverage ./coverage --min-coverage=0.8 --min-file-coverage=0.5
css-coverage ./coverage --min-coverage=0.8 --min-file-coverage=0.5

${styleText('dim', 'Report JSON')}
$ css-coverage ./coverage --min-coverage=0.8 --reporter=json
css-coverage ./coverage --min-coverage=0.8 --reporter=json
`.trim()
}
Loading