Skip to content

Commit 9581ee0

Browse files
committed
chore: improve readme options
1 parent af5b81f commit 9581ee0

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,15 @@ diff-coverage coverage.xml --diff-file diff.diff --output json=diff-cover.json -
2626
diff-coverage coverage.xml --diff-file diff.diff --skip-coverage-path '^pkg/mongodb'
2727
```
2828

29-
Options
30-
- --diff-file <PATH>: diff to analyze
31-
- --fail-under <PERCENT>: minimum acceptable diff coverage
32-
- --missing-coverage <MODE>: how to handle files missing from coverage (uncovered or ignore, default: ignore)
33-
- --skip-coverage-path <REGEX>: regex of file paths to skip from uncovered line calculations (repeatable or comma-separated)
34-
- --output <FORMAT=PATH>: output target(s), repeatable or comma‑separated Formats: cli, summary, gitlab, json (note: cli and summary don’t take a path)
35-
- -h, --help: show help
36-
- -V, --version: show version
29+
## Options
30+
31+
- <a id="diff-file"></a>`--diff-file <PATH>`: diff to analyze
32+
- <a id="fail-under"></a>`--fail-under <PERCENT>`: minimum acceptable diff coverage
33+
- <a id="missing-coverage"></a>`--missing-coverage <MODE>`: how to handle files missing from coverage (uncovered or ignore, default: ignore)
34+
- <a id="skip-coverage-path"></a>`--skip-coverage-path <REGEX>`: regex of file paths to skip from uncovered line calculations (repeatable or comma-separated)
35+
- <a id="output"></a>`--output <FORMAT=PATH>`: output target(s), repeatable or comma‑separated Formats: cli, summary, gitlab, json (note: cli and summary don’t take a path)
36+
- <a id="help"></a>`-h, --help`: show help
37+
- <a id="version"></a>`-V, --version`: show version
3738

3839
## Performance highlights
3940

0 commit comments

Comments
 (0)