cli-forge 0.1.0 → 0.3.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.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env node
2
+ declare const mycli: import("../src").CLI<import("dist/packages/parser/src").ParsedArgs, import("dist/packages/parser/src").ParsedArgs>;
3
+ export default mycli;
package/bin/cli.js ADDED
@@ -0,0 +1,10 @@
1
+ #!/usr/bin/env node
2
+ "use strict";
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ const src_1 = require("../src");
5
+ const generate_documentation_1 = require("./commands/generate-documentation");
6
+ const init_1 = require("./commands/init");
7
+ const mycli = (0, init_1.withInit)((0, generate_documentation_1.withGenerateDocumentation)((0, src_1.cli)('cli-forge')));
8
+ exports.default = mycli;
9
+ mycli.forge();
10
+ //# sourceMappingURL=cli.js.map
package/bin/cli.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../../packages/cli-forge/bin/cli.ts"],"names":[],"mappings":";;;AAEA,gCAA6B;AAC7B,8EAA8E;AAC9E,0CAA2C;AAE3C,MAAM,KAAK,GAAG,IAAA,eAAQ,EAAC,IAAA,kDAAyB,EAAC,IAAA,SAAG,EAAC,WAAW,CAAC,CAAC,CAAC,CAAC;AAEpE,kBAAe,KAAK,CAAC;AAErB,KAAK,CAAC,KAAK,EAAE,CAAC"}
@@ -0,0 +1,27 @@
1
+ import type { ParsedArgs } from '@cli-forge/parser';
2
+ import { CLI } from '../../src';
3
+ type GenerateDocsArgs = {
4
+ cli: string;
5
+ output: string;
6
+ format: string;
7
+ export: string;
8
+ };
9
+ export declare function withGenerateDocumentationArgs<T extends ParsedArgs>(cmd: CLI<T, T & GenerateDocsArgs>): CLI<T & {
10
+ cli: string;
11
+ } & {
12
+ output: string;
13
+ } & {
14
+ format: string;
15
+ } & {
16
+ export: string;
17
+ }, T & {
18
+ cli: string;
19
+ } & {
20
+ output: string;
21
+ } & {
22
+ format: string;
23
+ } & {
24
+ export: string;
25
+ }>;
26
+ export declare function withGenerateDocumentation<T extends ParsedArgs>(cli: CLI<T>): CLI<T, T>;
27
+ export {};
@@ -0,0 +1,124 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.withGenerateDocumentationArgs = withGenerateDocumentationArgs;
4
+ exports.withGenerateDocumentation = withGenerateDocumentation;
5
+ const node_fs_1 = require("node:fs");
6
+ const node_path_1 = require("node:path");
7
+ const src_1 = require("../../src");
8
+ const documentation_1 = require("../../src/lib/documentation");
9
+ const fs_1 = require("../utils/fs");
10
+ function withGenerateDocumentationArgs(cmd) {
11
+ return cmd
12
+ .positional('cli', {
13
+ type: 'string',
14
+ description: 'Path to the cli that docs should be generated for.',
15
+ required: true,
16
+ })
17
+ .option('output', {
18
+ alias: ['o'],
19
+ type: 'string',
20
+ description: 'Where should the documentation be output?',
21
+ default: 'docs',
22
+ })
23
+ .option('format', {
24
+ type: 'string',
25
+ description: 'What format should the documentation be output in? (json, md)',
26
+ default: 'md',
27
+ })
28
+ .option('export', {
29
+ type: 'string',
30
+ description: 'The name of the export that contains the CLI instance. By default, docs will be generated for the default export.',
31
+ });
32
+ }
33
+ function withGenerateDocumentation(cli) {
34
+ return cli.command('generate-documentation', {
35
+ description: 'Generate documentation for the given CLI',
36
+ builder: withGenerateDocumentationArgs,
37
+ handler: async (args) => {
38
+ if (args.cli.startsWith('./')) {
39
+ args.cli = (0, node_path_1.join)(process.cwd(), args.cli);
40
+ }
41
+ const cliModule = await Promise.resolve(`${args.cli}`).then(s => require(s));
42
+ const cli = cliModule[args.export || 'default'] ?? cliModule;
43
+ if (!(cli instanceof src_1.CLI)) {
44
+ throw new Error(`${args.cli}${args.export ? '#' + args.export : ''} is not a CLI.`);
45
+ }
46
+ const documentation = (0, documentation_1.generateDocumentation)(cli);
47
+ if (args.format === 'md') {
48
+ await generateMarkdownDocumentation(documentation, args);
49
+ }
50
+ else if (args.format === 'json') {
51
+ const outfile = args.output.endsWith('json')
52
+ ? args.output
53
+ : (0, node_path_1.join)(args.output, cli.name + '.json');
54
+ const outdir = (0, node_path_1.dirname)(outfile);
55
+ (0, fs_1.ensureDirSync)(outdir);
56
+ (0, node_fs_1.writeFileSync)(outfile, JSON.stringify(documentation, null, 2));
57
+ }
58
+ },
59
+ });
60
+ }
61
+ async function generateMarkdownDocumentation(docs, args) {
62
+ const md = await importMarkdownFactory();
63
+ await generateMarkdownForSingleCommand(docs, (0, node_path_1.join)(args.output, docs.name), md);
64
+ }
65
+ async function generateMarkdownForSingleCommand(docs, out, md) {
66
+ const subcommands = docs.subcommands;
67
+ const outdir = subcommands.length ? out : (0, node_path_1.dirname)(out);
68
+ const outname = subcommands.length ? 'index' : docs.name;
69
+ (0, fs_1.ensureDirSync)(outdir);
70
+ (0, node_fs_1.writeFileSync)((0, node_path_1.join)(outdir, outname + '.md'), md.h1(docs.name, ...[
71
+ docs.description,
72
+ getPositionalArgsFragment(docs.positionals, md),
73
+ getFlagArgsFragment(docs.options, md),
74
+ getSubcommandsFragment(docs.subcommands, md),
75
+ ].filter(isTruthy)));
76
+ for (const subcommand of docs.subcommands) {
77
+ await generateMarkdownForSingleCommand(subcommand, (0, node_path_1.join)(outdir, subcommand.name), md);
78
+ }
79
+ }
80
+ function formatOption(option, md) {
81
+ return md.h3(option.key, ...[
82
+ md.bold('Type:') +
83
+ ' ' +
84
+ (option.type === 'array'
85
+ ? `${option.items}[]`
86
+ : option.type),
87
+ option.description,
88
+ option.default ? md.bold('Default:') + ' ' + option.default : undefined,
89
+ option.required ? md.bold('Required') : undefined,
90
+ option.alias?.length
91
+ ? md.h4('Aliases', md.ul(...option.alias))
92
+ : undefined,
93
+ ].filter(isTruthy));
94
+ }
95
+ function getPositionalArgsFragment(positionals, md) {
96
+ if (positionals?.length === 0) {
97
+ return undefined;
98
+ }
99
+ return md.h2('Positional Arguments', ...positionals.map((positional) => formatOption(positional, md)));
100
+ }
101
+ function getFlagArgsFragment(options, md) {
102
+ if (Object.keys(options).length === 0) {
103
+ return undefined;
104
+ }
105
+ return md.h2('Flags', ...Object.values(options).map((option) => formatOption(option, md)));
106
+ }
107
+ function getSubcommandsFragment(subcommands, md) {
108
+ if (subcommands.length === 0) {
109
+ return undefined;
110
+ }
111
+ return md.h2('Subcommands', ...subcommands.map((subcommand) => md.link(`./${subcommand.name}`, subcommand.name)));
112
+ }
113
+ function isTruthy(value) {
114
+ return !!value;
115
+ }
116
+ async function importMarkdownFactory() {
117
+ try {
118
+ return await Promise.resolve().then(() => require('markdown-factory'));
119
+ }
120
+ catch {
121
+ throw new Error('Could not find markdown-factory. Please install it to generate markdown documentation.');
122
+ }
123
+ }
124
+ //# sourceMappingURL=generate-documentation.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generate-documentation.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/bin/commands/generate-documentation.ts"],"names":[],"mappings":";;AAqBA,sEA0BC;AAED,8DA4BC;AA3ED,qCAAwC;AACxC,yCAA0C;AAE1C,mCAAgC;AAChC,+DAGqC;AACrC,oCAA4C;AAW5C,SAAgB,6BAA6B,CAC3C,GAAiC;IAEjC,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,EACT,+DAA+D;QACjE,OAAO,EAAE,IAAI;KACd,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,mHAAmH;KACtH,CAAC,CAAC;AACP,CAAC;AAED,SAAgB,yBAAyB,CAAuB,GAAW;IACzE,OAAO,GAAG,CAAC,OAAO,CAAuB,wBAAwB,EAAE;QACjE,WAAW,EAAE,0CAA0C;QACvD,OAAO,EAAE,6BAA6B;QACtC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACtB,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,IAAI,CAAC,GAAG,GAAG,IAAA,gBAAI,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YAC3C,CAAC;YACD,MAAM,SAAS,GAAG,yBAAa,IAAI,CAAC,GAAG,yBAAC,CAAC;YACzC,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,IAAI,SAAS,CAAC,IAAI,SAAS,CAAC;YAC7D,IAAI,CAAC,CAAC,GAAG,YAAY,SAAG,CAAC,EAAE,CAAC;gBAC1B,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;YACJ,CAAC;YACD,MAAM,aAAa,GAAG,IAAA,qCAAqB,EAAC,GAAG,CAAC,CAAC;YACjD,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;gBACzB,MAAM,6BAA6B,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;YAC3D,CAAC;iBAAM,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBAClC,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;oBAC1C,CAAC,CAAC,IAAI,CAAC,MAAM;oBACb,CAAC,CAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC,CAAC;gBAC1C,MAAM,MAAM,GAAG,IAAA,mBAAO,EAAC,OAAO,CAAC,CAAC;gBAChC,IAAA,kBAAa,EAAC,MAAM,CAAC,CAAC;gBACtB,IAAA,uBAAa,EAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YACjE,CAAC;QACH,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,6BAA6B,CAC1C,IAAmB,EACnB,IAAsB;IAEtB,MAAM,EAAE,GAAG,MAAM,qBAAqB,EAAE,CAAC;IACzC,MAAM,gCAAgC,CACpC,IAAI,EACJ,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,EAC5B,EAAE,CACH,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,gCAAgC,CAC7C,IAAmB,EACnB,GAAW,EACX,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,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,EAAE,CAAC;KAC7C,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,EAAE,CACH,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,MAAwC,EAAE,EAAa;IAC3E,OAAO,EAAE,CAAC,EAAE,CACV,MAAM,CAAC,GAAG,EACV,GAAG;QACD,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,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;QACjD,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,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,CAAC,KAAK,UAAU,CAAC,IAAI,EAAE,EAAE,UAAU,CAAC,IAAI,CAAC,CACjD,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"}
@@ -0,0 +1,22 @@
1
+ import type { ParsedArgs } from '@cli-forge/parser';
2
+ import { CLI } from '../../src';
3
+ type InitArgs = {
4
+ cliName: string;
5
+ output: string;
6
+ format: string;
7
+ };
8
+ export declare function withInitArgs<T extends ParsedArgs>(cmd: CLI<T, T & InitArgs>): CLI<T & {
9
+ cliName: string;
10
+ } & {
11
+ output: string;
12
+ } & {
13
+ format: string;
14
+ }, T & {
15
+ cliName: string;
16
+ } & {
17
+ output: string;
18
+ } & {
19
+ format: string;
20
+ }>;
21
+ export declare function withInit<T extends ParsedArgs>(cli: CLI<T>): CLI<T, T>;
22
+ export {};
@@ -0,0 +1,94 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.withInitArgs = withInitArgs;
4
+ exports.withInit = withInit;
5
+ const node_fs_1 = require("node:fs");
6
+ const node_path_1 = require("node:path");
7
+ const fs_1 = require("../utils/fs");
8
+ const package_json_1 = require("../../package.json");
9
+ const node_child_process_1 = require("node:child_process");
10
+ function withInitArgs(cmd) {
11
+ return cmd
12
+ .positional('cliName', {
13
+ type: 'string',
14
+ description: 'Name of the CLI to generate.',
15
+ required: true,
16
+ })
17
+ .option('output', {
18
+ alias: ['o'],
19
+ type: 'string',
20
+ description: 'Where should the CLI be created?',
21
+ })
22
+ .option('format', {
23
+ type: 'string',
24
+ default: 'ts',
25
+ description: 'What format should the CLI be in? (js, ts)',
26
+ });
27
+ }
28
+ function withInit(cli) {
29
+ return cli.command('init', {
30
+ description: 'Generate a new CLI',
31
+ builder: withInitArgs,
32
+ handler: async (args) => {
33
+ args.output ??= process.cwd();
34
+ (0, fs_1.ensureDirSync)(args.output);
35
+ const packageJsonPath = (0, node_path_1.join)(args.output, 'package.json');
36
+ const cliPath = (0, node_path_1.join)(args.output, 'bin', `${args.cliName}.${args.format}`);
37
+ const packageJsonContent = readJsonOr(packageJsonPath, { name: args.cliName });
38
+ packageJsonContent.bin ??= {};
39
+ packageJsonContent.bin[args.cliName] = (0, node_path_1.relative)(args.output, cliPath);
40
+ packageJsonContent.dependencies ??= {};
41
+ packageJsonContent.dependencies['cli-forge'] ??= package_json_1.version;
42
+ (0, node_fs_1.writeFileSync)(packageJsonPath, JSON.stringify(packageJsonContent, null, 2));
43
+ (0, fs_1.ensureDirSync)((0, node_path_1.dirname)(cliPath));
44
+ (0, node_fs_1.writeFileSync)(cliPath, args.format === 'ts'
45
+ ? TS_CLI_CONTENTS(args.cliName)
46
+ : JS_CLI_CONTENTS(args.cliName));
47
+ const installCommand = (0, node_fs_1.existsSync)((0, node_path_1.join)(args.output, 'yarn.lock'))
48
+ ? 'yarn'
49
+ : (0, node_fs_1.existsSync)((0, node_path_1.join)(args.output, 'pnpm-lock.yaml'))
50
+ ? 'pnpm'
51
+ : (0, node_fs_1.existsSync)((0, node_path_1.join)(args.output, 'bun.lockb'))
52
+ ? 'bun'
53
+ : 'npm';
54
+ (0, node_child_process_1.execSync)(`${installCommand} install`);
55
+ },
56
+ });
57
+ }
58
+ const COMMON_CONTENTS = (name) => `const myCLI = cli('${name}')
59
+ .command('hello', {
60
+ builder: (args) => args.positional('name', {type: 'string'}),
61
+ handler: (args) => {
62
+ console.log('hello', args.name);
63
+ }
64
+ })`;
65
+ const JS_CLI_CONTENTS = (name) => `const { cli } = require('cli-forge');
66
+
67
+ ${COMMON_CONTENTS(name)}
68
+
69
+ module.exports = myCLI;
70
+
71
+ if (require.main === module) {
72
+ myCLI.forge();
73
+ }
74
+ `;
75
+ const TS_CLI_CONTENTS = (name) => `import { cli } from 'cli-forge';
76
+
77
+ ${COMMON_CONTENTS(name)}
78
+
79
+ export default myCLI;
80
+
81
+ if (require.main === module) {
82
+ myCLI.forge();
83
+ }
84
+ `;
85
+ function readJsonOr(filePath, alt) {
86
+ try {
87
+ const contents = (0, node_fs_1.readFileSync)(filePath, 'utf-8');
88
+ return JSON.parse(contents);
89
+ }
90
+ catch {
91
+ return alt;
92
+ }
93
+ }
94
+ //# sourceMappingURL=init.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"init.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/bin/commands/init.ts"],"names":[],"mappings":";;AAgBA,oCAiBC;AAED,4BA8CC;AAhFD,qCAAkE;AAClE,yCAAoD;AAGpD,oCAA4C;AAE5C,qDAAkE;AAClE,2DAA8C;AAQ9C,SAAgB,YAAY,CAAuB,GAAyB;IAC1E,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,4CAA4C;KAC1D,CAAC,CAAC;AACP,CAAC;AAED,SAAgB,QAAQ,CAAuB,GAAW;IACxD,OAAO,GAAG,CAAC,OAAO,CAAe,MAAM,EAAE;QACvC,WAAW,EAAE,oBAAoB;QACjC,OAAO,EAAE,YAAY;QACrB,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACtB,IAAI,CAAC,MAAM,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC;YAC9B,IAAA,kBAAa,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC3B,MAAM,eAAe,GAAG,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;YAC1D,MAAM,OAAO,GAAG,IAAA,gBAAI,EAClB,IAAI,CAAC,MAAM,EACX,KAAK,EACL,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,CACjC,CAAC;YACF,MAAM,kBAAkB,GAMpB,UAAU,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;YACxD,kBAAkB,CAAC,GAAG,KAAK,EAAE,CAAC;YAC9B,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,IAAA,oBAAQ,EAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YACtE,kBAAkB,CAAC,YAAY,KAAK,EAAE,CAAC;YACvC,kBAAkB,CAAC,YAAY,CAAC,WAAW,CAAC,KAAK,sBAAiB,CAAC;YACnE,IAAA,uBAAa,EACX,eAAe,EACf,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAC,CAC5C,CAAC;YACF,IAAA,kBAAa,EAAC,IAAA,mBAAO,EAAC,OAAO,CAAC,CAAC,CAAC;YAChC,IAAA,uBAAa,EACX,OAAO,EACP,IAAI,CAAC,MAAM,KAAK,IAAI;gBAClB,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC;gBAC/B,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAClC,CAAC;YACF,MAAM,cAAc,GAAG,IAAA,oBAAU,EAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;gBAC/D,CAAC,CAAC,MAAM;gBACR,CAAC,CAAC,IAAA,oBAAU,EAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;oBACjD,CAAC,CAAC,MAAM;oBACR,CAAC,CAAC,IAAA,oBAAU,EAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;wBAC5C,CAAC,CAAC,KAAK;wBACP,CAAC,CAAC,KAAK,CAAC;YAEV,IAAA,6BAAQ,EAAC,GAAG,cAAc,UAAU,CAAC,CAAC;QACxC,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,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"}
@@ -0,0 +1 @@
1
+ export declare function ensureDirSync(dir: string): void;
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ensureDirSync = ensureDirSync;
4
+ const node_fs_1 = require("node:fs");
5
+ function ensureDirSync(dir) {
6
+ try {
7
+ (0, node_fs_1.mkdirSync)(dir, { recursive: true });
8
+ }
9
+ catch (e) {
10
+ if (!(0, node_fs_1.existsSync)(dir)) {
11
+ throw new Error(`Could not create directory: ${dir}`, { cause: e });
12
+ }
13
+ }
14
+ }
15
+ //# sourceMappingURL=fs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fs.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/bin/utils/fs.ts"],"names":[],"mappings":";;AAEA,sCAQC;AAVD,qCAAgD;AAEhD,SAAgB,aAAa,CAAC,GAAW;IACvC,IAAI,CAAC;QACH,IAAA,mBAAS,EAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,CAAC,IAAA,oBAAU,EAAC,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,+BAA+B,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;AACH,CAAC"}
package/package.json CHANGED
@@ -1,11 +1,32 @@
1
1
  {
2
2
  "name": "cli-forge",
3
- "version": "0.1.0",
3
+ "version": "0.3.0",
4
4
  "dependencies": {
5
- "tslib": "^2.3.0"
5
+ "tslib": "^2.3.0",
6
+ "@cli-forge/parser": "0.3.0"
7
+ },
8
+ "peerDependencies": {
9
+ "markdown-factory": "0.2.0"
10
+ },
11
+ "peerDependenciesMeta": {
12
+ "markdown-factory": {
13
+ "optional": true
14
+ }
6
15
  },
7
16
  "type": "commonjs",
8
17
  "main": "./src/index.js",
9
18
  "typings": "./src/index.d.ts",
19
+ "license": "ISC",
20
+ "repository": {
21
+ "type": "git",
22
+ "directory": "packages/cli-forge",
23
+ "url": "https://github.com/AgentEnder/cli-forge"
24
+ },
25
+ "bin": {
26
+ "cli-forge": "./bin/cli.js"
27
+ },
28
+ "publishConfig": {
29
+ "access": "public"
30
+ },
10
31
  "types": "./src/index.d.ts"
11
32
  }
package/src/index.d.ts CHANGED
@@ -1 +1,2 @@
1
1
  export * from './lib/cli-forge';
2
+ export { default } from './lib/cli-forge';
package/src/index.js CHANGED
@@ -1,5 +1,8 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.default = void 0;
3
4
  const tslib_1 = require("tslib");
4
5
  tslib_1.__exportStar(require("./lib/cli-forge"), exports);
6
+ var cli_forge_1 = require("./lib/cli-forge");
7
+ Object.defineProperty(exports, "default", { enumerable: true, get: function () { return cli_forge_1.default; } });
5
8
  //# 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,0DAAgC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/cli-forge/src/index.ts"],"names":[],"mappings":";;;;AAAA,0DAAgC;AAChC,6CAA0C;AAAjC,oGAAA,OAAO,OAAA"}
@@ -1,35 +1,116 @@
1
1
  import { ArrayOptionConfig, OptionConfig, ParsedArgs } from '@cli-forge/parser';
2
- type CLICommandOptions<TInitial extends ParsedArgs, TArgs extends TInitial> = {
2
+ export type CLICommandOptions<TInitial extends ParsedArgs, TArgs extends TInitial> = {
3
3
  description?: string;
4
4
  builder?: (parser: CLI<TInitial>) => CLI<TArgs>;
5
- handler: (args: TArgs) => void;
5
+ handler: (args: TArgs) => void | Promise<void>;
6
6
  };
7
- export declare class CLI<T extends ParsedArgs> {
7
+ export type ArgsOf<T extends CLI> = T extends {
8
+ configuration: {
9
+ handler: (args: infer TArgs) => void;
10
+ };
11
+ } ? TArgs : never;
12
+ /**
13
+ * The base class for a CLI application. This class is used to define the structure of the CLI.
14
+ *
15
+ * {@link cli} is provided as a small helper function to create a new CLI instance.
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * import { cli } from 'cli-forge';
20
+ *
21
+ * cli('basic-cli').command('hello', {
22
+ * builder: (args) =>
23
+ * args.option('name', {
24
+ * type: 'string',
25
+ * }),
26
+ * handler: (args) => {
27
+ * console.log(`Hello, ${args.name}!`);
28
+ * }).forge();
29
+ * ```
30
+ */
31
+ export declare class CLI<T extends ParsedArgs = ParsedArgs, T2 extends T = T> {
8
32
  name: string;
9
- protected configuration?: CLICommandOptions<T, T> | undefined;
33
+ configuration?: CLICommandOptions<T, T2> | undefined;
10
34
  private commands;
11
35
  private commandChain;
12
36
  private requiresCommand;
13
37
  private parser;
14
- constructor(name: string, configuration?: CLICommandOptions<T, T> | undefined);
38
+ /**
39
+ * @param name What should the name of the cli command be?
40
+ * @param configuration Configuration for the current CLI command.
41
+ */
42
+ constructor(name: string, configuration?: CLICommandOptions<T, T2> | undefined);
43
+ /**
44
+ * Registers a new command with the CLI.
45
+ * @param key What should the new command be called?
46
+ * @param options Settings for the new command. See {@link CLICommandOptions}.
47
+ * @returns Updated CLI instance with the new command registered.
48
+ */
15
49
  command<TArgs extends T>(key: string, options: CLICommandOptions<T, TArgs>): this;
50
+ /**
51
+ * Registers a new option for the CLI command. This option will be accessible
52
+ * within the command handler, as well as any subcommands.
53
+ *
54
+ * @param name The name of the option.
55
+ * @param config Configuration for the option. See {@link OptionConfig}.
56
+ * @returns Updated CLI instance with the new option registered.
57
+ */
16
58
  option<TOption extends string, TOptionConfig extends OptionConfig>(name: TOption, config: TOptionConfig): CLI<T & { [key in TOption]: TOptionConfig["coerce"] extends (value: string) => infer TCoerce ? TCoerce : {
17
59
  string: string;
18
60
  number: number;
19
61
  boolean: boolean;
20
62
  array: (TOptionConfig extends ArrayOptionConfig<string | number> ? TOptionConfig["items"] extends "string" ? string : number : never)[];
21
63
  }[TOptionConfig["type"]]; }>;
22
- positional<TOption extends string, TOptionConfig extends OptionConfig>(name: TOption, config: TOptionConfig): CLI<T & { [key in TOption]: {
64
+ /**
65
+ * Registers a new positional argument for the CLI command. This argument will be accessible
66
+ * within the command handler, as well as any subcommands.
67
+ * @param name The name of the positional argument.
68
+ * @param config Configuration for the positional argument. See {@link OptionConfig}.
69
+ * @returns Updated CLI instance with the new positional argument registered.
70
+ */
71
+ positional<TOption extends string, TOptionConfig extends OptionConfig>(name: TOption, config: TOptionConfig): CLI<T & { [key in TOption]: TOptionConfig["coerce"] extends (value: string) => infer TCoerce ? TCoerce : {
23
72
  string: string;
24
73
  number: number;
25
74
  boolean: boolean;
26
75
  array: (TOptionConfig extends ArrayOptionConfig<string | number> ? TOptionConfig["items"] extends "string" ? string : number : never)[];
27
76
  }[TOptionConfig["type"]]; }>;
77
+ /**
78
+ * Requires a command to be provided when executing the CLI. Useful if your parent command
79
+ * cannot be executed on its own.
80
+ * @returns Updated CLI instance.
81
+ */
28
82
  demandCommand(): this;
83
+ /**
84
+ * Gets help text for the current command as a string.
85
+ * @returns Help text for the current command.
86
+ */
29
87
  formatHelp(): string;
88
+ /**
89
+ * Prints help text for the current command to the console.
90
+ */
30
91
  printHelp(): void;
92
+ /**
93
+ * Runs the current command.
94
+ * @param cmd The command to run.
95
+ * @param args The arguments to pass to the command.
96
+ */
31
97
  runCommand<T extends ParsedArgs>(cmd: CLI<T>, args: T): Promise<void>;
98
+ /**
99
+ * Parses argv and executes the CLI
100
+ * @param args argv. Defaults to process.argv.slice(2)
101
+ * @returns Promise that resolves when the handler completes.
102
+ */
32
103
  forge(args?: string[]): Promise<void>;
104
+ getParser(): import("@cli-forge/parser").ReadonlyArgvParser<T & {
105
+ help: boolean;
106
+ }>;
107
+ getSubcommands(): Readonly<Record<string, CLI>>;
108
+ clone(): CLI<T, T2>;
33
109
  }
34
- export declare function cli(name: string): CLI<ParsedArgs>;
110
+ /**
111
+ * Constructs a CLI instance. See {@link CLI} for more information.
112
+ * @param name Name for the top level CLI
113
+ * @returns
114
+ */
115
+ export declare function cli(name: string): CLI<ParsedArgs, ParsedArgs>;
35
116
  export default cli;
@@ -2,65 +2,128 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.CLI = void 0;
4
4
  exports.cli = cli;
5
- const tslib_1 = require("tslib");
6
5
  const parser_1 = require("@cli-forge/parser");
6
+ /**
7
+ * The base class for a CLI application. This class is used to define the structure of the CLI.
8
+ *
9
+ * {@link cli} is provided as a small helper function to create a new CLI instance.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * import { cli } from 'cli-forge';
14
+ *
15
+ * cli('basic-cli').command('hello', {
16
+ * builder: (args) =>
17
+ * args.option('name', {
18
+ * type: 'string',
19
+ * }),
20
+ * handler: (args) => {
21
+ * console.log(`Hello, ${args.name}!`);
22
+ * }).forge();
23
+ * ```
24
+ */
7
25
  class CLI {
26
+ name;
27
+ configuration;
28
+ commands = {};
29
+ commandChain = [];
30
+ requiresCommand = false;
31
+ parser = new parser_1.ArgvParser({
32
+ unmatchedParser: (arg) => {
33
+ // eslint-disable-next-line @typescript-eslint/no-this-alias
34
+ let currentCommand = this;
35
+ for (const command of this.commandChain) {
36
+ currentCommand = currentCommand.commands[command];
37
+ }
38
+ const command = currentCommand.commands[arg];
39
+ if (command && command.configuration) {
40
+ command.configuration.builder?.(command);
41
+ this.commandChain.push(arg);
42
+ return true;
43
+ }
44
+ return false;
45
+ },
46
+ }).option('help', {
47
+ type: 'boolean',
48
+ alias: ['h'],
49
+ description: 'Show help for the current command',
50
+ });
51
+ /**
52
+ * @param name What should the name of the cli command be?
53
+ * @param configuration Configuration for the current CLI command.
54
+ */
8
55
  constructor(name, configuration) {
9
56
  this.name = name;
10
57
  this.configuration = configuration;
11
- this.commands = {};
12
- this.commandChain = [];
13
- this.requiresCommand = false;
14
- this.parser = new parser_1.ArgvParser({
15
- unmatchedParser: (arg, tokens, parser) => {
16
- var _a, _b;
17
- let currentCommand = this;
18
- for (const command of this.commandChain) {
19
- currentCommand = currentCommand.commands[command];
20
- }
21
- const command = currentCommand.commands[arg];
22
- if (command && command.configuration) {
23
- (_b = (_a = command.configuration).builder) === null || _b === void 0 ? void 0 : _b.call(_a, command);
24
- this.commandChain.push(arg);
25
- return true;
26
- }
27
- return false;
28
- },
29
- }).option('help', {
30
- type: 'boolean',
31
- alias: ['-h'],
32
- description: 'Show help for the current command',
33
- });
34
58
  }
59
+ /**
60
+ * Registers a new command with the CLI.
61
+ * @param key What should the new command be called?
62
+ * @param options Settings for the new command. See {@link CLICommandOptions}.
63
+ * @returns Updated CLI instance with the new command registered.
64
+ */
35
65
  command(key, options) {
36
66
  if (key === '$0') {
37
- this.configuration = Object.assign(Object.assign({}, this.configuration), { builder: options.builder, handler: options.handler, description: options.description });
67
+ this.configuration = {
68
+ ...this.configuration,
69
+ builder: options.builder,
70
+ handler: options.handler,
71
+ description: options.description,
72
+ };
38
73
  }
39
74
  this.commands[key] = new CLI(key, options);
40
75
  this.commands[key].parser = this.parser;
41
76
  return this;
42
77
  }
78
+ /**
79
+ * Registers a new option for the CLI command. This option will be accessible
80
+ * within the command handler, as well as any subcommands.
81
+ *
82
+ * @param name The name of the option.
83
+ * @param config Configuration for the option. See {@link OptionConfig}.
84
+ * @returns Updated CLI instance with the new option registered.
85
+ */
43
86
  option(name, config) {
44
87
  this.parser.option(name, config);
45
88
  return this;
46
89
  }
90
+ /**
91
+ * Registers a new positional argument for the CLI command. This argument will be accessible
92
+ * within the command handler, as well as any subcommands.
93
+ * @param name The name of the positional argument.
94
+ * @param config Configuration for the positional argument. See {@link OptionConfig}.
95
+ * @returns Updated CLI instance with the new positional argument registered.
96
+ */
47
97
  positional(name, config) {
48
- this.parser.option(name, config);
98
+ this.parser.positional(name, config);
49
99
  return this;
50
100
  }
101
+ /**
102
+ * Requires a command to be provided when executing the CLI. Useful if your parent command
103
+ * cannot be executed on its own.
104
+ * @returns Updated CLI instance.
105
+ */
51
106
  demandCommand() {
52
107
  this.requiresCommand = true;
53
108
  return this;
54
109
  }
110
+ /**
111
+ * Gets help text for the current command as a string.
112
+ * @returns Help text for the current command.
113
+ */
55
114
  formatHelp() {
56
- var _a, _b;
57
115
  const help = [];
116
+ // eslint-disable-next-line @typescript-eslint/no-this-alias
58
117
  let command = this;
59
118
  for (const key of this.commandChain) {
60
119
  command = command.commands[key];
61
120
  }
62
- help.push(`Usage: ${[this.name, ...this.commandChain].join(' ')}`);
63
- if ((_a = command.configuration) === null || _a === void 0 ? void 0 : _a.description) {
121
+ help.push(`Usage: ${[
122
+ this.name,
123
+ ...this.commandChain,
124
+ ...command.parser.configuredPositionals.map((p) => `[${p.key}]`),
125
+ ].join(' ')}`);
126
+ if (command.configuration?.description) {
64
127
  help.push(command.configuration.description);
65
128
  }
66
129
  if (Object.keys(command.commands).length > 0) {
@@ -69,7 +132,7 @@ class CLI {
69
132
  }
70
133
  for (const key in command.commands) {
71
134
  const subcommand = command.commands[key];
72
- help.push(` ${key}${((_b = subcommand.configuration) === null || _b === void 0 ? void 0 : _b.description)
135
+ help.push(` ${key}${subcommand.configuration?.description
73
136
  ? ' - ' + subcommand.configuration.description
74
137
  : ''}`);
75
138
  }
@@ -87,46 +150,80 @@ class CLI {
87
150
  }
88
151
  return help.join('\n');
89
152
  }
153
+ /**
154
+ * Prints help text for the current command to the console.
155
+ */
90
156
  printHelp() {
91
157
  console.log(this.formatHelp());
92
158
  }
93
- runCommand(cmd, args) {
94
- return tslib_1.__awaiter(this, void 0, void 0, function* () {
95
- try {
96
- if (cmd.requiresCommand) {
97
- throw new Error(`${[this.name, ...this.commandChain].join(' ')} requires a command`);
98
- }
99
- yield cmd.configuration.handler(args);
159
+ /**
160
+ * Runs the current command.
161
+ * @param cmd The command to run.
162
+ * @param args The arguments to pass to the command.
163
+ */
164
+ async runCommand(cmd, args) {
165
+ try {
166
+ if (cmd.requiresCommand) {
167
+ throw new Error(`${[this.name, ...this.commandChain].join(' ')} requires a command`);
100
168
  }
101
- catch (_a) {
102
- process.exitCode = 1;
103
- this.printHelp();
169
+ if (cmd.configuration?.handler) {
170
+ await cmd.configuration.handler(args);
104
171
  }
105
- });
106
- }
107
- forge() {
108
- return tslib_1.__awaiter(this, arguments, void 0, function* (args = process.argv.slice(2)) {
109
- var _a, _b, _c;
110
- // Parsing the args does two things:
111
- // - builds argv to pass to handler
112
- // - fills the command chain + registers commands
113
- const argv = this.parser.parse(args);
114
- let currentCommand = this;
115
- for (const command of this.commandChain) {
116
- currentCommand = currentCommand.commands[command];
172
+ else {
173
+ throw new Error(`${[this.name, ...this.commandChain].join(' ')} is not implemented.`);
117
174
  }
118
- if (argv.help) {
119
- this.printHelp();
120
- return;
121
- }
122
- const finalArgV = currentCommand === this
123
- ? ((_c = (_b = (_a = this.configuration) === null || _a === void 0 ? void 0 : _a.builder) === null || _b === void 0 ? void 0 : _b.call(_a, this).parser) !== null && _c !== void 0 ? _c : this.parser).parse(args)
124
- : argv;
125
- yield this.runCommand(currentCommand, finalArgV);
126
- });
175
+ }
176
+ catch (e) {
177
+ process.exitCode = 1;
178
+ console.error(e);
179
+ this.printHelp();
180
+ }
181
+ }
182
+ /**
183
+ * Parses argv and executes the CLI
184
+ * @param args argv. Defaults to process.argv.slice(2)
185
+ * @returns Promise that resolves when the handler completes.
186
+ */
187
+ async forge(args = process.argv.slice(2)) {
188
+ // Parsing the args does two things:
189
+ // - builds argv to pass to handler
190
+ // - fills the command chain + registers commands
191
+ const argv = this.parser.parse(args);
192
+ // eslint-disable-next-line @typescript-eslint/no-this-alias
193
+ let currentCommand = this;
194
+ for (const command of this.commandChain) {
195
+ currentCommand = currentCommand.commands[command];
196
+ }
197
+ if (argv.help) {
198
+ this.printHelp();
199
+ return;
200
+ }
201
+ const finalArgV = currentCommand === this
202
+ ? (this.configuration?.builder?.(this).parser ?? this.parser).parse(args)
203
+ : argv;
204
+ await this.runCommand(currentCommand, finalArgV);
205
+ }
206
+ getParser() {
207
+ return this.parser.asReadonly();
208
+ }
209
+ getSubcommands() {
210
+ return this.commands;
211
+ }
212
+ clone() {
213
+ const clone = new CLI(this.name, this.configuration);
214
+ clone.commands = { ...this.commands };
215
+ clone.commandChain = [...this.commandChain];
216
+ clone.requiresCommand = this.requiresCommand;
217
+ clone.parser = this.parser.clone();
218
+ return clone;
127
219
  }
128
220
  }
129
221
  exports.CLI = CLI;
222
+ /**
223
+ * Constructs a CLI instance. See {@link CLI} for more information.
224
+ * @param name Name for the top level CLI
225
+ * @returns
226
+ */
130
227
  function cli(name) {
131
228
  return new CLI(name);
132
229
  }
@@ -1 +1 @@
1
- {"version":3,"file":"cli-forge.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/src/lib/cli-forge.ts"],"names":[],"mappings":";;;AAuMA,kBAEC;;AAzMD,8CAK2B;AAQ3B,MAAa,GAAG;IAwBd,YACS,IAAY,EACT,aAAuC;QAD1C,SAAI,GAAJ,IAAI,CAAQ;QACT,kBAAa,GAAb,aAAa,CAA0B;QAzB3C,aAAQ,GAA6B,EAAE,CAAC;QACxC,iBAAY,GAAa,EAAE,CAAC;QAC5B,oBAAe,GAAY,KAAK,CAAC;QACjC,WAAM,GAAG,IAAI,mBAAU,CAAI;YACjC,eAAe,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;;gBACvC,IAAI,cAAc,GAAa,IAAI,CAAC;gBACpC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;oBACxC,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBACpD,CAAC;gBACD,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC7C,IAAI,OAAO,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;oBACrC,MAAA,MAAA,OAAO,CAAC,aAAa,EAAC,OAAO,mDAAG,OAAO,CAAC,CAAC;oBACzC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAC5B,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;SACF,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE;YAChB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,CAAC,IAAI,CAAC;YACb,WAAW,EAAE,mCAAmC;SACjD,CAAC,CAAC;IAKA,CAAC;IAEJ,OAAO,CAAkB,GAAW,EAAE,OAAoC;QACxE,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,IAAI,CAAC,aAAa,mCACb,IAAI,CAAC,aAAa,KACrB,OAAO,EAAE,OAAO,CAAC,OAAc,EAC/B,OAAO,EAAE,OAAO,CAAC,OAAc,EAC/B,WAAW,EAAE,OAAO,CAAC,WAAW,GACjC,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAQ,GAAG,EAAE,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACxC,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,IAiBN,CAAC;IACJ,CAAC;IAED,UAAU,CACR,IAAa,EACb,MAAqB;QAErB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACjC,OAAO,IAaN,CAAC;IACJ,CAAC;IAED,aAAa;QACX,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,UAAU;;QACR,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACpC,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAgB,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACnE,IAAI,MAAA,OAAO,CAAC,aAAa,0CAAE,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,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzB,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACnC,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACzC,IAAI,CAAC,IAAI,CACP,KAAK,GAAG,GACN,CAAA,MAAA,UAAU,CAAC,aAAa,0CAAE,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,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7C,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,SAAS;QACP,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IACjC,CAAC;IAEK,UAAU,CAAuB,GAAW,EAAE,IAAO;;YACzD,IAAI,CAAC;gBACH,IAAI,GAAG,CAAC,eAAe,EAAE,CAAC;oBACxB,MAAM,IAAI,KAAK,CACb,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,qBAAqB,CACpE,CAAC;gBACJ,CAAC;gBACD,MAAM,GAAG,CAAC,aAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACzC,CAAC;YAAC,WAAM,CAAC;gBACP,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACrB,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,CAAC;QACH,CAAC;KAAA;IAEK,KAAK;qEAAC,OAAiB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;;YAChD,oCAAoC;YACpC,mCAAmC;YACnC,iDAAiD;YACjD,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACrC,IAAI,cAAc,GAAa,IAAI,CAAC;YACpC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACxC,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YACpD,CAAC;YACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,IAAI,CAAC,SAAS,EAAE,CAAC;gBACjB,OAAO;YACT,CAAC;YAED,MAAM,SAAS,GACb,cAAc,KAAK,IAAI;gBACrB,CAAC,CAAC,CAAC,MAAA,MAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,OAAO,mDAAG,IAAI,EAAE,MAAM,mCAAI,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAC/D,IAAI,CACL;gBACH,CAAC,CAAC,IAAI,CAAC;YAEX,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;QACnD,CAAC;KAAA;CACF;AAxLD,kBAwLC;AAED,SAAgB,GAAG,CAAC,IAAY;IAC9B,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;AACvB,CAAC;AAED,kBAAe,GAAG,CAAC"}
1
+ {"version":3,"file":"cli-forge.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/src/lib/cli-forge.ts"],"names":[],"mappings":";;;AA4TA,kBAEC;AA9TD,8CAK2B;AAiB3B;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,GAAG;IA8BL;IACA;IA9BD,QAAQ,GAA6B,EAAE,CAAC;IACxC,YAAY,GAAa,EAAE,CAAC;IAC5B,eAAe,GAAG,KAAK,CAAC;IACxB,MAAM,GAAG,IAAI,mBAAU,CAAI;QACjC,eAAe,EAAE,CAAC,GAAG,EAAE,EAAE;YACvB,4DAA4D;YAC5D,IAAI,cAAc,GAAa,IAAI,CAAC;YACpC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACxC,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YACpD,CAAC;YACD,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC7C,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,YACS,IAAY,EACZ,aAAwC;QADxC,SAAI,GAAJ,IAAI,CAAQ;QACZ,kBAAa,GAAb,aAAa,CAA2B;IAC9C,CAAC;IAEJ;;;;;OAKG;IACH,OAAO,CAAkB,GAAW,EAAE,OAAoC;QACxE,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,IAAI,CAAC,aAAa,GAAG;gBACnB,GAAG,IAAI,CAAC,aAAa;gBACrB,OAAO,EAAE,OAAO,CAAC,OAAc;gBAC/B,OAAO,EAAE,OAAO,CAAC,OAAc;gBAC/B,WAAW,EAAE,OAAO,CAAC,WAAW;aACjC,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAW,GAAG,EAAE,OAAO,CAAC,CAAC;QACrD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,IAAa,EACb,MAAqB;QAErB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACjC,OAAO,IAiBN,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CACR,IAAa,EACb,MAAqB;QAErB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACrC,OAAO,IAiBN,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,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,QAAQ,CAAC,GAAG,CAAgB,CAAC;QACjD,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,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzB,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACnC,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACzC,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,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7C,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,GAAW,EAAE,IAAO;QACzD,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,CAAC,CAAC;YACxC,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,GAAa,IAAI,CAAC;QACpC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACxC,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACpD,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,CACE,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,CAAC,IAAW,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CACjE,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,QAAyC,CAAC;IACxD,CAAC;IAED,KAAK;QACH,MAAM,KAAK,GAAG,IAAI,GAAG,CAAQ,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC5D,KAAK,CAAC,QAAQ,GAAG,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QACtC,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;AA5QD,kBA4QC;AAED;;;;GAIG;AACH,SAAgB,GAAG,CAAC,IAAY;IAC9B,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;AACvB,CAAC;AAED,kBAAe,GAAG,CAAC"}
@@ -0,0 +1,36 @@
1
+ import { OptionConfig } from '@cli-forge/parser';
2
+ import { CLI } from './cli-forge';
3
+ export type Documentation = {
4
+ name: string;
5
+ description?: string;
6
+ options: Readonly<Record<string, OptionConfig & {
7
+ key: string;
8
+ }>>;
9
+ positionals: readonly Readonly<OptionConfig & {
10
+ key: string;
11
+ }>[];
12
+ subcommands: Documentation[];
13
+ };
14
+ export declare function generateDocumentation(cli: CLI): {
15
+ name: string;
16
+ description: string | undefined;
17
+ options: Readonly<{
18
+ unmatched: OptionConfig<any> & {
19
+ key: string;
20
+ position?: number;
21
+ };
22
+ '--'?: (OptionConfig<any> & {
23
+ key: string;
24
+ position?: number;
25
+ }) | undefined;
26
+ help: OptionConfig<any> & {
27
+ key: string;
28
+ position?: number;
29
+ };
30
+ }>;
31
+ positionals: readonly Readonly<OptionConfig<any> & {
32
+ key: string;
33
+ position?: number;
34
+ }>[];
35
+ subcommands: Documentation[];
36
+ };
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.generateDocumentation = generateDocumentation;
4
+ function generateDocumentation(cli) {
5
+ // Ensure current command's options are built.
6
+ if (cli.configuration?.builder) {
7
+ cli.configuration.builder(cli);
8
+ }
9
+ const parser = cli.getParser();
10
+ const options = parser.configuredOptions;
11
+ const positionals = parser.configuredPositionals;
12
+ const subcommands = Object.values(cli.getSubcommands()).map((cmd) => generateDocumentation(cmd.clone()));
13
+ return {
14
+ name: cli.name,
15
+ description: cli.configuration?.description,
16
+ options,
17
+ positionals,
18
+ subcommands,
19
+ };
20
+ }
21
+ //# sourceMappingURL=documentation.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"documentation.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/src/lib/documentation.ts"],"names":[],"mappings":";;AAWA,sDAoBC;AApBD,SAAgB,qBAAqB,CAAC,GAAQ;IAC5C,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,CAAC,CAC5C,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,WAAW,EAAE,GAAG,CAAC,aAAa,EAAE,WAAW;QAC3C,OAAO;QACP,WAAW;QACX,WAAW;KACZ,CAAC;AACJ,CAAC"}