From d8d41b6a8f1fcef67ec359b0f6783b2dfe4a2004 Mon Sep 17 00:00:00 2001 From: Peter Hale Date: Fri, 24 Sep 2021 14:13:06 -0600 Subject: [PATCH] fix: adjust help text to new style guide @W-9928119@ --- package.json | 2 +- src/commands/help.ts | 6 +++--- test/commands/help.test.ts | 20 ++++++++++---------- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/package.json b/package.json index 92993839..62369df6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@oclif/plugin-help", - "description": "standard help for oclif", + "description": "Standard help for oclif.", "version": "5.1.0", "author": "Jeff Dickey @jdxcode", "bugs": "https://github.com/oclif/plugin-help/issues", diff --git a/src/commands/help.ts b/src/commands/help.ts index e0c74559..d1bbb3ee 100644 --- a/src/commands/help.ts +++ b/src/commands/help.ts @@ -1,17 +1,17 @@ import {Command, Flags, Help} from '@oclif/core' export default class HelpCommand extends Command { - static description = 'display help for <%= config.bin %>' + static description = 'Display help for <%= config.bin %>.' static flags = { 'nested-commands': Flags.boolean({ - description: 'include all nested commands in the output', + description: 'Include all nested commands in the output.', char: 'n', }), } static args = [ - {name: 'command', required: false, description: 'command to show help for'}, + {name: 'command', required: false, description: 'Command to show help for.'}, ] static strict = false diff --git a/test/commands/help.test.ts b/test/commands/help.test.ts index fba315ea..9dddc0bc 100644 --- a/test/commands/help.test.ts +++ b/test/commands/help.test.ts @@ -7,18 +7,18 @@ describe('help command', () => { test .stdout() .command(['help', 'help']) - .skip() + // .skip() .it('shows help command help', ctx => { - expect(ctx.stdout).to.equal(`display help for oclif + expect(ctx.stdout).to.equal(`Standard help for oclif. -USAGE - $ oclif help [COMMAND] +VERSION + ${UA} -ARGUMENTS - COMMAND command to show help for +USAGE + $ oclif [COMMAND] -OPTIONS - --include-nested, -i include all nested commands in the output +COMMANDS + help Display help for oclif. `) }) @@ -27,7 +27,7 @@ OPTIONS .stdout() .command(['help']) .it('shows root help', ctx => { - expect(ctx.stdout).to.equal(`standard help for oclif + expect(ctx.stdout).to.equal(`Standard help for oclif. VERSION ${UA} @@ -36,7 +36,7 @@ USAGE $ oclif [COMMAND] COMMANDS - help display help for oclif + help Display help for oclif. `) })