feat: support command line options from a file (#4109)

* docs: add missing CLI options * feat: support CLI options from JSON file or Common.js module
conventional-changelog · Aug 3, 2024 · a20e890 · a20e890
1 parent 722d8ff
commit a20e890
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
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
@@ -3,7 +3,7 @@
 ```sh
 ❯ npx commitlint --help
 
-@commitlint/cli@11.0.0 - Lint your commit messages
+@commitlint/cli@19.3.0 - Lint your commit messages
 
 [input] reads from stdin if --edit, --env, --from and --to are omitted
 
@@ -22,6 +22,10 @@ Options:
   -H, --help-url       help url in error message                        [string]
   -f, --from           lower end of the commit range to lint; applies if
                        edit=false                                       [string]
+      --git-log-args   additional git log arguments as space separated string,
+                       example '--first-parent --cherry-pick'           [string]
+  -l, --last           just analyze the last commit; applies if edit=false
+                                                                       [boolean]
   -o, --format         output format of the results                     [string]
   -p, --parser-preset  configuration preset to use for
                        conventional-commits-parser                      [string]
@@ -30,6 +34,10 @@ Options:
                        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]
 ```