Add commands option
#205
Add commands option
#205
Conversation
This commit adds support for subcommands.
index.d.ts
Outdated
| @@ -68,6 +70,30 @@ export interface Options<Flags extends AnyFlags> { | |||
| */ | |||
| readonly flags?: Flags; | |||
|
|
|||
| /** | |||
| Define subcommands. | |||
There was a problem hiding this comment.
The description needs to be more extensive. It should describe how it works (that it doesn't actually call any commands for you, etc).
index.d.ts
Outdated
| @example | ||
| ``` | ||
| commands: { | ||
| unicorn: (helpText, options) => meow({ |
There was a problem hiding this comment.
The helpText argument is moot. helpText can already be passed in options.
index.d.ts
Outdated
|
|
||
| @example | ||
| ``` | ||
| commands: { |
There was a problem hiding this comment.
The example should be complete and runnable. I think it's better to define the subcommand function at the top-level, for readability.
There was a problem hiding this comment.
The example should also illustrate how one might check for and call code for the subcommand.
index.js
Outdated
| continue; | ||
| } | ||
|
|
||
| commands[command] = meowInstance(helpText, {...options, argv: process.argv.slice(3), commands: {}}); |
test/fixtures/fixture-commands.js
Outdated
| Unicorn command | ||
| Usage: | ||
| foo unicorn <input> | ||
| `, |
test/fixtures/fixture-commands.js
Outdated
| #!/usr/bin/env node | ||
| import meow from '../../index.js'; | ||
|
|
||
| const subcommand = (helpText, options = {}) => meow({ |
There was a problem hiding this comment.
| const subcommand = (helpText, options = {}) => meow({ | |
| const subcommand = (helpText, options) => meow({ |
The options should be guaranteed. Make sure the code guarantees it to exist.
index.d.ts
Outdated
| }) | ||
| } | ||
| ``` | ||
| */ |
There was a problem hiding this comment.
This also needs to be documented in the readme.
|
@skoshx This is a very useful feature, this thread seems to have stalled for a long time, is there any progress now? |
|
@backtolife2021 I made the changes requested by Sindre, other than that everything is good to go, just waiting for Sindre's review. friendly bump :) @sindresorhus |
|
Closing in favor of PR #211 |
This commit adds support for subcommands.
Fixes #69