fix: remove the trailing white spaces from the help output (#1090)

BREAKING CHANGE: tests that assert against help output will need to be updated
yargs · Apr 7, 2018 · 3f0746c · 3f0746c
1 parent ead118a
commit 3f0746c
Show file tree

Hide file tree

Showing 5 changed files with 90 additions and 163 deletions.
diff --git a/lib/usage.js b/lib/usage.js
@@ -45,7 +45,10 @@ module.exports = function usage (yargs, y18n) {
       // don't output failure message more than once
       if (!failureOutput) {
         failureOutput = true
-        if (showHelpOnFail) yargs.showHelp('error')
+        if (showHelpOnFail) {
+          yargs.showHelp('error')
+          logger.error()
+        }
         if (msg || err) logger.error(msg || err)
         if (failMessage) {
           if (msg || err) logger.error('')
@@ -346,7 +349,8 @@ module.exports = function usage (yargs, y18n) {
       ui.div(`${e}\n`)
     }
 
-    return ui.toString()
+    // Remove the trailing white spaces
+    return ui.toString().replace(/\s*$/, '')
   }
 
   // return the maximum width of a string

diff --git a/test/command.js b/test/command.js
@@ -519,8 +519,7 @@ describe('Command', () => {
         '  usage dream [command] [opts]  Go to sleep and dream',
         'Options:',
         '  --help     Show help  [boolean]',
-        '  --version  Show version number  [boolean]',
-        ''
+        '  --version  Show version number  [boolean]'
       ])
     })
 
@@ -541,8 +540,7 @@ describe('Command', () => {
         '  --help     Show help  [boolean]',
         '  --version  Show version number  [boolean]',
         '  --shared   Is the dream shared with others?  [boolean]',
-        '  --extract  Attempt extraction?  [boolean]',
-        ''
+        '  --extract  Attempt extraction?  [boolean]'
       ])
     })
 
@@ -562,8 +560,7 @@ describe('Command', () => {
         '  usage dream [command] [opts]           Go to sleep and dream',
         'Options:',
         '  --help     Show help  [boolean]',
-        '  --version  Show version number  [boolean]',
-        ''
+        '  --version  Show version number  [boolean]'
       ])
     })
 
@@ -593,8 +590,7 @@ describe('Command', () => {
       r.logs.join('\n').split(/\n+/).should.deep.equal([
         'Options:',
         '  --help     Show help  [boolean]',
-        '  --version  Show version number  [boolean]',
-        ''
+        '  --version  Show version number  [boolean]'
       ])
     })
 
@@ -610,8 +606,7 @@ describe('Command', () => {
         'Attempts to (re)apply its own dir',
         'Options:',
         '  --help     Show help  [boolean]',
-        '  --version  Show version number  [boolean]',
-        ''
+        '  --version  Show version number  [boolean]'
       ])
     })
 
@@ -628,8 +623,7 @@ describe('Command', () => {
         '  usage nameless  Command name derived from module filename',
         'Options:',
         '  --help     Show help  [boolean]',
-        '  --version  Show version number  [boolean]',
-        ''
+        '  --version  Show version number  [boolean]'
       ])
     })
   })
@@ -684,17 +678,15 @@ describe('Command', () => {
         '  command cmd sub  Run the subcommand',
         'Options:',
         '  --help     Show help  [boolean]',
-        '  --version  Show version number  [boolean]',
-        ''
+        '  --version  Show version number  [boolean]'
       ]
 
       const expectedSub = [
         'command cmd sub',
         'Run the subcommand',
         'Options:',
         '  --help     Show help  [boolean]',
-        '  --version  Show version number  [boolean]',
-        ''
+        '  --version  Show version number  [boolean]'
       ]
 
       // no help is output if help isn't last