feat: support CLI options from JSON file or Common.js module

conventional-changelog · Jul 31, 2024 · 0a7b1c6 · 0a7b1c6
1 parent ed321d4
commit 0a7b1c6
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/@commitlint/cli/src/cli.ts b/@commitlint/cli/src/cli.ts
@@ -143,6 +143,11 @@ const cli = yargs(process.argv.slice(2))
 	.alias('v', 'version')
 	.help('help')
 	.alias('h', 'help')
+	.config(
+		'options',
+		'path to a JSON file or Common.js module containing CLI options',
+		require
+	)
 	.usage(`${pkg.name}@${pkg.version} - ${pkg.description}\n`)
 	.usage(
 		`[input] reads from stdin if --edit, --env, --from and --to are omitted`

diff --git a/docs/reference/cli.md b/docs/reference/cli.md
@@ -36,6 +36,8 @@ Options:
                                                                        [boolean]
   -s, --strict         enable strict mode; result code 2 for warnings, 3 for
                        errors                                          [boolean]
+      --options        path to a JSON file or Common.js module containing CLI
+                       options
   -v, --version        display version information                     [boolean]
   -h, --help           Show help                                       [boolean]
 ```