From 899e6a81943beb6b22ca4b9ab398cda1d3dac127 Mon Sep 17 00:00:00 2001 From: David Anson Date: Sat, 27 Apr 2024 22:15:06 -0700 Subject: [PATCH] All option-arguments are required and should be documented with "<>" instead of "[]". --- markdownlint.js | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/markdownlint.js b/markdownlint.js index 8374ebc86..d8868ecc0 100755 --- a/markdownlint.js +++ b/markdownlint.js @@ -199,18 +199,18 @@ program .version(pkg.version) .description(pkg.description) .usage('[options] ') - .option('-c, --config [configFile]', 'configuration file (JSON, JSONC, JS, or YAML)') + .option('-c, --config ', 'configuration file (JSON, JSONC, JS, or YAML)') .option('-d, --dot', 'include files/folders with a dot (for example `.github`)') .option('-f, --fix', 'fix basic errors (does not work with STDIN)') - .option('-i, --ignore [file|directory|glob]', 'file(s) to ignore/exclude', concatArray, []) + .option('-i, --ignore ', 'file(s) to ignore/exclude', concatArray, []) .option('-j, --json', 'write issues in json format') - .option('-o, --output [outputFile]', 'write issues to file (no console)') - .option('-p, --ignore-path [file]', 'path to file with ignore pattern(s)') + .option('-o, --output ', 'write issues to file (no console)') + .option('-p, --ignore-path ', 'path to file with ignore pattern(s)') .option('-q, --quiet', 'do not write issues to STDOUT') - .option('-r, --rules [file|directory|glob|package]', 'include custom rule files', concatArray, []) + .option('-r, --rules ', 'include custom rule files', concatArray, []) .option('-s, --stdin', 'read from STDIN (does not work with files)') - .option('--enable [rules...]', 'Enable certain rules, e.g. --enable MD013 MD041 --') - .option('--disable [rules...]', 'Disable certain rules, e.g. --disable MD013 MD041 --'); + .option('--enable ', 'Enable certain rules, e.g. --enable MD013 MD041 --') + .option('--disable ', 'Disable certain rules, e.g. --disable MD013 MD041 --'); program.parse(process.argv);