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

conventional-changelog · Aug 2, 2024 · bc9bdcf · bc9bdcf
1 parent 9c7c3bf
commit bc9bdcf
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/@commitlint/cli/src/cli.test.ts b/@commitlint/cli/src/cli.test.ts
@@ -556,6 +556,7 @@ test('should print help', async () => {
 		  -t, --to             upper end of the commit range to lint; applies if edit=false  [string]
 		  -V, --verbose        enable verbose output for reports without problems  [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]"
 	`);

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]
 ```