fix: don't put multiple newlines between flag summaries in help output (

#225)
oclif · Aug 6, 2021 · bfbd15c · bfbd15c
1 parent 11cbd6b
commit bfbd15c
Show file tree

Hide file tree

Showing 6 changed files with 610 additions and 607 deletions.
diff --git a/package.json b/package.json
@@ -96,7 +96,7 @@
     "lint": "eslint . --ext .ts --config .eslintrc",
     "posttest": "yarn lint",
     "prepack": "yarn run build",
-    "test": "mocha --forbid-only \"test/**/*.test.ts\" --no-color",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "pretest": "yarn build --noEmit && tsc -p test --noEmit"
   },
   "types": "lib/index.d.ts"

diff --git a/src/help/formatter.ts b/src/help/formatter.ts
@@ -151,8 +151,8 @@ export class HelpFormatter {
       }
       // if we start putting too many lines down, render in multiline format
       if (lines.length > 4) return renderMultiline()
-      // if spacer is not defined, separate all rows with extra newline
-      if (!opts.spacer) spacer = '\n\n'
+      // if spacer is not defined, separate all rows with a newline
+      if (!opts.spacer) spacer = '\n'
       cur += '\n'
       cur += this.indent(lines.join('\n'), maxLength + 2)
     }

diff --git a/test/help/format-command-with-options.test.ts b/test/help/format-command-with-options.test.ts
@@ -87,15 +87,11 @@ ARGUMENTS
 OPTIONS
   -f, --foo=foo        foobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoo
                        barfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobar
-
   -l=label
-
   -r, --remote=remote
-
   --force              force  it force  it force  it force  it force  it force
                        it force  it force  it force  it force  it force  it
                        force  it force  it force  it force  it
-
   --ss                 newliney
                        newliney
                        newliney
@@ -142,13 +138,10 @@ ARGUMENTS
 OPTIONS
   -f, --foo=foo        foobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoo
                        barfoobarfoobarfoobarfoobarfoobar
-
   -r, --remote=remote
-
   --force              force  it force  it force  it force  it force  it force
                        it force  it force  it force  it force  it force  it
                        force  it force  it force  it force  it
-
   --ss                 newliney
                        newliney
                        newliney

diff --git a/test/help/format-command.test.ts b/test/help/format-command.test.ts
@@ -66,15 +66,11 @@ ARGUMENTS
 FLAGS
   -f, --foo=<value>     foobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfo
                         obarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobar
-
   -l=<value>
-
   -r, --remote=<value>
-
   --force               force  it force  it force  it force  it force  it force
                         it force  it force  it force  it force  it force  it
                         force  it force  it force  it force  it
-
   --ss                  newliney
                         newliney
                         newliney
@@ -126,13 +122,10 @@ ARGUMENTS
 FLAGS
   -f, --foo=<value>     foobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfo
                         obarfoobarfoobarfoobarfoobarfoobar
-
   -r, --remote=<value>
-
   --force               force  it force  it force  it force  it force  it force
                         it force  it force  it force  it force  it force  it
                         force  it force  it force  it force  it
-
   --ss                  newliney
                         newliney
                         newliney

diff --git a/test/parser/parse.test.ts b/test/parser/parse.test.ts
@@ -3,6 +3,7 @@ import {expect} from 'chai'
 
 import {flags, parse} from '../../src/parser'
 import {Interfaces} from '../../src'
+const stripAnsi = require('strip-ansi')
 
 describe('parse', () => {
   it('--bool', async () => {
@@ -125,7 +126,7 @@ describe('parse', () => {
           },
         })
       } catch (error) {
-        message = error.message
+        message = stripAnsi(error.message)
       }
       expect(message).to.equal(
         'Missing required flag:\n --myflag MYFLAG  flag description\nSee more help with --help',