Skip to content

Commit

Permalink
fix: adjust help text to new style guide (#282)
Browse files Browse the repository at this point in the history
@W-9928119@
  • Loading branch information
peternhale committed Sep 27, 2021
1 parent 4d14517 commit 58e35ce
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
6 changes: 3 additions & 3 deletions src/commands/help.ts
Original file line number Diff line number Diff line change
@@ -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
Expand Down
20 changes: 10 additions & 10 deletions test/commands/help.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
`)
})
Expand All @@ -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}
Expand All @@ -36,7 +36,7 @@ USAGE
$ oclif [COMMAND]
COMMANDS
help display help for oclif
help Display help for oclif.
`)
})
Expand Down

0 comments on commit 58e35ce

Please sign in to comment.