cli-forge 0.4.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/cli.js +5 -1
- package/bin/cli.js.map +1 -1
- package/bin/commands/generate-documentation.js +49 -11
- package/bin/commands/generate-documentation.js.map +1 -1
- package/bin/commands/init.js +2 -1
- package/bin/commands/init.js.map +1 -1
- package/package.json +2 -2
- package/src/index.d.ts +1 -0
- package/src/index.js +3 -1
- package/src/index.js.map +1 -1
- package/src/lib/cli-forge.d.ts +67 -9
- package/src/lib/cli-forge.js +115 -15
- package/src/lib/cli-forge.js.map +1 -1
- package/src/lib/documentation.d.ts +5 -1
- package/src/lib/documentation.js +12 -2
- package/src/lib/documentation.js.map +1 -1
- package/src/lib/test-harness.d.ts +36 -0
- package/src/lib/test-harness.js +37 -0
- package/src/lib/test-harness.js.map +1 -0
package/bin/cli.js
CHANGED
|
@@ -6,5 +6,9 @@ const generate_documentation_1 = require("./commands/generate-documentation");
|
|
|
6
6
|
const init_1 = require("./commands/init");
|
|
7
7
|
const mycli = (0, src_1.cli)('cli-forge').commands(generate_documentation_1.generateDocumentationCommand, init_1.initCommand);
|
|
8
8
|
exports.default = mycli;
|
|
9
|
-
|
|
9
|
+
if (require.main === module) {
|
|
10
|
+
(async () => {
|
|
11
|
+
await mycli.forge();
|
|
12
|
+
})();
|
|
13
|
+
}
|
|
10
14
|
//# sourceMappingURL=cli.js.map
|
package/bin/cli.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../../packages/cli-forge/bin/cli.ts"],"names":[],"mappings":";;;AAEA,gCAA6B;AAC7B,8EAAiF;AACjF,0CAA8C;AAE9C,MAAM,KAAK,GAAG,IAAA,SAAG,EAAC,WAAW,CAAC,CAAC,QAAQ,CACrC,qDAA4B,EAC5B,kBAAW,CACZ,CAAC;AAEF,kBAAe,KAAK,CAAC;AAErB,KAAK,CAAC,KAAK,EAAE,CAAC"}
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../../packages/cli-forge/bin/cli.ts"],"names":[],"mappings":";;;AAEA,gCAA6B;AAC7B,8EAAiF;AACjF,0CAA8C;AAE9C,MAAM,KAAK,GAAG,IAAA,SAAG,EAAC,WAAW,CAAC,CAAC,QAAQ,CACrC,qDAA4B,EAC5B,kBAAW,CACZ,CAAC;AAEF,kBAAe,KAAK,CAAC;AAErB,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;IAC5B,CAAC,KAAK,IAAI,EAAE;QACV,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC,CAAC,EAAE,CAAC;AACP,CAAC"}
|
|
@@ -4,6 +4,7 @@ exports.generateDocumentationCommand = void 0;
|
|
|
4
4
|
exports.withGenerateDocumentationArgs = withGenerateDocumentationArgs;
|
|
5
5
|
const node_fs_1 = require("node:fs");
|
|
6
6
|
const node_path_1 = require("node:path");
|
|
7
|
+
const posix_1 = require("node:path/posix");
|
|
7
8
|
const src_1 = require("../../src");
|
|
8
9
|
const documentation_1 = require("../../src/lib/documentation");
|
|
9
10
|
const cli_forge_1 = require("../../src/lib/cli-forge");
|
|
@@ -23,8 +24,9 @@ function withGenerateDocumentationArgs(cmd) {
|
|
|
23
24
|
})
|
|
24
25
|
.option('format', {
|
|
25
26
|
type: 'string',
|
|
26
|
-
description: 'What format should the documentation be output in?
|
|
27
|
+
description: 'What format should the documentation be output in?',
|
|
27
28
|
default: 'md',
|
|
29
|
+
choices: ['json', 'md'],
|
|
28
30
|
})
|
|
29
31
|
.option('export', {
|
|
30
32
|
type: 'string',
|
|
@@ -35,12 +37,12 @@ exports.generateDocumentationCommand = (0, src_1.default)('generate-documentatio
|
|
|
35
37
|
description: 'Generate documentation for the given CLI',
|
|
36
38
|
builder: (b) => withGenerateDocumentationArgs(b),
|
|
37
39
|
handler: async (args) => {
|
|
38
|
-
if (args.cli.startsWith('./')) {
|
|
40
|
+
if (args.cli.startsWith('./') || args.cli.startsWith('../')) {
|
|
39
41
|
args.cli = (0, node_path_1.join)(process.cwd(), args.cli);
|
|
40
42
|
}
|
|
41
43
|
const cliModule = await Promise.resolve(`${args.cli}`).then(s => require(s));
|
|
42
44
|
const cli = cliModule[args.export || 'default'] ?? cliModule;
|
|
43
|
-
if (!(cli
|
|
45
|
+
if (!isCLI(cli)) {
|
|
44
46
|
throw new Error(`${args.cli}${args.export ? '#' + args.export : ''} is not a CLI.`);
|
|
45
47
|
}
|
|
46
48
|
const documentation = (0, documentation_1.generateDocumentation)(cli);
|
|
@@ -59,25 +61,28 @@ exports.generateDocumentationCommand = (0, src_1.default)('generate-documentatio
|
|
|
59
61
|
});
|
|
60
62
|
async function generateMarkdownDocumentation(docs, args) {
|
|
61
63
|
const md = await importMarkdownFactory();
|
|
62
|
-
await generateMarkdownForSingleCommand(docs,
|
|
64
|
+
await generateMarkdownForSingleCommand(docs, args.output, args.output, md);
|
|
63
65
|
}
|
|
64
|
-
async function generateMarkdownForSingleCommand(docs, out, md) {
|
|
66
|
+
async function generateMarkdownForSingleCommand(docs, out, docsRoot, md) {
|
|
65
67
|
const subcommands = docs.subcommands;
|
|
66
68
|
const outdir = subcommands.length ? out : (0, node_path_1.dirname)(out);
|
|
67
69
|
const outname = subcommands.length ? 'index' : docs.name;
|
|
68
70
|
(0, fs_1.ensureDirSync)(outdir);
|
|
69
71
|
(0, node_fs_1.writeFileSync)((0, node_path_1.join)(outdir, outname + '.md'), md.h1(docs.name, ...[
|
|
72
|
+
[md.bold('Usage:'), md.code(docs.usage)].join(' '),
|
|
70
73
|
docs.description,
|
|
71
74
|
getPositionalArgsFragment(docs.positionals, md),
|
|
72
75
|
getFlagArgsFragment(docs.options, md),
|
|
73
|
-
getSubcommandsFragment(docs.subcommands, md),
|
|
76
|
+
getSubcommandsFragment(docs.subcommands, outdir, docsRoot, md),
|
|
77
|
+
getExamplesFragment(docs.examples, md),
|
|
74
78
|
].filter(isTruthy)));
|
|
75
79
|
for (const subcommand of docs.subcommands) {
|
|
76
|
-
await generateMarkdownForSingleCommand(subcommand, (0, node_path_1.join)(outdir, subcommand.name), md);
|
|
80
|
+
await generateMarkdownForSingleCommand(subcommand, (0, node_path_1.join)(outdir, subcommand.name), docsRoot, md);
|
|
77
81
|
}
|
|
78
82
|
}
|
|
79
83
|
function formatOption(option, md) {
|
|
80
|
-
return md.h3(option.key, ...[
|
|
84
|
+
return md.h3(option.deprecated ? md.strikethrough(option.key) : option.key, ...[
|
|
85
|
+
option.deprecated ? md.bold(md.italics('Deprecated')) : undefined,
|
|
81
86
|
md.bold('Type:') +
|
|
82
87
|
' ' +
|
|
83
88
|
(option.type === 'array'
|
|
@@ -85,7 +90,18 @@ function formatOption(option, md) {
|
|
|
85
90
|
: option.type),
|
|
86
91
|
option.description,
|
|
87
92
|
option.default ? md.bold('Default:') + ' ' + option.default : undefined,
|
|
88
|
-
|
|
93
|
+
// No need to show required if it's required and has a default, as its not actually required to pass.
|
|
94
|
+
option.required && !option.default ? md.bold('Required') : undefined,
|
|
95
|
+
option.choices
|
|
96
|
+
? md.bold('Valid values:') +
|
|
97
|
+
' ' +
|
|
98
|
+
(() => {
|
|
99
|
+
const choicesAsString = (typeof option.choices === 'function'
|
|
100
|
+
? option.choices()
|
|
101
|
+
: option.choices).map((t) => t.toString());
|
|
102
|
+
return choicesAsString.join(', ');
|
|
103
|
+
})()
|
|
104
|
+
: undefined,
|
|
89
105
|
option.alias?.length
|
|
90
106
|
? md.h4('Aliases', md.ul(...option.alias))
|
|
91
107
|
: undefined,
|
|
@@ -103,11 +119,12 @@ function getFlagArgsFragment(options, md) {
|
|
|
103
119
|
}
|
|
104
120
|
return md.h2('Flags', ...Object.values(options).map((option) => formatOption(option, md)));
|
|
105
121
|
}
|
|
106
|
-
function getSubcommandsFragment(subcommands, md) {
|
|
122
|
+
function getSubcommandsFragment(subcommands, outdir, docsRoot, md) {
|
|
107
123
|
if (subcommands.length === 0) {
|
|
108
124
|
return undefined;
|
|
109
125
|
}
|
|
110
|
-
return md.h2('Subcommands', ...subcommands.map((subcommand) => md.link(
|
|
126
|
+
return md.h2('Subcommands', ...subcommands.map((subcommand) => md.link('./' +
|
|
127
|
+
(0, posix_1.join)((0, posix_1.normalize)((0, node_path_1.relative)(docsRoot, outdir)), subcommand.name + '.md'), subcommand.name)));
|
|
111
128
|
}
|
|
112
129
|
function isTruthy(value) {
|
|
113
130
|
return !!value;
|
|
@@ -120,4 +137,25 @@ async function importMarkdownFactory() {
|
|
|
120
137
|
throw new Error('Could not find markdown-factory. Please install it to generate markdown documentation.');
|
|
121
138
|
}
|
|
122
139
|
}
|
|
140
|
+
function isCLI(obj) {
|
|
141
|
+
if (obj instanceof cli_forge_1.InternalCLI) {
|
|
142
|
+
return true;
|
|
143
|
+
}
|
|
144
|
+
if (typeof obj !== 'object' || !obj) {
|
|
145
|
+
return false;
|
|
146
|
+
}
|
|
147
|
+
if (!('constructor' in obj)) {
|
|
148
|
+
return false;
|
|
149
|
+
}
|
|
150
|
+
if (!('name' in obj.constructor)) {
|
|
151
|
+
return false;
|
|
152
|
+
}
|
|
153
|
+
return obj.constructor.name === cli_forge_1.InternalCLI.name;
|
|
154
|
+
}
|
|
155
|
+
function getExamplesFragment(examples, md) {
|
|
156
|
+
if (examples.length === 0) {
|
|
157
|
+
return undefined;
|
|
158
|
+
}
|
|
159
|
+
return md.h2('Examples', ...examples.map((example) => md.codeBlock(example, 'shell')));
|
|
160
|
+
}
|
|
123
161
|
//# sourceMappingURL=generate-documentation.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate-documentation.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/bin/commands/generate-documentation.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"generate-documentation.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/bin/commands/generate-documentation.ts"],"names":[],"mappings":";;;AAuBA,sEA0BC;AA/CD,qCAAwC;AACxC,yCAAoD;AACpD,2CAAuE;AAEvE,mCAA4B;AAC5B,+DAGqC;AACrC,uDAA2D;AAC3D,oCAA4C;AAW5C,SAAgB,6BAA6B,CAC3C,GAAW;IAEX,OAAO,GAAG;SACP,UAAU,CAAC,KAAK,EAAE;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oDAAoD;QACjE,QAAQ,EAAE,IAAI;KACf,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,KAAK,EAAE,CAAC,GAAG,CAAC;QACZ,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,2CAA2C;QACxD,OAAO,EAAE,MAAM;KAChB,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oDAAoD;QACjE,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC;KACxB,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,mHAAmH;KACtH,CAAC,CAAC;AACP,CAAC;AAEY,QAAA,4BAA4B,GAAQ,IAAA,aAAG,EAAC,wBAAwB,EAAE;IAC7E,WAAW,EAAE,0CAA0C;IACvD,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,6BAA6B,CAAC,CAAC,CAAC;IAChD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QACtB,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5D,IAAI,CAAC,GAAG,GAAG,IAAA,gBAAI,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3C,CAAC;QACD,MAAM,SAAS,GAAG,yBAAa,IAAI,CAAC,GAAG,yBAAC,CAAC;QACzC,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,IAAI,SAAS,CAAC,IAAI,SAAS,CAAC;QAC7D,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,gBAAgB,CACnE,CAAC;QACJ,CAAC;QACD,MAAM,aAAa,GAAG,IAAA,qCAAqB,EAAC,GAAG,CAAC,CAAC;QACjD,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YACzB,MAAM,6BAA6B,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QAC3D,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAClC,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAC1C,CAAC,CAAC,IAAI,CAAC,MAAM;gBACb,CAAC,CAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC,CAAC;YAC1C,MAAM,MAAM,GAAG,IAAA,mBAAO,EAAC,OAAO,CAAC,CAAC;YAChC,IAAA,kBAAa,EAAC,MAAM,CAAC,CAAC;YACtB,IAAA,uBAAa,EAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;CACF,CAAC,CAAC;AAEH,KAAK,UAAU,6BAA6B,CAC1C,IAAmB,EACnB,IAAsB;IAEtB,MAAM,EAAE,GAAG,MAAM,qBAAqB,EAAE,CAAC;IACzC,MAAM,gCAAgC,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAC7E,CAAC;AAED,KAAK,UAAU,gCAAgC,CAC7C,IAAmB,EACnB,GAAW,EACX,QAAgB,EAChB,EAAa;IAEb,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;IACrC,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAA,mBAAO,EAAC,GAAG,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;IAEzD,IAAA,kBAAa,EAAC,MAAM,CAAC,CAAC;IAEtB,IAAA,uBAAa,EACX,IAAA,gBAAI,EAAC,MAAM,EAAE,OAAO,GAAG,KAAK,CAAC,EAC7B,EAAE,CAAC,EAAE,CACH,IAAI,CAAC,IAAI,EACT,GAAG;QACD,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QAClD,IAAI,CAAC,WAAW;QAChB,yBAAyB,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QAC/C,mBAAmB,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;QACrC,sBAAsB,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC;QAC9D,mBAAmB,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;KACvC,CAAC,MAAM,CAAC,QAAQ,CAAC,CACnB,CACF,CAAC;IACF,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QAC1C,MAAM,gCAAgC,CACpC,UAAU,EACV,IAAA,gBAAI,EAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,EAC7B,QAAQ,EACR,EAAE,CACH,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,MAAwC,EAAE,EAAa;IAC3E,OAAO,EAAE,CAAC,EAAE,CACV,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,EAC7D,GAAG;QACD,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QACjE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;YACd,GAAG;YACH,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO;gBACtB,CAAC,CAAC,GAAI,MAA4B,CAAC,KAAK,IAAI;gBAC5C,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;QAClB,MAAM,CAAC,WAAW;QAClB,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;QACvE,qGAAqG;QACrG,MAAM,CAAC,QAAQ,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;QACpE,MAAM,CAAC,OAAO;YACZ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC;gBACxB,GAAG;gBACH,CAAC,GAAG,EAAE;oBACJ,MAAM,eAAe,GAAG,CACtB,OAAO,MAAM,CAAC,OAAO,KAAK,UAAU;wBAClC,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE;wBAClB,CAAC,CAAC,MAAM,CAAC,OAAO,CACnB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;oBAC3B,OAAO,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACpC,CAAC,CAAC,EAAE;YACN,CAAC,CAAC,SAAS;QACb,MAAM,CAAC,KAAK,EAAE,MAAM;YAClB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC,CAAC,SAAS;KACd,CAAC,MAAM,CAAC,QAAQ,CAAC,CACnB,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAChC,WAAyC,EACzC,EAAa;IAEb,IAAI,WAAW,EAAE,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,CAAC,EAAE,CACV,sBAAsB,EACtB,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CACjE,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,OAAiC,EAAE,EAAa;IAC3E,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,CAAC,EAAE,CACV,OAAO,EACP,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CACpE,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB,CAC7B,WAAyC,EACzC,MAAc,EACd,QAAgB,EAChB,EAAa;IAEb,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,CAAC,EAAE,CACV,aAAa,EACb,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAChC,EAAE,CAAC,IAAI,CACL,IAAI;QACF,IAAA,YAAiB,EACf,IAAA,iBAAS,EAAC,IAAA,oBAAQ,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,EACrC,UAAU,CAAC,IAAI,GAAG,KAAK,CACxB,EACH,UAAU,CAAC,IAAI,CAChB,CACF,CACF,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAI,KAA2B;IAC9C,OAAO,CAAC,CAAC,KAAK,CAAC;AACjB,CAAC;AAED,KAAK,UAAU,qBAAqB;IAClC,IAAI,CAAC;QACH,OAAO,2CAAa,kBAAkB,EAAC,CAAC;IAC1C,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CACb,wFAAwF,CACzF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,KAAK,CAAC,GAAY;IACzB,IAAI,GAAG,YAAY,uBAAW,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,GAAG,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,CAAC,CAAC,aAAa,IAAI,GAAG,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,CAAC,CAAC,MAAM,IAAI,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,KAAK,uBAAW,CAAC,IAAI,CAAC;AACnD,CAAC;AAED,SAAS,mBAAmB,CAC1B,QAAkB,EAClB,EAAqC;IAErC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,CAAC,EAAE,CACV,UAAU,EACV,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAC7D,CAAC;AACJ,CAAC"}
|
package/bin/commands/init.js
CHANGED
|
@@ -24,7 +24,8 @@ function withInitArgs(cmd) {
|
|
|
24
24
|
.option('format', {
|
|
25
25
|
type: 'string',
|
|
26
26
|
default: 'ts',
|
|
27
|
-
description: 'What format should the CLI be in?
|
|
27
|
+
description: 'What format should the CLI be in?',
|
|
28
|
+
choices: ['js', 'ts'],
|
|
28
29
|
});
|
|
29
30
|
}
|
|
30
31
|
exports.initCommand = (0, src_1.default)('init', {
|
package/bin/commands/init.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/bin/commands/init.ts"],"names":[],"mappings":";;;AAWA,
|
|
1
|
+
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/bin/commands/init.ts"],"names":[],"mappings":";;;AAWA,oCAkBC;AA3BD,2DAA8C;AAC9C,qCAAkE;AAClE,yCAAoD;AAEpD,qDAAkE;AAClE,mCAAqC;AACrC,iDAAiD;AACjD,oCAA4C;AAE5C,SAAgB,YAAY,CAAuB,GAAW;IAC5D,OAAO,GAAG;SACP,UAAU,CAAC,SAAS,EAAE;QACrB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,8BAA8B;QAC3C,QAAQ,EAAE,IAAI;KACf,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,KAAK,EAAE,CAAC,GAAG,CAAC;QACZ,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,kCAAkC;KAChD,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,mCAAmC;QAChD,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;KACtB,CAAC,CAAC;AACP,CAAC;AAEY,QAAA,WAAW,GAAG,IAAA,aAAG,EAAC,MAAM,EAAE;IACrC,WAAW,EAAE,oBAAoB;IACjC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/B,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QACtB,IAAI,CAAC,MAAM,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC;QAC9B,IAAA,kBAAa,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,eAAe,GAAG,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAC1D,MAAM,OAAO,GAAG,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3E,MAAM,kBAAkB,GAMpB,UAAU,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QACxD,kBAAkB,CAAC,GAAG,KAAK,EAAE,CAAC;QAC9B,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,IAAA,oBAAQ,EAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACtE,kBAAkB,CAAC,YAAY,KAAK,EAAE,CAAC;QACvC,kBAAkB,CAAC,YAAY,CAAC,WAAW,CAAC,KAAK,sBAAiB,CAAC;QACnE,IAAA,uBAAa,EAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5E,IAAA,kBAAa,EAAC,IAAA,mBAAO,EAAC,OAAO,CAAC,CAAC,CAAC;QAChC,IAAA,uBAAa,EACX,OAAO,EACP,IAAI,CAAC,MAAM,KAAK,IAAI;YAClB,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC;YAC/B,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAClC,CAAC;QACF,MAAM,cAAc,GAAG,IAAA,oBAAU,EAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YAC/D,CAAC,CAAC,MAAM;YACR,CAAC,CAAC,IAAA,oBAAU,EAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;gBACjD,CAAC,CAAC,MAAM;gBACR,CAAC,CAAC,IAAA,oBAAU,EAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;oBAC5C,CAAC,CAAC,KAAK;oBACP,CAAC,CAAC,KAAK,CAAC;QAEV,IAAA,6BAAQ,EAAC,GAAG,cAAc,UAAU,CAAC,CAAC;IACxC,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,sBAAsB,IAAI;;;;;;KAM/D,CAAC;AAEN,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC;;EAExC,eAAe,CAAC,IAAI,CAAC;;;;;;;CAOtB,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC;;EAExC,eAAe,CAAC,IAAI,CAAC;;;;;;;CAOtB,CAAC;AAEF,SAAS,UAAU,CAAI,QAAgB,EAAE,GAAM;IAC7C,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,IAAA,sBAAY,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,GAAG,CAAC;IACb,CAAC;AACH,CAAC"}
|
package/package.json
CHANGED
package/src/index.d.ts
CHANGED
package/src/index.js
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.cli = exports.default = void 0;
|
|
3
|
+
exports.TestHarness = exports.cli = exports.default = void 0;
|
|
4
4
|
var cli_forge_1 = require("./lib/cli-forge");
|
|
5
5
|
Object.defineProperty(exports, "default", { enumerable: true, get: function () { return cli_forge_1.default; } });
|
|
6
6
|
Object.defineProperty(exports, "cli", { enumerable: true, get: function () { return cli_forge_1.cli; } });
|
|
7
|
+
var test_harness_1 = require("./lib/test-harness");
|
|
8
|
+
Object.defineProperty(exports, "TestHarness", { enumerable: true, get: function () { return test_harness_1.TestHarness; } });
|
|
7
9
|
//# sourceMappingURL=index.js.map
|
package/src/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/cli-forge/src/index.ts"],"names":[],"mappings":";;;AAAA,6CAA6D;AAApD,oGAAA,OAAO,OAAA;AAAE,gGAAA,GAAG,OAAA"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/cli-forge/src/index.ts"],"names":[],"mappings":";;;AAAA,6CAA6D;AAApD,oGAAA,OAAO,OAAA;AAAE,gGAAA,GAAG,OAAA;AACrB,mDAAiD;AAAxC,2GAAA,WAAW,OAAA"}
|
package/src/lib/cli-forge.d.ts
CHANGED
|
@@ -5,11 +5,32 @@ export interface CLIHandlerContext {
|
|
|
5
5
|
export type CLICommandOptions<TInitial extends ParsedArgs, TArgs extends TInitial = TInitial> = {
|
|
6
6
|
description?: string;
|
|
7
7
|
builder?: (parser: CLI<TInitial>) => CLI<TArgs>;
|
|
8
|
-
handler
|
|
8
|
+
handler?: (args: TArgs, context: CLIHandlerContext) => void | Promise<void>;
|
|
9
|
+
usage?: string;
|
|
10
|
+
examples?: string[];
|
|
9
11
|
};
|
|
10
12
|
export type Command<TInitial extends ParsedArgs = any, TArgs extends TInitial = TInitial> = ({
|
|
11
13
|
name: string;
|
|
12
14
|
} & CLICommandOptions<TInitial, TArgs>) | CLI<TArgs>;
|
|
15
|
+
/**
|
|
16
|
+
* The interface for a CLI application or subcommands.
|
|
17
|
+
*
|
|
18
|
+
* {@link cli} is provided as a small helper function to create a new CLI instance.
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```ts
|
|
22
|
+
* import { cli } from 'cli-forge';
|
|
23
|
+
*
|
|
24
|
+
* cli('basic-cli').command('hello', {
|
|
25
|
+
* builder: (args) =>
|
|
26
|
+
* args.option('name', {
|
|
27
|
+
* type: 'string',
|
|
28
|
+
* }),
|
|
29
|
+
* handler: (args) => {
|
|
30
|
+
* console.log(`Hello, ${args.name}!`);
|
|
31
|
+
* }).forge();
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
13
34
|
export interface CLI<TArgs extends ParsedArgs = ParsedArgs> {
|
|
14
35
|
command<TCommandArgs extends TArgs>(cmd: Command<TArgs, TCommandArgs>): CLI<TArgs>;
|
|
15
36
|
/**
|
|
@@ -60,12 +81,38 @@ export interface CLI<TArgs extends ParsedArgs = ParsedArgs> {
|
|
|
60
81
|
array: (TOptionConfig extends ArrayOptionConfig<string | number> ? TOptionConfig['items'] extends 'string' ? string : number : never)[];
|
|
61
82
|
}[TOptionConfig['type']];
|
|
62
83
|
}>;
|
|
84
|
+
/**
|
|
85
|
+
* Adds support for reading CLI options from environment variables.
|
|
86
|
+
* @param prefix The prefix to use when looking up environment variables. Defaults to the command name.
|
|
87
|
+
*/
|
|
88
|
+
env(prefix?: string): CLI<TArgs>;
|
|
89
|
+
/**
|
|
90
|
+
* Sets a group of options as mutually exclusive. If more than one option is provided, there will be a validation error.
|
|
91
|
+
* @param options The options that should be mutually exclusive.
|
|
92
|
+
*/
|
|
93
|
+
conflicts(...options: [string, string, ...string[]]): CLI<TArgs>;
|
|
94
|
+
/**
|
|
95
|
+
* Sets a group of options as mutually inclusive. If one option is provided, all other options must also be provided.
|
|
96
|
+
* @param option The option that implies the other options.
|
|
97
|
+
* @param impliedOptions The options which become required when the option is provided.
|
|
98
|
+
*/
|
|
99
|
+
implies(option: string, ...impliedOptions: string[]): CLI<TArgs>;
|
|
63
100
|
/**
|
|
64
101
|
* Requires a command to be provided when executing the CLI. Useful if your parent command
|
|
65
102
|
* cannot be executed on its own.
|
|
66
103
|
* @returns Updated CLI instance.
|
|
67
104
|
*/
|
|
68
105
|
demandCommand(): CLI<TArgs>;
|
|
106
|
+
/**
|
|
107
|
+
* Sets the usage text for the CLI. This text will be displayed in place of the default usage text
|
|
108
|
+
* @param usageText Text displayed in place of the default usage text for `--help` and in generated docs.
|
|
109
|
+
*/
|
|
110
|
+
usage(usageText: string): CLI<TArgs>;
|
|
111
|
+
/**
|
|
112
|
+
* Sets the description for the CLI. This text will be displayed in the help text and generated docs.
|
|
113
|
+
* @param examples Examples to display in the help text and generated docs.
|
|
114
|
+
*/
|
|
115
|
+
examples(...examples: string[]): CLI<TArgs>;
|
|
69
116
|
/**
|
|
70
117
|
* Prints help text to stdout.
|
|
71
118
|
*/
|
|
@@ -75,7 +122,7 @@ export interface CLI<TArgs extends ParsedArgs = ParsedArgs> {
|
|
|
75
122
|
* @param args argv. Defaults to process.argv.slice(2)
|
|
76
123
|
* @returns Promise that resolves when the handler completes.
|
|
77
124
|
*/
|
|
78
|
-
forge(args?: string[]): Promise<
|
|
125
|
+
forge(args?: string[]): Promise<TArgs>;
|
|
79
126
|
}
|
|
80
127
|
/**
|
|
81
128
|
* The base class for a CLI application. This class is used to define the structure of the CLI.
|
|
@@ -98,26 +145,37 @@ export interface CLI<TArgs extends ParsedArgs = ParsedArgs> {
|
|
|
98
145
|
*/
|
|
99
146
|
export declare class InternalCLI<TArgs extends ParsedArgs = ParsedArgs> implements CLI<TArgs> {
|
|
100
147
|
name: string;
|
|
101
|
-
|
|
102
|
-
|
|
148
|
+
/**
|
|
149
|
+
* For internal use only. Stick to properties available on {@link CLI}.
|
|
150
|
+
*/
|
|
151
|
+
registeredCommands: Record<string, InternalCLI<any>>;
|
|
152
|
+
/**
|
|
153
|
+
* For internal use only. Stick to properties available on {@link CLI}.
|
|
154
|
+
*/
|
|
155
|
+
commandChain: string[];
|
|
103
156
|
private requiresCommand;
|
|
104
157
|
private _configuration?;
|
|
158
|
+
get configuration(): CLICommandOptions<any, any> | undefined;
|
|
159
|
+
private set configuration(value);
|
|
105
160
|
private parser;
|
|
106
161
|
/**
|
|
107
162
|
* @param name What should the name of the cli command be?
|
|
108
163
|
* @param configuration Configuration for the current CLI command.
|
|
109
164
|
*/
|
|
110
165
|
constructor(name: string);
|
|
111
|
-
get configuration(): CLICommandOptions<any, any> | undefined;
|
|
112
|
-
private set configuration(value);
|
|
113
166
|
withRootCommandConfiguration<TRootCommandArgs extends TArgs>(configuration: CLICommandOptions<TArgs, TRootCommandArgs>): InternalCLI<TArgs>;
|
|
114
167
|
command<TCommandArgs extends TArgs>(cmd: Command<TArgs, TCommandArgs>): CLI<TArgs>;
|
|
115
168
|
command<TCommandArgs extends TArgs>(key: string, options: CLICommandOptions<TArgs, TCommandArgs>): CLI<TArgs>;
|
|
116
|
-
commands(commands: Command[]):
|
|
117
|
-
commands(...commands: Command[]):
|
|
169
|
+
commands(commands: Command[]): CLI<TArgs>;
|
|
170
|
+
commands(...commands: Command[]): CLI<TArgs>;
|
|
118
171
|
option<TOption extends string, TOptionConfig extends OptionConfig>(name: TOption, config: TOptionConfig): any;
|
|
119
172
|
positional<TOption extends string, TOptionConfig extends OptionConfig>(name: TOption, config: TOptionConfig): any;
|
|
173
|
+
conflicts(...args: [string, string, ...string[]]): CLI<TArgs>;
|
|
174
|
+
implies(option: string, ...impliedOptions: string[]): CLI<TArgs>;
|
|
175
|
+
env(prefix?: string): this;
|
|
120
176
|
demandCommand(): this;
|
|
177
|
+
usage(usageText: string): this;
|
|
178
|
+
examples(...examples: string[]): this;
|
|
121
179
|
/**
|
|
122
180
|
* Gets help text for the current command as a string.
|
|
123
181
|
* @returns Help text for the current command.
|
|
@@ -138,7 +196,7 @@ export declare class InternalCLI<TArgs extends ParsedArgs = ParsedArgs> implemen
|
|
|
138
196
|
* @param args argv. Defaults to process.argv.slice(2)
|
|
139
197
|
* @returns Promise that resolves when the handler completes.
|
|
140
198
|
*/
|
|
141
|
-
forge(args?: string[]): Promise<
|
|
199
|
+
forge(args?: string[]): Promise<TArgs>;
|
|
142
200
|
getParser(): import("@cli-forge/parser").ReadonlyArgvParser<TArgs & {
|
|
143
201
|
help: boolean;
|
|
144
202
|
}>;
|
package/src/lib/cli-forge.js
CHANGED
|
@@ -24,10 +24,22 @@ const parser_1 = require("@cli-forge/parser");
|
|
|
24
24
|
*/
|
|
25
25
|
class InternalCLI {
|
|
26
26
|
name;
|
|
27
|
+
/**
|
|
28
|
+
* For internal use only. Stick to properties available on {@link CLI}.
|
|
29
|
+
*/
|
|
27
30
|
registeredCommands = {};
|
|
31
|
+
/**
|
|
32
|
+
* For internal use only. Stick to properties available on {@link CLI}.
|
|
33
|
+
*/
|
|
28
34
|
commandChain = [];
|
|
29
35
|
requiresCommand = false;
|
|
30
36
|
_configuration;
|
|
37
|
+
get configuration() {
|
|
38
|
+
return this._configuration;
|
|
39
|
+
}
|
|
40
|
+
set configuration(value) {
|
|
41
|
+
this._configuration = value;
|
|
42
|
+
}
|
|
31
43
|
parser = new parser_1.ArgvParser({
|
|
32
44
|
unmatchedParser: (arg) => {
|
|
33
45
|
// eslint-disable-next-line @typescript-eslint/no-this-alias
|
|
@@ -55,14 +67,9 @@ class InternalCLI {
|
|
|
55
67
|
constructor(name) {
|
|
56
68
|
this.name = name;
|
|
57
69
|
}
|
|
58
|
-
get configuration() {
|
|
59
|
-
return this._configuration;
|
|
60
|
-
}
|
|
61
|
-
set configuration(value) {
|
|
62
|
-
this._configuration = value;
|
|
63
|
-
}
|
|
64
70
|
withRootCommandConfiguration(configuration) {
|
|
65
71
|
this.configuration = configuration;
|
|
72
|
+
this.requiresCommand = false;
|
|
66
73
|
return this;
|
|
67
74
|
}
|
|
68
75
|
command(keyOrCommand, options) {
|
|
@@ -78,6 +85,7 @@ class InternalCLI {
|
|
|
78
85
|
handler: options.handler,
|
|
79
86
|
description: options.description,
|
|
80
87
|
};
|
|
88
|
+
this.requiresCommand = false;
|
|
81
89
|
}
|
|
82
90
|
this.registeredCommands[key] = new InternalCLI(key).withRootCommandConfiguration(options);
|
|
83
91
|
this.registeredCommands[key].parser = this.parser;
|
|
@@ -110,16 +118,41 @@ class InternalCLI {
|
|
|
110
118
|
}
|
|
111
119
|
option(name, config) {
|
|
112
120
|
this.parser.option(name, config);
|
|
121
|
+
// Interface modifies the return type to reflect new params, cast is necessay.... I think 🤔
|
|
113
122
|
return this;
|
|
114
123
|
}
|
|
115
124
|
positional(name, config) {
|
|
116
125
|
this.parser.positional(name, config);
|
|
126
|
+
// Interface modifies the return type to reflect new params, cast is necessay.... I think 🤔
|
|
127
|
+
return this;
|
|
128
|
+
}
|
|
129
|
+
conflicts(...args) {
|
|
130
|
+
this.parser.conflicts(...args);
|
|
131
|
+
return this;
|
|
132
|
+
}
|
|
133
|
+
implies(option, ...impliedOptions) {
|
|
134
|
+
this.parser.implies(option, ...impliedOptions);
|
|
135
|
+
return this;
|
|
136
|
+
}
|
|
137
|
+
env(prefix = (0, parser_1.fromCamelOrDashedCaseToConstCase)(this.name)) {
|
|
138
|
+
this.parser.env(prefix);
|
|
117
139
|
return this;
|
|
118
140
|
}
|
|
119
141
|
demandCommand() {
|
|
120
142
|
this.requiresCommand = true;
|
|
121
143
|
return this;
|
|
122
144
|
}
|
|
145
|
+
usage(usageText) {
|
|
146
|
+
this.configuration ??= {};
|
|
147
|
+
this.configuration.usage = usageText;
|
|
148
|
+
return this;
|
|
149
|
+
}
|
|
150
|
+
examples(...examples) {
|
|
151
|
+
this.configuration ??= {};
|
|
152
|
+
this.configuration.examples ??= [];
|
|
153
|
+
this.configuration.examples.push(...examples);
|
|
154
|
+
return this;
|
|
155
|
+
}
|
|
123
156
|
/**
|
|
124
157
|
* Gets help text for the current command as a string.
|
|
125
158
|
* @returns Help text for the current command.
|
|
@@ -131,11 +164,13 @@ class InternalCLI {
|
|
|
131
164
|
for (const key of this.commandChain) {
|
|
132
165
|
command = command.registeredCommands[key];
|
|
133
166
|
}
|
|
134
|
-
help.push(`Usage: ${
|
|
135
|
-
this.
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
167
|
+
help.push(`Usage: ${this.configuration?.usage
|
|
168
|
+
? this.configuration.usage
|
|
169
|
+
: [
|
|
170
|
+
this.name,
|
|
171
|
+
...this.commandChain,
|
|
172
|
+
...command.parser.configuredPositionals.map((p) => p.required ? `<${p.key}>` : `[${p.key}]`),
|
|
173
|
+
].join(' ')}`);
|
|
139
174
|
if (command.configuration?.description) {
|
|
140
175
|
help.push(command.configuration.description);
|
|
141
176
|
}
|
|
@@ -153,9 +188,53 @@ class InternalCLI {
|
|
|
153
188
|
help.push('');
|
|
154
189
|
help.push('Options:');
|
|
155
190
|
}
|
|
191
|
+
function getOptionParts(key, option) {
|
|
192
|
+
const parts = [];
|
|
193
|
+
if (option.description) {
|
|
194
|
+
parts.push(option.description);
|
|
195
|
+
}
|
|
196
|
+
if (option.choices) {
|
|
197
|
+
const choices = typeof option.choices === 'function'
|
|
198
|
+
? option.choices()
|
|
199
|
+
: option.choices;
|
|
200
|
+
parts.push(`(${choices.join(', ')})`);
|
|
201
|
+
}
|
|
202
|
+
if (option.default) {
|
|
203
|
+
parts.push('[default: ' + option.default + ']');
|
|
204
|
+
}
|
|
205
|
+
else if (option.required) {
|
|
206
|
+
parts.push('[required]');
|
|
207
|
+
}
|
|
208
|
+
if (option.deprecated) {
|
|
209
|
+
parts.push('[deprecated: ' + option.deprecated + ']');
|
|
210
|
+
}
|
|
211
|
+
return parts;
|
|
212
|
+
}
|
|
213
|
+
const allParts = [];
|
|
156
214
|
for (const key in this.parser.configuredOptions) {
|
|
157
215
|
const option = this.parser.configuredOptions[key];
|
|
158
|
-
|
|
216
|
+
allParts.push([key, ...getOptionParts(key, option)]);
|
|
217
|
+
}
|
|
218
|
+
const paddingValues = [];
|
|
219
|
+
for (let i = 0; i < allParts.length; i++) {
|
|
220
|
+
for (let j = 0; j < allParts[i].length; j++) {
|
|
221
|
+
if (!paddingValues[j]) {
|
|
222
|
+
paddingValues[j] = 0;
|
|
223
|
+
}
|
|
224
|
+
paddingValues[j] = Math.max(paddingValues[j], allParts[i][j].length);
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
for (const [key, ...parts] of allParts) {
|
|
228
|
+
help.push(` --${key.padEnd(paddingValues[0])}${parts.length ? ' - ' : ''}${parts
|
|
229
|
+
.map((part, i) => part.padEnd(paddingValues[i + 1]))
|
|
230
|
+
.join(' ')}`);
|
|
231
|
+
}
|
|
232
|
+
if (command.configuration?.examples?.length) {
|
|
233
|
+
help.push('');
|
|
234
|
+
help.push('Examples:');
|
|
235
|
+
for (const example of command.configuration.examples) {
|
|
236
|
+
help.push(` \`${example}\``);
|
|
237
|
+
}
|
|
159
238
|
}
|
|
160
239
|
if (Object.keys(command.registeredCommands).length > 0) {
|
|
161
240
|
help.push(' ');
|
|
@@ -199,11 +278,24 @@ class InternalCLI {
|
|
|
199
278
|
* @param args argv. Defaults to process.argv.slice(2)
|
|
200
279
|
* @returns Promise that resolves when the handler completes.
|
|
201
280
|
*/
|
|
202
|
-
async forge(args = process.argv
|
|
281
|
+
async forge(args = (0, parser_1.hideBin)(process.argv)) {
|
|
203
282
|
// Parsing the args does two things:
|
|
204
283
|
// - builds argv to pass to handler
|
|
205
284
|
// - fills the command chain + registers commands
|
|
206
|
-
|
|
285
|
+
let argv;
|
|
286
|
+
let validationFailedError;
|
|
287
|
+
try {
|
|
288
|
+
argv = this.parser.parse(args);
|
|
289
|
+
}
|
|
290
|
+
catch (e) {
|
|
291
|
+
if (e instanceof parser_1.ValidationFailedError) {
|
|
292
|
+
argv = e.partialArgV;
|
|
293
|
+
validationFailedError = e;
|
|
294
|
+
}
|
|
295
|
+
else {
|
|
296
|
+
throw e;
|
|
297
|
+
}
|
|
298
|
+
}
|
|
207
299
|
// eslint-disable-next-line @typescript-eslint/no-this-alias
|
|
208
300
|
let currentCommand = this;
|
|
209
301
|
for (const command of this.commandChain) {
|
|
@@ -211,13 +303,18 @@ class InternalCLI {
|
|
|
211
303
|
}
|
|
212
304
|
if (argv.help) {
|
|
213
305
|
this.printHelp();
|
|
214
|
-
return;
|
|
306
|
+
return argv;
|
|
307
|
+
}
|
|
308
|
+
else if (validationFailedError) {
|
|
309
|
+
this.printHelp();
|
|
310
|
+
throw validationFailedError;
|
|
215
311
|
}
|
|
216
312
|
const finalArgV = currentCommand === this
|
|
217
313
|
? (this.configuration?.builder?.(this)
|
|
218
314
|
?.parser ?? this.parser).parse(args)
|
|
219
315
|
: argv;
|
|
220
316
|
await this.runCommand(currentCommand, finalArgV);
|
|
317
|
+
return finalArgV;
|
|
221
318
|
}
|
|
222
319
|
getParser() {
|
|
223
320
|
return this.parser.asReadonly();
|
|
@@ -249,6 +346,9 @@ function cli(name, rootCommandConfiguration) {
|
|
|
249
346
|
if (rootCommandConfiguration) {
|
|
250
347
|
cli.withRootCommandConfiguration(rootCommandConfiguration);
|
|
251
348
|
}
|
|
349
|
+
else {
|
|
350
|
+
cli.demandCommand();
|
|
351
|
+
}
|
|
252
352
|
return cli;
|
|
253
353
|
}
|
|
254
354
|
exports.default = cli;
|
package/src/lib/cli-forge.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli-forge.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/src/lib/cli-forge.ts"],"names":[],"mappings":";;;AA2bA,kBAWC;AAtcD,8CAK2B;AAkI3B;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,WAAW;IAkCH;IA/BX,kBAAkB,GAAqC,EAAE,CAAC;IAC1D,YAAY,GAAa,EAAE,CAAC;IAC5B,eAAe,GAAG,KAAK,CAAC;IAExB,cAAc,CAA+B;IAE7C,MAAM,GAAG,IAAI,mBAAU,CAAQ;QACrC,eAAe,EAAE,CAAC,GAAG,EAAE,EAAE;YACvB,4DAA4D;YAC5D,IAAI,cAAc,GAAqB,IAAI,CAAC;YAC5C,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACxC,cAAc,GAAG,cAAc,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAC9D,CAAC;YACD,MAAM,OAAO,GAAG,cAAc,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;YACvD,IAAI,OAAO,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;gBACrC,OAAO,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC;gBACzC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC5B,OAAO,IAAI,CAAC;YACd,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,CAAC,GAAG,CAAC;QACZ,WAAW,EAAE,mCAAmC;KACjD,CAAC,CAAC;IAEH;;;OAGG;IACH,YAAmB,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAEnC,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,IAAY,aAAa,CAAC,KAA8C;QACtE,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;IAC9B,CAAC;IAED,4BAA4B,CAC1B,aAAyD;QAEzD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAWD,OAAO,CACL,YAAmD,EACnD,OAAgD;QAEhD,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;YACrC,MAAM,GAAG,GAAG,YAAY,CAAC;YACzB,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;YACJ,CAAC;YACD,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBACjB,IAAI,CAAC,aAAa,GAAG;oBACnB,GAAG,IAAI,CAAC,aAAa;oBACrB,OAAO,EAAE,OAAO,CAAC,OAAc;oBAC/B,OAAO,EAAE,OAAO,CAAC,OAAc;oBAC/B,WAAW,EAAE,OAAO,CAAC,WAAW;iBACjC,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,IAAI,WAAW,CAC5C,GAAG,CACJ,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;YACxC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACpD,CAAC;aAAM,IAAI,YAAY,YAAY,WAAW,EAAE,CAAC;YAC/C,MAAM,GAAG,GAAG,YAAY,CAAC;YACzB,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,MAAM,EAAE,IAAI,EAAE,GAAG,aAAa,EAAE,GAAG,YAEO,CAAC;YAC3C,IAAI,CAAC,OAAO,CAAe,IAAI,EAAE,aAAa,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAID,QAAQ,CAAC,GAAG,EAA2B;QACrC,MAAM,QAAQ,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC;QAC3B,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,IAAI,GAAG,YAAY,WAAW,EAAE,CAAC;gBAC/B,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;gBACxC,qFAAqF;gBACrF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAChC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACN,MAAM,EAAE,IAAI,EAAE,GAAG,aAAa,EAAE,GAAG,GAEJ,CAAC;gBAChC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CACJ,IAAa,EACb,MAAqB;QAErB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACjC,OAAO,IAAW,CAAC;IACrB,CAAC;IAED,UAAU,CACR,IAAa,EACb,MAAqB;QAErB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACrC,OAAO,IAAW,CAAC;IACrB,CAAC;IAED,aAAa;QACX,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,4DAA4D;QAC5D,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACpC,OAAO,GAAG,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAgB,CAAC;QAC3D,CAAC;QACD,IAAI,CAAC,IAAI,CACP,UAAU;YACR,IAAI,CAAC,IAAI;YACT,GAAG,IAAI,CAAC,YAAY;YACpB,GAAG,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;SACjE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CACd,CAAC;QACF,IAAI,OAAO,CAAC,aAAa,EAAE,WAAW,EAAE,CAAC;YACvC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzB,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;YAC7C,MAAM,UAAU,GAAG,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;YACnD,IAAI,CAAC,IAAI,CACP,KAAK,GAAG,GACN,UAAU,CAAC,aAAa,EAAE,WAAW;gBACnC,CAAC,CAAC,KAAK,GAAG,UAAU,CAAC,aAAa,CAAC,WAAW;gBAC9C,CAAC,CAAC,EACN,EAAE,CACH,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1D,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxB,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;YAChD,MAAM,MAAM,GAAI,IAAI,CAAC,MAAM,CAAC,iBAAyB,CACnD,GAAG,CACY,CAAC;YAClB,IAAI,CAAC,IAAI,CACP,OAAO,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,CACpE,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACf,IAAI,CAAC,IAAI,CACP,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAC7C,GAAG,CACJ,uDAAuD,CACzD,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAuB,GAAmB,EAAE,IAAO;QACjE,IAAI,CAAC;YACH,IAAI,GAAG,CAAC,eAAe,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CACb,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,qBAAqB,CACpE,CAAC;YACJ,CAAC;YACD,IAAI,GAAG,CAAC,aAAa,EAAE,OAAO,EAAE,CAAC;gBAC/B,MAAM,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE;oBACpC,OAAO,EAAE,GAAG;iBACb,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CACb,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,sBAAsB,CACrE,CAAC;YACJ,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,IAAI,CAAC,SAAS,EAAE,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,OAAiB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAChD,oCAAoC;QACpC,mCAAmC;QACnC,iDAAiD;QACjD,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACrC,4DAA4D;QAC5D,IAAI,cAAc,GAAqB,IAAI,CAAC;QAC5C,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACxC,cAAc,GAAG,cAAc,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC9D,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GACb,cAAc,KAAK,IAAI;YACrB,CAAC,CAAC,CACG,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,CAAC,IAAW,CAAwB;gBAChE,EAAE,MAAM,IAAI,IAAI,CAAC,MAAM,CAC1B,CAAC,KAAK,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,IAAI,CAAC;QAEX,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;IACnD,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;IAClC,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,kBAA2D,CAAC;IAC1E,CAAC;IAED,KAAK;QACH,MAAM,KAAK,GAAG,IAAI,WAAW,CAAQ,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACzD,CAAC;QACD,KAAK,CAAC,kBAAkB,GAAG,EAAE,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1D,KAAK,CAAC,YAAY,GAAG,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5C,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC7C,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAS,CAAC;QAC1C,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAzRD,kCAyRC;AAED;;;;;GAKG;AACH,SAAgB,GAAG,CACjB,IAAY,EACZ,wBAA+D;IAE/D,MAAM,GAAG,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;IAElC,IAAI,wBAAwB,EAAE,CAAC;QAC7B,GAAG,CAAC,4BAA4B,CAAC,wBAAwB,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,GAAiB,CAAC;AAC3B,CAAC;AAED,kBAAe,GAAG,CAAC"}
|
|
1
|
+
{"version":3,"file":"cli-forge.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/src/lib/cli-forge.ts"],"names":[],"mappings":";;;AA8lBA,kBAaC;AA3mBD,8CAQ2B;AAsL3B;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,WAAW;IAkDH;IA/CnB;;OAEG;IACH,kBAAkB,GAAqC,EAAE,CAAC;IAE1D;;OAEG;IACH,YAAY,GAAa,EAAE,CAAC;IAEpB,eAAe,GAAG,KAAK,CAAC;IAExB,cAAc,CAA+B;IAErD,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,IAAY,aAAa,CAAC,KAA8C;QACtE,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;IAC9B,CAAC;IAEO,MAAM,GAAG,IAAI,mBAAU,CAAQ;QACrC,eAAe,EAAE,CAAC,GAAG,EAAE,EAAE;YACvB,4DAA4D;YAC5D,IAAI,cAAc,GAAqB,IAAI,CAAC;YAC5C,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACxC,cAAc,GAAG,cAAc,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAC9D,CAAC;YACD,MAAM,OAAO,GAAG,cAAc,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;YACvD,IAAI,OAAO,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;gBACrC,OAAO,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC;gBACzC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC5B,OAAO,IAAI,CAAC;YACd,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,CAAC,GAAG,CAAC;QACZ,WAAW,EAAE,mCAAmC;KACjD,CAAC,CAAC;IAEH;;;OAGG;IACH,YAAmB,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAEnC,4BAA4B,CAC1B,aAAyD;QAEzD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAWD,OAAO,CACL,YAAmD,EACnD,OAAgD;QAEhD,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;YACrC,MAAM,GAAG,GAAG,YAAY,CAAC;YACzB,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;YACJ,CAAC;YACD,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBACjB,IAAI,CAAC,aAAa,GAAG;oBACnB,GAAG,IAAI,CAAC,aAAa;oBACrB,OAAO,EAAE,OAAO,CAAC,OAAc;oBAC/B,OAAO,EAAE,OAAO,CAAC,OAAc;oBAC/B,WAAW,EAAE,OAAO,CAAC,WAAW;iBACjC,CAAC;gBACF,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;YAC/B,CAAC;YACD,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,IAAI,WAAW,CAC5C,GAAG,CACJ,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;YACxC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACpD,CAAC;aAAM,IAAI,YAAY,YAAY,WAAW,EAAE,CAAC;YAC/C,MAAM,GAAG,GAAG,YAAY,CAAC;YACzB,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,MAAM,EAAE,IAAI,EAAE,GAAG,aAAa,EAAE,GAAG,YAEO,CAAC;YAC3C,IAAI,CAAC,OAAO,CAAe,IAAI,EAAE,aAAa,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAID,QAAQ,CAAC,GAAG,EAA2B;QACrC,MAAM,QAAQ,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC;QAC3B,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,IAAI,GAAG,YAAY,WAAW,EAAE,CAAC;gBAC/B,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;gBACxC,qFAAqF;gBACrF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAChC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACN,MAAM,EAAE,IAAI,EAAE,GAAG,aAAa,EAAE,GAAG,GAEJ,CAAC;gBAChC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CACJ,IAAa,EACb,MAAqB;QAErB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACjC,4FAA4F;QAC5F,OAAO,IAAW,CAAC;IACrB,CAAC;IAED,UAAU,CACR,IAAa,EACb,MAAqB;QAErB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACrC,4FAA4F;QAC5F,OAAO,IAAW,CAAC;IACrB,CAAC;IAED,SAAS,CAAC,GAAG,IAAmC;QAC9C,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CAAC,MAAc,EAAE,GAAG,cAAwB;QACjD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,cAAc,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,GAAG,CAAC,MAAM,GAAG,IAAA,yCAAgC,EAAC,IAAI,CAAC,IAAI,CAAC;QACtD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;QACX,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,SAAiB;QACrB,IAAI,CAAC,aAAa,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,aAAa,CAAC,KAAK,GAAG,SAAS,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,CAAC,GAAG,QAAkB;QAC5B,IAAI,CAAC,aAAa,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,aAAa,CAAC,QAAQ,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,4DAA4D;QAC5D,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACpC,OAAO,GAAG,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAgB,CAAC;QAC3D,CAAC;QACD,IAAI,CAAC,IAAI,CACP,UACE,IAAI,CAAC,aAAa,EAAE,KAAK;YACvB,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK;YAC1B,CAAC,CAAC;gBACE,IAAI,CAAC,IAAI;gBACT,GAAG,IAAI,CAAC,YAAY;gBACpB,GAAG,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAChD,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CACzC;aACF,CAAC,IAAI,CAAC,GAAG,CAChB,EAAE,CACH,CAAC;QACF,IAAI,OAAO,CAAC,aAAa,EAAE,WAAW,EAAE,CAAC;YACvC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzB,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;YAC7C,MAAM,UAAU,GAAG,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;YACnD,IAAI,CAAC,IAAI,CACP,KAAK,GAAG,GACN,UAAU,CAAC,aAAa,EAAE,WAAW;gBACnC,CAAC,CAAC,KAAK,GAAG,UAAU,CAAC,aAAa,CAAC,WAAW;gBAC9C,CAAC,CAAC,EACN,EAAE,CACH,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1D,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxB,CAAC;QAED,SAAS,cAAc,CAAC,GAAW,EAAE,MAAoB;YACvD,MAAM,KAAK,GAAG,EAAE,CAAC;YACjB,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;gBACvB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YACjC,CAAC;YACD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,MAAM,OAAO,GACX,OAAO,MAAM,CAAC,OAAO,KAAK,UAAU;oBAClC,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE;oBAClB,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;gBACrB,KAAK,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,KAAK,CAAC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC;YAClD,CAAC;iBAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAC3B,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC3B,CAAC;YACD,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;gBACtB,KAAK,CAAC,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,UAAU,GAAG,GAAG,CAAC,CAAC;YACxD,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,QAAQ,GAA6C,EAAE,CAAC;QAC9D,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;YAChD,MAAM,MAAM,GAAI,IAAI,CAAC,MAAM,CAAC,iBAAyB,CACnD,GAAG,CACY,CAAC;YAClB,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QACvD,CAAC;QACD,MAAM,aAAa,GAAa,EAAE,CAAC;QACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC5C,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;oBACtB,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;gBACvB,CAAC;gBACD,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YACvE,CAAC;QACH,CAAC;QACD,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,IAAI,QAAQ,EAAE,CAAC;YACvC,IAAI,CAAC,IAAI,CACP,OAAO,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK;iBACpE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;iBACnD,IAAI,CAAC,GAAG,CAAC,EAAE,CACf,CAAC;QACJ,CAAC;QAED,IAAI,OAAO,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;YAC5C,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACvB,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;gBACrD,IAAI,CAAC,IAAI,CAAC,OAAO,OAAO,IAAI,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACf,IAAI,CAAC,IAAI,CACP,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAC7C,GAAG,CACJ,uDAAuD,CACzD,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAuB,GAAmB,EAAE,IAAO;QACjE,IAAI,CAAC;YACH,IAAI,GAAG,CAAC,eAAe,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CACb,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,qBAAqB,CACpE,CAAC;YACJ,CAAC;YACD,IAAI,GAAG,CAAC,aAAa,EAAE,OAAO,EAAE,CAAC;gBAC/B,MAAM,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE;oBACpC,OAAO,EAAE,GAAG;iBACb,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CACb,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,sBAAsB,CACrE,CAAC;YACJ,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,IAAI,CAAC,SAAS,EAAE,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,OAAiB,IAAA,gBAAO,EAAC,OAAO,CAAC,IAAI,CAAC;QAChD,oCAAoC;QACpC,mCAAmC;QACnC,iDAAiD;QACjD,IAAI,IAAgC,CAAC;QACrC,IAAI,qBAA+D,CAAC;QACpE,IAAI,CAAC;YACH,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,8BAAqB,EAAE,CAAC;gBACvC,IAAI,GAAG,CAAC,CAAC,WAAoB,CAAC;gBAC9B,qBAAqB,GAAG,CAAC,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC;QACD,4DAA4D;QAC5D,IAAI,cAAc,GAAqB,IAAI,CAAC;QAC5C,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACxC,cAAc,GAAG,cAAc,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC9D,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;QACd,CAAC;aAAM,IAAI,qBAAqB,EAAE,CAAC;YACjC,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,MAAM,qBAAqB,CAAC;QAC9B,CAAC;QAED,MAAM,SAAS,GACb,cAAc,KAAK,IAAI;YACrB,CAAC,CAAC,CACG,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,CAAC,IAAW,CAAwB;gBAChE,EAAE,MAAM,IAAI,IAAI,CAAC,MAAM,CAC1B,CAAC,KAAK,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,IAAI,CAAC;QAEX,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;QACjD,OAAO,SAAkB,CAAC;IAC5B,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;IAClC,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,kBAA2D,CAAC;IAC1E,CAAC;IAED,KAAK;QACH,MAAM,KAAK,GAAG,IAAI,WAAW,CAAQ,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACzD,CAAC;QACD,KAAK,CAAC,kBAAkB,GAAG,EAAE,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1D,KAAK,CAAC,YAAY,GAAG,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5C,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC7C,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAS,CAAC;QAC1C,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AArYD,kCAqYC;AAED;;;;;GAKG;AACH,SAAgB,GAAG,CACjB,IAAY,EACZ,wBAA+D;IAE/D,MAAM,GAAG,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;IAElC,IAAI,wBAAwB,EAAE,CAAC;QAC7B,GAAG,CAAC,4BAA4B,CAAC,wBAAwB,CAAC,CAAC;IAC7D,CAAC;SAAM,CAAC;QACN,GAAG,CAAC,aAAa,EAAE,CAAC;IACtB,CAAC;IAED,OAAO,GAA6B,CAAC;AACvC,CAAC;AAED,kBAAe,GAAG,CAAC"}
|
|
@@ -3,6 +3,8 @@ import { InternalCLI } from './cli-forge';
|
|
|
3
3
|
export type Documentation = {
|
|
4
4
|
name: string;
|
|
5
5
|
description?: string;
|
|
6
|
+
usage: string;
|
|
7
|
+
examples: string[];
|
|
6
8
|
options: Readonly<Record<string, OptionConfig & {
|
|
7
9
|
key: string;
|
|
8
10
|
}>>;
|
|
@@ -11,9 +13,11 @@ export type Documentation = {
|
|
|
11
13
|
}>[];
|
|
12
14
|
subcommands: Documentation[];
|
|
13
15
|
};
|
|
14
|
-
export declare function generateDocumentation(cli: InternalCLI): {
|
|
16
|
+
export declare function generateDocumentation(cli: InternalCLI, commandChain?: string[]): {
|
|
15
17
|
name: string;
|
|
16
18
|
description: string | undefined;
|
|
19
|
+
usage: string;
|
|
20
|
+
examples: string[];
|
|
17
21
|
options: Readonly<{
|
|
18
22
|
unmatched: OptionConfig<any> & {
|
|
19
23
|
key: string;
|
package/src/lib/documentation.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.generateDocumentation = generateDocumentation;
|
|
4
|
-
function generateDocumentation(cli) {
|
|
4
|
+
function generateDocumentation(cli, commandChain = []) {
|
|
5
5
|
// Ensure current command's options are built.
|
|
6
6
|
if (cli.configuration?.builder) {
|
|
7
7
|
cli.configuration.builder(cli);
|
|
@@ -9,10 +9,20 @@ function generateDocumentation(cli) {
|
|
|
9
9
|
const parser = cli.getParser();
|
|
10
10
|
const options = parser.configuredOptions;
|
|
11
11
|
const positionals = parser.configuredPositionals;
|
|
12
|
-
const subcommands = Object.values(cli.getSubcommands()).map((cmd) => generateDocumentation(cmd.clone()));
|
|
12
|
+
const subcommands = Object.values(cli.getSubcommands()).map((cmd) => generateDocumentation(cmd.clone(), [...commandChain, cli.name]));
|
|
13
13
|
return {
|
|
14
14
|
name: cli.name,
|
|
15
15
|
description: cli.configuration?.description,
|
|
16
|
+
usage: cli.configuration?.usage
|
|
17
|
+
? commandChain.length
|
|
18
|
+
? [...commandChain, cli.configuration.usage].join(' ')
|
|
19
|
+
: cli.configuration?.usage
|
|
20
|
+
: [
|
|
21
|
+
...commandChain,
|
|
22
|
+
cli.name,
|
|
23
|
+
...positionals.map((p) => (p.required ? `<${p.key}>` : `[${p.key}]`)),
|
|
24
|
+
].join(' '),
|
|
25
|
+
examples: cli.configuration?.examples ?? [],
|
|
16
26
|
options,
|
|
17
27
|
positionals,
|
|
18
28
|
subcommands,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"documentation.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/src/lib/documentation.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"documentation.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/src/lib/documentation.ts"],"names":[],"mappings":";;AAaA,sDAiCC;AAjCD,SAAgB,qBAAqB,CACnC,GAAgB,EAChB,eAAyB,EAAE;IAE3B,8CAA8C;IAC9C,IAAI,GAAG,CAAC,aAAa,EAAE,OAAO,EAAE,CAAC;QAC/B,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;IACD,MAAM,MAAM,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;IAE/B,MAAM,OAAO,GAAG,MAAM,CAAC,iBAAiB,CAAC;IACzC,MAAM,WAAW,GAAG,MAAM,CAAC,qBAAqB,CAAC;IACjD,MAAM,WAAW,GAAoB,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,GAAG,CAC1E,CAAC,GAAG,EAAE,EAAE,CAAC,qBAAqB,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,YAAY,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CACzE,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,WAAW,EAAE,GAAG,CAAC,aAAa,EAAE,WAAW;QAC3C,KAAK,EAAE,GAAG,CAAC,aAAa,EAAE,KAAK;YAC7B,CAAC,CAAC,YAAY,CAAC,MAAM;gBACnB,CAAC,CAAC,CAAC,GAAG,YAAY,EAAE,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;gBACtD,CAAC,CAAC,GAAG,CAAC,aAAa,EAAE,KAAK;YAC5B,CAAC,CAAC;gBACE,GAAG,YAAY;gBACf,GAAG,CAAC,IAAI;gBACR,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;aACtE,CAAC,IAAI,CAAC,GAAG,CAAC;QACf,QAAQ,EAAE,GAAG,CAAC,aAAa,EAAE,QAAQ,IAAI,EAAE;QAC3C,OAAO;QACP,WAAW;QACX,WAAW;KACZ,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { ParsedArgs } from '@cli-forge/parser';
|
|
2
|
+
import { CLI } from './cli-forge';
|
|
3
|
+
export type TestHarnessParseResult<T extends ParsedArgs> = {
|
|
4
|
+
/**
|
|
5
|
+
* Parsed arguments. Note the the typing of this is based on the CLI typings,
|
|
6
|
+
* but no runtime validation outside of the configured validation checks on
|
|
7
|
+
* individual options will be performed. If you want to validate the arguments,
|
|
8
|
+
* you should do so in your test or configure a `validate` callback for the option.
|
|
9
|
+
*/
|
|
10
|
+
args: T;
|
|
11
|
+
/**
|
|
12
|
+
* The command chain that was resolved during parsing. This is used for testing
|
|
13
|
+
* that the correct command is ran when resolving a subcommand. A test that checks
|
|
14
|
+
* this may look like:
|
|
15
|
+
*
|
|
16
|
+
* ```ts
|
|
17
|
+
* const harness = new TestHarness(cli);
|
|
18
|
+
* const { args, commandChain } = await harness.parse(['hello', '--name=sir']);
|
|
19
|
+
* expect(commandChain).toEqual(['hello']);
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* The above test would check that the `hello` command was resolved when parsing
|
|
23
|
+
* the argstring, and since only one command's handler will ever be called, this
|
|
24
|
+
* can be used to ensure that the correct command is ran.
|
|
25
|
+
*/
|
|
26
|
+
commandChain: string[];
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Utility for testing CLI instances. Can check argument parsing and validation, including
|
|
30
|
+
* command chain resolution.
|
|
31
|
+
*/
|
|
32
|
+
export declare class TestHarness<T extends ParsedArgs> {
|
|
33
|
+
private cli;
|
|
34
|
+
constructor(cli: CLI<T>);
|
|
35
|
+
parse(args: string[]): Promise<TestHarnessParseResult<T>>;
|
|
36
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.TestHarness = void 0;
|
|
4
|
+
const cli_forge_1 = require("./cli-forge");
|
|
5
|
+
/**
|
|
6
|
+
* Utility for testing CLI instances. Can check argument parsing and validation, including
|
|
7
|
+
* command chain resolution.
|
|
8
|
+
*/
|
|
9
|
+
class TestHarness {
|
|
10
|
+
cli;
|
|
11
|
+
constructor(cli) {
|
|
12
|
+
if (cli instanceof cli_forge_1.InternalCLI) {
|
|
13
|
+
this.cli = cli;
|
|
14
|
+
mockHandler(cli);
|
|
15
|
+
}
|
|
16
|
+
else {
|
|
17
|
+
throw new Error('TestHarness can only be used with CLI instances created by `cli`.');
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
async parse(args) {
|
|
21
|
+
const argv = await this.cli.forge(args);
|
|
22
|
+
return {
|
|
23
|
+
args: argv,
|
|
24
|
+
commandChain: this.cli.commandChain,
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
exports.TestHarness = TestHarness;
|
|
29
|
+
function mockHandler(cli) {
|
|
30
|
+
if (cli.configuration?.handler) {
|
|
31
|
+
cli.configuration.handler = () => { };
|
|
32
|
+
}
|
|
33
|
+
for (const command in cli.registeredCommands) {
|
|
34
|
+
mockHandler(cli.registeredCommands[command]);
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=test-harness.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"test-harness.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/src/lib/test-harness.ts"],"names":[],"mappings":";;;AACA,2CAA+C;AA6B/C;;;GAGG;AACH,MAAa,WAAW;IACd,GAAG,CAAiB;IAE5B,YAAY,GAAW;QACrB,IAAI,GAAG,YAAY,uBAAW,EAAE,CAAC;YAC/B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;YACf,WAAW,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CACb,mEAAmE,CACpE,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAc;QACxB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAExC,OAAO;YACL,IAAI,EAAE,IAAI;YACV,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY;SACpC,CAAC;IACJ,CAAC;CACF;AAtBD,kCAsBC;AAED,SAAS,WAAW,CAAC,GAAgB;IACnC,IAAI,GAAG,CAAC,aAAa,EAAE,OAAO,EAAE,CAAC;QAC/B,GAAG,CAAC,aAAa,CAAC,OAAO,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;IACvC,CAAC;IACD,KAAK,MAAM,OAAO,IAAI,GAAG,CAAC,kBAAkB,EAAE,CAAC;QAC7C,WAAW,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC"}
|