Skip to content

Commit 899e6a8

Browse files
committed
All option-arguments are required and should be documented with "<>" instead of "[]".
1 parent 399e295 commit 899e6a8

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

markdownlint.js

+7-7
Original file line numberDiff line numberDiff line change
@@ -199,18 +199,18 @@ program
199199
.version(pkg.version)
200200
.description(pkg.description)
201201
.usage('[options] <files|directories|globs>')
202-
.option('-c, --config [configFile]', 'configuration file (JSON, JSONC, JS, or YAML)')
202+
.option('-c, --config <configFile>', 'configuration file (JSON, JSONC, JS, or YAML)')
203203
.option('-d, --dot', 'include files/folders with a dot (for example `.github`)')
204204
.option('-f, --fix', 'fix basic errors (does not work with STDIN)')
205-
.option('-i, --ignore [file|directory|glob]', 'file(s) to ignore/exclude', concatArray, [])
205+
.option('-i, --ignore <file|directory|glob>', 'file(s) to ignore/exclude', concatArray, [])
206206
.option('-j, --json', 'write issues in json format')
207-
.option('-o, --output [outputFile]', 'write issues to file (no console)')
208-
.option('-p, --ignore-path [file]', 'path to file with ignore pattern(s)')
207+
.option('-o, --output <outputFile>', 'write issues to file (no console)')
208+
.option('-p, --ignore-path <file>', 'path to file with ignore pattern(s)')
209209
.option('-q, --quiet', 'do not write issues to STDOUT')
210-
.option('-r, --rules [file|directory|glob|package]', 'include custom rule files', concatArray, [])
210+
.option('-r, --rules <file|directory|glob|package>', 'include custom rule files', concatArray, [])
211211
.option('-s, --stdin', 'read from STDIN (does not work with files)')
212-
.option('--enable [rules...]', 'Enable certain rules, e.g. --enable MD013 MD041 --')
213-
.option('--disable [rules...]', 'Disable certain rules, e.g. --disable MD013 MD041 --');
212+
.option('--enable <rules...>', 'Enable certain rules, e.g. --enable MD013 MD041 --')
213+
.option('--disable <rules...>', 'Disable certain rules, e.g. --disable MD013 MD041 --');
214214

215215
program.parse(process.argv);
216216

0 commit comments

Comments
 (0)