Skip to content

feat: display subcommands as nested commands instead of as flat list of all commands #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat: display subcommands as nested commands instead of as flat list of all commands #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef9a8ce
feat: display subcommands as nested commands instead of as flat list …
noamkfir Jul 29, 2019
01732a6
Merge remote-tracking branch 'upstream/master' into feature/nested-su…
noamkfir Jul 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions lib/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,14 @@ exports.help = function (bin, tree, key, single) {
out += section('Description', cmd.describe, noop);
out += section('Usage', [cmd.usage], prefix);

if (!single && key === DEF) {
if (!single) {
// General help :: print all non-internal commands & their 1st line of text
let cmds = Object.keys(tree).filter(k => !/__/.test(k));
const filter =
key === DEF
? k => !/(__| )/.test(k) // root command
// : k => new RegExp(`^${key} [\S\[\<]+$`).test(k); // subcommand
: k => k !== key && k.startsWith(key) && k.indexOf(' ', key.length + 1) === -1; // subcommand
let cmds = Object.keys(tree).filter(filter);
let text = cmds.map(k => [k, (tree[k].describe || [''])[0]]);
out += section('Available Commands', format(text), noop);

Expand Down
10 changes: 10 additions & 0 deletions test/fixtures/subs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,14 @@ sade('bin')
console.log(`~> ran "remote rename" with "${old}" and "${nxt}" args`);
})

.command('remote child')
.action((opts) => {
console.log(`~> ran "remote child" action`);
})

.command('remote child grandchild <arg>')
.action((arg, opts) => {
console.log(`~> ran "remote child grandchild" with "${arg}" arg`);
})

.parse(process.argv);
14 changes: 13 additions & 1 deletion test/usage.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ test('(usage) subcommands', t => {
test('(usage) subcommands :: help', t => {
let pid1 = exec('subs.js', ['--help']);
t.is(pid1.status, 0, 'exits without error code');
t.true(pid1.stdout.toString().includes('Available Commands\n remote \n remote add \n remote rename'), '~> shows global help w/ "Available Commands" text');
t.true(pid1.stdout.toString().includes('Available Commands\n remote'), '~> shows global help w/ "Available Commands" text');
t.is(pid1.stderr.length, 0, '~> stderr is empty');

let pid2 = exec('subs.js', ['remote', '--help']);
Expand All @@ -290,8 +290,20 @@ test('(usage) subcommands :: help', t => {
let pid3 = exec('subs.js', ['remote', 'rename', '--help']);
t.is(pid3.status, 0, 'exits without error code');
t.true(pid3.stdout.toString().includes('Usage\n $ bin remote rename <old> <new> [options]'), '~> shows "remote rename" help text');
t.false(pid3.stdout.toString().includes(' $ bin remote child grandchild'), '~> does not show "remote child grandchild" help text');
t.is(pid3.stderr.length, 0, '~> stderr is empty');

let pid4 = exec('subs.js', ['remote', 'child', '--help']);
t.is(pid4.status, 0, 'exits without error code');
t.true(pid4.stdout.toString().includes('Usage\n $ bin remote child [options]'), '~> shows "remote child" help text');
t.true(pid4.stdout.toString().includes('Available Commands\n remote child grandchild \n'), '~> only shows child commands of current command in help text');
t.is(pid4.stderr.length, 0, '~> stderr is empty');

let pid5 = exec('subs.js', ['remote', 'child', 'grandchild', '--help']);
t.is(pid5.status, 0, 'exits without error code');
t.true(pid5.stdout.toString().includes('Usage\n $ bin remote child grandchild <arg> [options]'), '~> shows "remote child grandchild" help text');
t.is(pid5.stderr.length, 0, '~> stderr is empty');

t.end();
});

Expand Down
4 changes: 2 additions & 2 deletions test/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ test('utils.help', t => {
t.is(foo, '\n Description\n global foo\n\n Usage\n $ foo <command> [options]\n\n Available Commands\n bar Hello.\n fizz \n\n For more info, run any command with the `--help` flag\n $ foo bar --help\n $ foo fizz --help\n\n Options\n -v, --version Displays current version\n -h, --help Displays this message\n');

let bar = $.help(bin, tree, 'bar'); // two-line description
t.is(bar, '\n Description\n Hello.\n World.\n\n Usage\n $ foo bar [options]\n\n Options\n -h, --help Displays this message\n');
t.is(bar, '\n Description\n Hello.\n World.\n\n Usage\n $ foo bar [options]\n\n For more info, run any command with the `--help` flag\n\n Options\n -h, --help Displays this message\n');

let fizz = $.help(bin, tree, 'fizz'); // no description
t.is(fizz, '\n Usage\n $ foo fizz <buzz> [options]\n\n Options\n -h, --help Displays this message\n');
t.is(fizz, '\n Usage\n $ foo fizz <buzz> [options]\n\n For more info, run any command with the `--help` flag\n\n Options\n -h, --help Displays this message\n');

t.end();
});
Expand Down