fix: move help into its own section

oclif · Mar 24, 2018 · 8099431 · 8099431
1 parent fa7f72a
commit 8099431
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 5 deletions.
diff --git a/src/root.ts b/src/root.ts
@@ -22,9 +22,9 @@ export default class RootHelp {
     let description = this.config.pjson.oclif.description || this.config.pjson.description || ''
     description = this.render(description)
     description = description.split('\n')[0]
-    description = `${this.config.userAgent}\n${description}`
     let output = compact([
       description,
+      this.version(),
       this.usage(),
       this.description(),
     ]).join('\n\n')
@@ -49,4 +49,12 @@ export default class RootHelp {
       indent(wrap(description, this.opts.maxWidth - 2, {trim: false, hard: true}), 2),
     ].join('\n')
   }
+
+  protected version(): string {
+    return [
+      bold('VERSION'),
+      indent(wrap(this.config.userAgent, this.opts.maxWidth - 2, {trim: false, hard: true}), 2),
+    ].join('\n')
+  }
+
 }
diff --git a/test/commands/help.test.ts b/test/commands/help.test.ts
@@ -50,8 +50,10 @@ OPTIONS
   .stdout()
   .command(['help'])
   .it('shows root help', ctx => {
-     expect(ctx.stdout).to.equal(`${UA}
-standard help for oclif
+     expect(ctx.stdout).to.equal(`standard help for oclif
+
+VERSION
+  ${UA}
 
 USAGE
   $ oclif [COMMAND]

diff --git a/test/root.test.ts b/test/root.test.ts
@@ -24,8 +24,10 @@ const test = base
 describe('root help', () => {
   test
   .rootHelp()
-  .it(ctx => expect(ctx.commandHelp).to.equal(`${UA}
-standard help for oclif
+  .it(ctx => expect(ctx.commandHelp).to.equal(`standard help for oclif
+
+VERSION
+  ${UA}
 
 USAGE
   $ oclif [COMMAND]`))