docs: add result info to config option #4241 (#4145)

conventional-changelog · Sep 11, 2024 · aacc345 · aacc345
1 parent 7e79af1
commit aacc345
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/@commitlint/cli/src/cli.test.ts b/@commitlint/cli/src/cli.test.ts
@@ -581,7 +581,7 @@ test('should print help', async () => {
 
 		Options:
 		  -c, --color          toggle colored output  [boolean] [default: true]
-		  -g, --config         path to the config file  [string]
+		  -g, --config         path to the config file; result code 9 if config is missing  [string]
 		      --print-config   print resolved config  [string] [choices: "", "text", "json"]
 		  -d, --cwd            directory to execute in  [string] [default: (Working Directory)]
 		  -e, --edit           read last commit message from the specified file or fallbacks to ./.git/COMMIT_EDITMSG  [string]

diff --git a/@commitlint/cli/src/cli.ts b/@commitlint/cli/src/cli.ts
@@ -47,7 +47,8 @@ const cli = yargs(process.argv.slice(2))
 		},
 		config: {
 			alias: 'g',
-			description: 'path to the config file',
+			description:
+				'path to the config file; result code 9 if config is missing',
 			type: 'string',
 		},
 		'print-config': {

diff --git a/docs/reference/cli.md b/docs/reference/cli.md
@@ -3,13 +3,14 @@
 ```sh
 ❯ npx commitlint --help
 
-@commitlint/cli@19.3.0 - Lint your commit messages
+@commitlint/cli@19.5.0 - Lint your commit messages
 
 [input] reads from stdin if --edit, --env, --from and --to are omitted
 
 Options:
   -c, --color          toggle colored output           [boolean] [default: true]
-  -g, --config         path to the config file                          [string]
+  -g, --config         path to the config file; result code 9 if config is
+                       missing                                          [string]
       --print-config   print resolved config
                                           [string] [choices: "", "text", "json"]
   -d, --cwd            directory to execute in