Skip to content

Commit 78cc154

Browse files
skygragonskygragon
committed
Refactor commands options.
* add description for positional args. * add examples. Signed-off-by: Eric Wang <skygragon@gmail.com>
1 parent ec80d09 commit 78cc154

File tree

15 files changed

+294
-195
lines changed

15 files changed

+294
-195
lines changed

‎lib/cli.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ cli.run = function() {
7171
var yargs = require('yargs');
7272
yargs.commandDir('commands')
7373
.completion()
74-
.help()
74+
.help('h')
7575
.version(false)
7676
.wrap(Math.min(yargs.terminalWidth(), 120))
7777
.argv;

‎lib/commands/cache.js‎

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,23 @@ var session = require('../session');
99
var cmd = {
1010
command: 'cache [keyword]',
1111
desc: 'Manage local cache',
12-
builder: {
13-
d: {
14-
alias: 'delete',
15-
type: 'boolean',
16-
describe: 'Delete cache by keyword',
17-
default: false
18-
}
12+
builder: function(yargs) {
13+
return yargs
14+
.option('d', {
15+
alias: 'delete',
16+
type: 'boolean',
17+
describe: 'Delete cache by keyword',
18+
default: false
19+
})
20+
.positional('keyword', {
21+
type: 'string',
22+
describe: 'Cache name or question id',
23+
default: ''
24+
})
25+
.example(chalk.yellow('leetcode cache'), 'Show all cache')
26+
.example(chalk.yellow('leetcode cache 1'), 'Show cache of question 1')
27+
.example(chalk.yellow('leetcode cache -d'), 'Delete all cache')
28+
.example(chalk.yellow('leetcode cache 1 -d'), 'Delete cache of question 1');
1929
}
2030
};
2131

@@ -24,7 +34,7 @@ cmd.handler = function(argv) {
2434

2535
var caches = cache.list()
2636
.filter(function(f) {
27-
return argv.keyword === undefined || f.name.startsWith(argv.keyword + '.');
37+
return argv.keyword.length === 0 || f.name.startsWith(argv.keyword + '.');
2838
});
2939

3040
if (argv.delete) {

‎lib/commands/config.js‎

Lines changed: 32 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ var _ = require('underscore');
22
var nconf = require('nconf');
33

44
var h = require('../helper');
5+
var chalk = require('../chalk');
56
var config = require('../config');
67
var log = require('../log');
78
var session = require('../session');
@@ -10,19 +11,35 @@ var cmd = {
1011
command: 'config [key] [value]',
1112
aliases: ['conf', 'cfg', 'setting'],
1213
desc: 'Manage user configs',
13-
builder: {
14-
a: {
15-
alias: 'all',
16-
type: 'boolean',
17-
describe: 'Show all config',
18-
default: false
19-
},
20-
d: {
21-
alias: 'delete',
22-
type: 'boolean',
23-
describe: 'Delete config by key',
24-
default: false
25-
}
14+
builder: function(yargs) {
15+
return yargs
16+
.option('a', {
17+
alias: 'all',
18+
type: 'boolean',
19+
describe: 'Show all config',
20+
default: false
21+
})
22+
.option('d', {
23+
alias: 'delete',
24+
type: 'boolean',
25+
describe: 'Delete config by key',
26+
default: false
27+
})
28+
.positional('key', {
29+
type: 'string',
30+
describe: 'Config key',
31+
default: ''
32+
})
33+
.positional('value', {
34+
type: 'string',
35+
describe: 'Config value',
36+
default: ''
37+
})
38+
.example(chalk.yellow('leetcode config'), 'Show user configs')
39+
.example(chalk.yellow('leetcode config -a'), 'Show all configs = user + default')
40+
.example(chalk.yellow('leetcode config plugins:github:repo "your repo URL"'), 'Set config by key')
41+
.example(chalk.yellow('leetcode config plugins:github'), 'Show config by key')
42+
.example(chalk.yellow('leetcode config plugins:github -d'), 'Delete config by key');
2643
}
2744
};
2845

@@ -44,7 +61,7 @@ cmd.handler = function(argv) {
4461
nconf.file('local', h.getConfigFile());
4562

4663
// show all
47-
if (argv.key === undefined)
64+
if (argv.key.length === 0)
4865
return log.info(prettyConfig(loadConfig(argv.all)));
4966

5067
var v = nconf.get(argv.key);
@@ -57,7 +74,7 @@ cmd.handler = function(argv) {
5774
}
5875

5976
// show
60-
if (argv.value === undefined) {
77+
if (argv.value.length === 0) {
6178
if (v === undefined) return log.error('Key not found: ' + argv.key);
6279
return log.info(prettyConfig(v));
6380
}

‎lib/commands/list.js‎

Lines changed: 39 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -12,39 +12,45 @@ var cmd = {
1212
command: 'list [keyword]',
1313
aliases: ['ls'],
1414
desc: 'List questions',
15-
builder: {
16-
keyword: {
17-
type: 'string',
18-
default: '',
19-
describe: 'Filter questions by keyword'
20-
},
21-
q: {
22-
alias: 'query',
23-
type: 'string',
24-
default: '',
25-
describe: [
26-
'Filter questions by condition:',
27-
'Uppercase means negative',
28-
'e = easy E = m+h',
29-
'm = medium M = e+h',
30-
'h = hard H = e+m',
31-
'd = done D = not done',
32-
'l = locked L = non locked',
33-
's = starred S = not starred'
34-
].join('\n')
35-
},
36-
s: {
37-
alias: 'stat',
38-
type: 'boolean',
39-
default: false,
40-
describe: 'Show statistics of listed questions'
41-
},
42-
t: {
43-
alias: 'tag',
44-
type: 'array',
45-
default: [],
46-
describe: 'Filter questions by tag'
47-
}
15+
builder: function(yargs) {
16+
return yargs
17+
.option('q', {
18+
alias: 'query',
19+
type: 'string',
20+
default: '',
21+
describe: [
22+
'Filter questions by condition:',
23+
'Uppercase means negative',
24+
'e = easy E = m+h',
25+
'm = medium M = e+h',
26+
'h = hard H = e+m',
27+
'd = done D = not done',
28+
'l = locked L = non locked',
29+
's = starred S = not starred'
30+
].join('\n')
31+
})
32+
.option('s', {
33+
alias: 'stat',
34+
type: 'boolean',
35+
default: false,
36+
describe: 'Show statistics of listed questions'
37+
})
38+
.option('t', {
39+
alias: 'tag',
40+
type: 'array',
41+
default: [],
42+
describe: 'Filter questions by tag'
43+
})
44+
.positional('keyword', {
45+
type: 'string',
46+
default: '',
47+
describe: 'Filter questions by keyword'
48+
})
49+
.example(chalk.yellow('leetcode list'), 'List all questions')
50+
.example(chalk.yellow('leetcode list array'), 'List questions that has "array" in name')
51+
.example(chalk.yellow('leetcode list -q eD'), 'List questions that with easy level and not done')
52+
.example(chalk.yellow('leetcode list -t google'), 'List questions from Google company (require plugin)')
53+
.example(chalk.yellow('leetcode list -t stack'), 'List questions realted to stack (require plugin)');
4854
}
4955
};
5056

‎lib/commands/plugin.js‎

Lines changed: 45 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
var fs = require('fs');
22

33
var h = require('../helper');
4+
var chalk = require('../chalk');
45
var config = require('../config');
56
var log = require('../log');
67
var Plugin = require('../plugin');
@@ -10,37 +11,50 @@ var cmd = {
1011
command: 'plugin [name]',
1112
aliases: ['extension', 'ext'],
1213
desc: 'Manage plugins',
13-
builder: {
14-
c: {
15-
alias: 'config',
16-
type: 'boolean',
17-
describe: 'Show plugin config',
18-
default: false
19-
},
20-
d: {
21-
alias: 'disable',
22-
type: 'boolean',
23-
describe: 'Disable plugin',
24-
default: false
25-
},
26-
D: {
27-
alias: 'delete',
28-
type: 'boolean',
29-
describe: 'Delete plugin',
30-
default: false
31-
},
32-
e: {
33-
alias: 'enable',
34-
type: 'boolean',
35-
describe: 'Enable plugin',
36-
default: false
37-
},
38-
i: {
39-
alias: 'install',
40-
type: 'boolean',
41-
describe: 'Install plugin',
42-
default: false
43-
}
14+
builder: function(yargs) {
15+
return yargs
16+
.option('c', {
17+
alias: 'config',
18+
type: 'boolean',
19+
describe: 'Show plugin config',
20+
default: false
21+
})
22+
.option('d', {
23+
alias: 'disable',
24+
type: 'boolean',
25+
describe: 'Disable plugin',
26+
default: false
27+
})
28+
.option('D', {
29+
alias: 'delete',
30+
type: 'boolean',
31+
describe: 'Delete plugin',
32+
default: false
33+
})
34+
.option('e', {
35+
alias: 'enable',
36+
type: 'boolean',
37+
describe: 'Enable plugin',
38+
default: false
39+
})
40+
.option('i', {
41+
alias: 'install',
42+
type: 'boolean',
43+
describe: 'Install plugin',
44+
default: false
45+
})
46+
.positional('name', {
47+
type: 'string',
48+
describe: 'Filter plugin by name',
49+
default: ''
50+
})
51+
.example(chalk.yellow('leetcode plugin'), 'Show all plugins')
52+
.example(chalk.yellow('leetcode plugin company'), 'Show company plugin')
53+
.example(chalk.yellow('leetcode plugin company -c'), 'Show config of company plugin')
54+
.example(chalk.yellow('leetcode plugin -i company'), 'Install company plugin from GtiHub')
55+
.example(chalk.yellow('leetcode plugin -d company'), 'Disable company plugin')
56+
.example(chalk.yellow('leetcode plugin -e company'), 'Enable comapny plugin')
57+
.example(chalk.yellow('leetcode plugin -D company'), 'Delete company plugin');
4458
}
4559
};
4660

‎lib/commands/show.js‎

Lines changed: 41 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -16,37 +16,47 @@ var cmd = {
1616
command: 'show [keyword]',
1717
aliases: ['view', 'pull'],
1818
desc: 'Show question',
19-
builder: {
20-
c: {
21-
alias: 'codeonly',
22-
type: 'boolean',
23-
default: false,
24-
describe: 'Only show code template'
25-
},
26-
e: {
27-
alias: 'editor',
28-
type: 'string',
29-
describe: 'Open source code in editor'
30-
},
31-
g: {
32-
alias: 'gen',
33-
type: 'boolean',
34-
default: false,
35-
describe: 'Generate source code'
36-
},
37-
l: {
38-
alias: 'lang',
39-
type: 'string',
40-
default: config.code.lang,
41-
describe: 'Programming language of the source code',
42-
choices: config.sys.langs
43-
},
44-
x: {
45-
alias: 'extra',
46-
type: 'boolean',
47-
default: false,
48-
describe: 'Show extra question details in source code'
49-
}
19+
builder: function(yargs) {
20+
return yargs
21+
.option('c', {
22+
alias: 'codeonly',
23+
type: 'boolean',
24+
default: false,
25+
describe: 'Only show code template'
26+
})
27+
.option('e', {
28+
alias: 'editor',
29+
type: 'string',
30+
describe: 'Open source code in editor'
31+
})
32+
.option('g', {
33+
alias: 'gen',
34+
type: 'boolean',
35+
default: false,
36+
describe: 'Generate source code'
37+
})
38+
.option('l', {
39+
alias: 'lang',
40+
type: 'string',
41+
default: config.code.lang,
42+
describe: 'Programming language of the source code',
43+
choices: config.sys.langs
44+
})
45+
.option('x', {
46+
alias: 'extra',
47+
type: 'boolean',
48+
default: false,
49+
describe: 'Show extra question details in source code'
50+
})
51+
.positional('keyword', {
52+
type: 'string',
53+
default: '',
54+
describe: 'Show question by name or id'
55+
})
56+
.example(chalk.yellow('leetcode show 1'), 'Show question 1')
57+
.example(chalk.yellow('leetcode show'), 'Show random question')
58+
.example(chalk.yellow('leetcode show 1 -gx -l java'), 'Show question 1 and generate Java code')
59+
.example(chalk.yellow('leetcode show 1 -gxe'), 'Open generated code in editor');
5060
}
5161
};
5262

0 commit comments

Comments
 (0)