feat: show version on root help

oclif · Mar 24, 2018 · 988de52 · 988de52
1 parent 5b943d6
commit 988de52
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/src/root.ts b/src/root.ts
@@ -22,6 +22,7 @@ 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.usage(),

diff --git a/test/commands/help.test.ts b/test/commands/help.test.ts
@@ -1,5 +1,8 @@
 import {expect, test} from '@oclif/test'
 
+const VERSION = require('../../package.json').version
+const UA = `@oclif/plugin-help/${VERSION} ${process.platform}-${process.arch} node-${process.version}`
+
 describe('help command', () => {
   test
   .stdout()
@@ -47,7 +50,8 @@ OPTIONS
   .stdout()
   .command(['help'])
   .it('shows root help', ctx => {
-     expect(ctx.stdout).to.equal(`standard help for oclif
+     expect(ctx.stdout).to.equal(`${UA}
+standard help for oclif
 
 USAGE
   $ oclif [COMMAND]

diff --git a/test/root.test.ts b/test/root.test.ts
@@ -4,6 +4,9 @@ import stripAnsi = require('strip-ansi')
 global.columns = 80
 import Help from '../src'
 
+const VERSION = require('../package.json').version
+const UA = `@oclif/plugin-help/${VERSION} ${process.platform}-${process.arch} node-${process.version}`
+
 const test = base
 .loadConfig()
 .add('help', ctx => new Help(ctx.config))
@@ -21,7 +24,8 @@ const test = base
 describe('root help', () => {
   test
   .rootHelp()
-  .it(ctx => expect(ctx.commandHelp).to.equal(`standard help for oclif
+  .it(ctx => expect(ctx.commandHelp).to.equal(`${UA}
+standard help for oclif
 
 USAGE
   $ oclif [COMMAND]`))