feat: 🎸 improve help screen

JeromeFitz · Feb 1, 2020 · 1838c1c · 1838c1c
1 parent 799fff2
commit 1838c1c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/lib/parseArgs.js b/lib/parseArgs.js
@@ -53,18 +53,18 @@ const options = {
         Usage: git-cz [options]
 
         options:
-            -h, --help         show usage information
-            -v, --version      print version info and exit
-            --non-interactive [non-interactive cli params] run git-cz non-interactive mode
+            -h, --help          show usage information
+            -v, --version       print version info and exit
+            --non-interactive   run git-cz in non-interactive mode
         
-        non-interactive cli params:
-            --type
-            --subject
-            --scope
-            --body
-            --breaking
-            --issues
-            --lerna
+        non-interactive mode options:
+            --type              type of the commit, defaults to "chore"
+            --subject           message of the commit, defaults to "automated commit"
+            --scope             semantic commit scope
+            --body              extended description of the commit
+            --breaking          description of breaking changes, if any
+            --issues            GitHub issues this commit closed, e.g "#123"
+            --lerna             Lerna mono-repo packages this commit affects
     `
 };
 

diff --git a/lib/util/getGitRootDir.js b/lib/util/getGitRootDir.js
@@ -1,7 +1,7 @@
 const {execSync} = require('child_process');
 
 const getGitRootDir = () => {
-  const devNull = process.platform === 'win32' ? ' nul' : '/dev/null'
+  const devNull = process.platform === 'win32' ? ' nul' : '/dev/null';
   const dir = execSync('git rev-parse --show-toplevel 2>' + devNull)
     .toString()
     .trim();