@@ -15,6 +15,13 @@ bashunit --help # Show help
1515bashunit --version # Show version
1616```
1717
18+ ## Argument Notation
19+
20+ | Syntax | Meaning |
21+ | ----------| ------------------------------------------|
22+ | ` <arg> ` | Required - must be provided |
23+ | ` [arg] ` | Optional - can be omitted (uses default) |
24+
1825## test
1926
2027> ` bashunit test [path] [options] `
@@ -69,7 +76,7 @@ bashunit test tests/ --parallel --simple
6976| ` --coverage ` | Enable code coverage tracking |
7077| ` --coverage-paths <paths> ` | Paths to track (default: auto-discover) |
7178| ` --coverage-exclude <pat> ` | Exclusion patterns |
72- | ` --coverage-report < file> ` | LCOV output path (default: ` coverage/lcov.info ` ) |
79+ | ` --coverage-report [ file] ` | LCOV output path (default: ` coverage/lcov.info ` ) |
7380| ` --coverage-report-html [dir] ` | Generate HTML report (default: ` coverage/html ` ) |
7481| ` --coverage-min <percent> ` | Minimum coverage threshold |
7582| ` --no-coverage-report ` | Console output only, no LCOV file |
@@ -313,7 +320,7 @@ bashunit test tests/ --coverage --coverage-paths src/,lib/ --coverage-min 80
313320| ` --coverage ` | Enable coverage tracking |
314321| ` --coverage-paths <paths> ` | Comma-separated paths to track (default: auto-discover from test files) |
315322| ` --coverage-exclude <patterns> ` | Comma-separated patterns to exclude (default: ` tests/*,vendor/*,*_test.sh ` ) |
316- | ` --coverage-report < file> ` | LCOV output file path (default: ` coverage/lcov.info ` ) |
323+ | ` --coverage-report [ file] ` | LCOV output file path (default: ` coverage/lcov.info ` ) |
317324| ` --coverage-report-html [dir] ` | Generate HTML report (default: ` coverage/html ` ) |
318325| ` --coverage-min <percent> ` | Minimum coverage percentage; fails if below |
319326| ` --no-coverage-report ` | Show console report only, don't generate LCOV file |
0 commit comments