feat: add --verbose option to the CLI to pretty print commits

tomtom-international · Dec 7, 2023 · 67937cc · 67937cc
1 parent 73249e0
commit 67937cc
Show file tree

Hide file tree

Showing 7 changed files with 255 additions and 63 deletions.
diff --git a/dist/bump/index.js b/dist/bump/index.js
diff --git a/dist/cli/index.js b/dist/cli/index.js
diff --git a/dist/validate/index.js b/dist/validate/index.js
diff --git a/docs/cli.md b/docs/cli.md
@@ -31,16 +31,21 @@ Usage: commisery check [options] [TARGET...]
 Checks whether commit messages adhere to the Conventional Commits standard.
 
 Arguments:
-  TARGET      The `TARGET` can be:
+  TARGET         The `TARGET` can be:
     - a single commit hash
     - a file containing the commit message to check
     - a revision range that `git rev-list` can interpret
    When TARGET is omitted, 'HEAD' is implied.
 
 Options:
-  -h, --help  display help for command
+  -v, --verbose  Prints the commit message metadata (default: false)
+  -h, --help     display help for command
 ```
 
+> :bulb: the `--verbose` will provide an overview of the parsed Conventional Commits elements.
+> This can be valuable to investigate scenarios in which you expected a different version bump than
+> the actual output of the `bump`-action.
+
 ### (Pre-) Commit hook
 
 You can use the CLI as a hook in Git to check messages you wrote by creating a `.git/hooks/commit-msg` file with these contents: