From 637b1715c455eb1d37d5269741b5d28b339e640b Mon Sep 17 00:00:00 2001 From: Bart Veneman Date: Sun, 19 Apr 2026 10:33:46 +0200 Subject: [PATCH 1/2] fix: rm `--coverage-dir` examples --- README.md | 2 +- src/cli/README.md | 5 ++++- src/cli/help.ts | 10 +++++----- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7be6969..afec454 100644 --- a/README.md +++ b/README.md @@ -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= --min-coverage= [options] +css-coverage --min-coverage= [options] ``` [CLI docs](src/cli/README.md) diff --git a/src/cli/README.md b/src/cli/README.md index 100e3d4..a06c2da 100644 --- a/src/cli/README.md +++ b/src/cli/README.md @@ -2,7 +2,10 @@ ``` USAGE - $ css-coverage --coverage-dir= --min-coverage= [options] + css-coverage --min-coverage= [options] + +ARGUMENTS + Where your Coverage JSON files are OPTIONS Required: diff --git a/src/cli/help.ts b/src/cli/help.ts index 48bf040..80c6ba9 100644 --- a/src/cli/help.ts +++ b/src/cli/help.ts @@ -3,10 +3,10 @@ import { styleText } from 'node:util' export function help() { return ` ${styleText(['bold'], 'USAGE')} - $ css-coverage --min-coverage= [options] + css-coverage --min-coverage= [options] ${styleText('bold', 'ARGUMENTS')} - Where your Coverage JSON files are + Where your coverage JSON files are ${styleText('bold', 'OPTIONS')} Required: @@ -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() } From bc3453211462587f6eb79e738b8730cb3c486e95 Mon Sep 17 00:00:00 2001 From: Bart Veneman Date: Sun, 19 Apr 2026 10:35:57 +0200 Subject: [PATCH 2/2] rm more `$ ` cli example prefixes --- src/cli/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/cli/README.md b/src/cli/README.md index a06c2da..a2dcbc1 100644 --- a/src/cli/README.md +++ b/src/cli/README.md @@ -28,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 ```