cli-forge 0.4.0 → 0.6.0

package/bin/cli.js

@@ -6,5 +6,9 @@ const generate_documentation_1 = require("./commands/generate-documentation");
 const init_1 = require("./commands/init");
 const mycli = (0, src_1.cli)('cli-forge').commands(generate_documentation_1.generateDocumentationCommand, init_1.initCommand);
 exports.default = mycli;
-mycli.forge();
+if (require.main === module) {
+    (async () => {
+        await mycli.forge();
+    })();
+}
 //# sourceMappingURL=cli.js.map

package/bin/cli.js.map

@@ -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"}
+{"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"}

package/bin/commands/generate-documentation.d.ts

@@ -8,5 +8,7 @@ export declare function withGenerateDocumentationArgs<T extends ParsedArgs>(cmd:
     format: string;
 } & {
     export: string;
+} & {
+    tsconfig: string;
 }>;
 export declare const generateDocumentationCommand: CLI;

package/bin/commands/generate-documentation.js

@@ -4,10 +4,12 @@ exports.generateDocumentationCommand = void 0;
 exports.withGenerateDocumentationArgs = withGenerateDocumentationArgs;
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
+const posix_1 = require("node:path/posix");
 const src_1 = require("../../src");
 const documentation_1 = require("../../src/lib/documentation");
 const cli_forge_1 = require("../../src/lib/cli-forge");
 const fs_1 = require("../utils/fs");
+const node_url_1 = require("node:url");
 function withGenerateDocumentationArgs(cmd) {
     return cmd
         .positional('cli', {
@@ -23,26 +25,25 @@ function withGenerateDocumentationArgs(cmd) {
     })
         .option('format', {
         type: 'string',
-        description: 'What format should the documentation be output in? (json, md)',
+        description: 'What format should the documentation be output in?',
         default: 'md',
+        choices: ['json', 'md'],
     })
         .option('export', {
         type: 'string',
         description: 'The name of the export that contains the CLI instance. By default, docs will be generated for the default export.',
+    })
+        .option('tsconfig', {
+        type: 'string',
+        description: 'Specifies the `tsconfig` used when loading typescript based CLIs.',
     });
 }
 exports.generateDocumentationCommand = (0, src_1.default)('generate-documentation', {
     description: 'Generate documentation for the given CLI',
     builder: (b) => withGenerateDocumentationArgs(b),
     handler: async (args) => {
-        if (args.cli.startsWith('./')) {
-            args.cli = (0, node_path_1.join)(process.cwd(), args.cli);
-        }
-        const cliModule = await Promise.resolve(`${args.cli}`).then(s => require(s));
-        const cli = cliModule[args.export || 'default'] ?? cliModule;
-        if (!(cli instanceof cli_forge_1.InternalCLI)) {
-            throw new Error(`${args.cli}${args.export ? '#' + args.export : ''} is not a CLI.`);
-        }
+        const cliModule = await loadCLIModule(args);
+        let cli = readCLIFromModule(cliModule, args);
         const documentation = (0, documentation_1.generateDocumentation)(cli);
         if (args.format === 'md') {
             await generateMarkdownDocumentation(documentation, args);
@@ -59,25 +60,28 @@ exports.generateDocumentationCommand = (0, src_1.default)('generate-documentatio
 });
 async function generateMarkdownDocumentation(docs, args) {
     const md = await importMarkdownFactory();
-    await generateMarkdownForSingleCommand(docs, (0, node_path_1.join)(args.output, docs.name), md);
+    await generateMarkdownForSingleCommand(docs, args.output, args.output, md);
 }
-async function generateMarkdownForSingleCommand(docs, out, md) {
+async function generateMarkdownForSingleCommand(docs, out, docsRoot, md) {
     const subcommands = docs.subcommands;
     const outdir = subcommands.length ? out : (0, node_path_1.dirname)(out);
     const outname = subcommands.length ? 'index' : docs.name;
     (0, fs_1.ensureDirSync)(outdir);
     (0, node_fs_1.writeFileSync)((0, node_path_1.join)(outdir, outname + '.md'), md.h1(docs.name, ...[
+        [md.bold('Usage:'), md.code(docs.usage)].join(' '),
         docs.description,
         getPositionalArgsFragment(docs.positionals, md),
         getFlagArgsFragment(docs.options, md),
-        getSubcommandsFragment(docs.subcommands, md),
+        getSubcommandsFragment(docs.subcommands, outdir, docsRoot, md),
+        getExamplesFragment(docs.examples, md),
     ].filter(isTruthy)));
     for (const subcommand of docs.subcommands) {
-        await generateMarkdownForSingleCommand(subcommand, (0, node_path_1.join)(outdir, subcommand.name), md);
+        await generateMarkdownForSingleCommand(subcommand, (0, node_path_1.join)(outdir, subcommand.name), docsRoot, md);
     }
 }
 function formatOption(option, md) {
-    return md.h3(option.key, ...[
+    return md.h3(option.deprecated ? md.strikethrough(option.key) : option.key, ...[
+        option.deprecated ? md.bold(md.italics('Deprecated')) : undefined,
         md.bold('Type:') +
             ' ' +
             (option.type === 'array'
@@ -85,7 +89,18 @@ function formatOption(option, md) {
                 : option.type),
         option.description,
         option.default ? md.bold('Default:') + ' ' + option.default : undefined,
-        option.required ? md.bold('Required') : undefined,
+        // No need to show required if it's required and has a default, as its not actually required to pass.
+        option.required && !option.default ? md.bold('Required') : undefined,
+        option.choices
+            ? md.bold('Valid values:') +
+                ' ' +
+                (() => {
+                    const choicesAsString = (typeof option.choices === 'function'
+                        ? option.choices()
+                        : option.choices).map((t) => t.toString());
+                    return choicesAsString.join(', ');
+                })()
+            : undefined,
         option.alias?.length
             ? md.h4('Aliases', md.ul(...option.alias))
             : undefined,
@@ -103,11 +118,12 @@ function getFlagArgsFragment(options, md) {
     }
     return md.h2('Flags', ...Object.values(options).map((option) => formatOption(option, md)));
 }
-function getSubcommandsFragment(subcommands, md) {
+function getSubcommandsFragment(subcommands, outdir, docsRoot, md) {
     if (subcommands.length === 0) {
         return undefined;
     }
-    return md.h2('Subcommands', ...subcommands.map((subcommand) => md.link(`./${subcommand.name}`, subcommand.name)));
+    return md.h2('Subcommands', ...subcommands.map((subcommand) => md.link('./' +
+        (0, posix_1.join)((0, posix_1.normalize)((0, node_path_1.relative)(docsRoot, outdir)), subcommand.name + '.md'), subcommand.name)));
 }
 function isTruthy(value) {
     return !!value;
@@ -120,4 +136,92 @@ async function importMarkdownFactory() {
         throw new Error('Could not find markdown-factory. Please install it to generate markdown documentation.');
     }
 }
+function isCLI(obj) {
+    if (obj instanceof cli_forge_1.InternalCLI) {
+        return true;
+    }
+    if (typeof obj !== 'object' || !obj) {
+        return false;
+    }
+    if (!('constructor' in obj)) {
+        return false;
+    }
+    if (!('name' in obj.constructor)) {
+        return false;
+    }
+    return obj.constructor.name === cli_forge_1.InternalCLI.name;
+}
+function getExamplesFragment(examples, md) {
+    if (examples.length === 0) {
+        return undefined;
+    }
+    return md.h2('Examples', ...examples.map((example) => md.codeBlock(example, 'shell')));
+}
+/**
+ * Reads the CLI instance from the provided module. For some reason,
+ * when importing a module that uses `export default` in typescript
+ * the default export is nested under a `default` property on the module...
+ * We for code that looks like `export default 5`, on import we get back
+ * `{ default: {default: 5}}`. To work around this, and make things work
+ * we try to read the CLI instance from the module in a few different ways.
+ *
+ * @param cliModule The imported module
+ * @param exportSpecifier The name of the export to read the CLI from. Defaults to `default`.
+ * @returns A CLI instance.
+ */
+function readCLIFromModule(cliModule, args) {
+    let cli = cliModule;
+    if (args.export) {
+        cli = cliModule[args.export] ?? cliModule['default']?.[args.export];
+    }
+    else {
+        cli =
+            cliModule['default']?.['default'] ?? cliModule['default'] ?? cliModule;
+    }
+    if (!isCLI(cli)) {
+        throw new Error(`${args.cli}${args.export ? '#' + args.export : ''} is not a CLI.`);
+    }
+    return cli;
+}
+async function loadCLIModule(args) {
+    if (!(0, node_path_1.isAbsolute)(args.cli)) {
+        args.cli = (0, node_path_1.join)(process.cwd(), args.cli);
+    }
+    const cliPath = [
+        args.cli,
+        `${args.cli}.ts`,
+        `${args.cli}.js`,
+        `${args.cli}.cjs`,
+        `${args.cli}.mjs`,
+        (0, node_path_1.join)(args.cli, 'index.ts'),
+        (0, node_path_1.join)(args.cli, 'index.js'),
+        (0, node_path_1.join)(args.cli, 'index.cjs'),
+        (0, node_path_1.join)(args.cli, 'index.mjs'),
+    ].find((f) => (0, node_fs_1.existsSync)(f));
+    if (!cliPath) {
+        throw new Error(`Could not find CLI module at ${args.cli}
+      
+      Ensure that the path is correct and that the CLI module exists.`);
+    }
+    try {
+        const tsx = (await Promise.resolve().then(() => require(
+        //@ts-ignore
+        'tsx/esm/api')));
+        return tsx.tsImport(cliPath, {
+            tsconfig: args.tsconfig,
+            parentURL: (0, node_url_1.pathToFileURL)(__dirname).toString(),
+        });
+    }
+    catch {
+        try {
+            return await Promise.resolve(`${cliPath}`).then(s => require(s));
+        }
+        catch (e) {
+            if (cliPath.endsWith('.ts')) {
+                console.warn('[cli-forge]: Generating docs for a typescript CLI requires installing `tsx` as a dev dependency, targeting the build artifacts instead, or otherwise registering a typescript loader with node.');
+            }
+            throw e;
+        }
+    }
+}
 //# sourceMappingURL=generate-documentation.js.map

package/bin/commands/generate-documentation.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate-documentation.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/bin/commands/generate-documentation.ts"],"names":[],"mappings":";;;AAsBA,sEA0BC;AA9CD,qCAAwC;AACxC,yCAA0C;AAE1C,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,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;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,EAAE,CAAC;YAC9B,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,CAAC,GAAG,YAAY,uBAAW,CAAC,EAAE,CAAC;YAClC,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,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"}
+{"version":3,"file":"generate-documentation.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/bin/commands/generate-documentation.ts"],"names":[],"mappings":";;;AAwBA,sEA+BC;AArDD,qCAAoD;AACpD,yCAAgE;AAChE,2CAAuE;AAEvE,mCAA4B;AAC5B,+DAGqC;AACrC,uDAA2D;AAC3D,oCAA4C;AAC5C,uCAAyC;AAWzC,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;SACD,MAAM,CAAC,UAAU,EAAE;QAClB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,mEAAmE;KACtE,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,MAAM,SAAS,GAAG,MAAM,aAAa,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,GAAG,GAAG,iBAAiB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAE7C,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;AAED;;;;;;;;;;;GAWG;AACH,SAAS,iBAAiB,CACxB,SAAc,EACd,IAAsB;IAEtB,IAAI,GAAG,GAAG,SAAS,CAAC;IACpB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACtE,CAAC;SAAM,CAAC;QACN,GAAG;YACD,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC;IAC3E,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QAChB,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;IACJ,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,KAAK,UAAU,aAAa,CAC1B,IAEkE;IAElE,IAAI,CAAC,IAAA,sBAAU,EAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,IAAI,CAAC,GAAG,GAAG,IAAA,gBAAI,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3C,CAAC;IACD,MAAM,OAAO,GAAG;QACd,IAAI,CAAC,GAAG;QACR,GAAG,IAAI,CAAC,GAAG,KAAK;QAChB,GAAG,IAAI,CAAC,GAAG,KAAK;QAChB,GAAG,IAAI,CAAC,GAAG,MAAM;QACjB,GAAG,IAAI,CAAC,GAAG,MAAM;QACjB,IAAA,gBAAI,EAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC;QAC1B,IAAA,gBAAI,EAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC;QAC1B,IAAA,gBAAI,EAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC;QAC3B,IAAA,gBAAI,EAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC;KAC5B,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,oBAAU,EAAC,CAAC,CAAC,CAAC,CAAC;IAE7B,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,gCAAgC,IAAI,CAAC,GAAG;;sEAEU,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,CAAC;QACX,YAAY;QACZ,aAAa,EACd,CAAgD,CAAC;QAClD,OAAO,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE;YAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,SAAS,EAAE,IAAA,wBAAa,EAAC,SAAS,CAAC,CAAC,QAAQ,EAAE;SAC/C,CAAC,CAAC;IACL,CAAC;IAAC,MAAM,CAAC;QACP,IAAI,CAAC;YACH,OAAO,yBAAa,OAAO,yBAAC,CAAC;QAC/B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5B,OAAO,CAAC,IAAI,CACV,iMAAiM,CAClM,CAAC;YACJ,CAAC;YACD,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;AACH,CAAC"}

package/bin/commands/init.d.ts

@@ -6,6 +6,8 @@ export declare function withInitArgs<T extends ParsedArgs>(cmd: CLI<T>): CLI<T &
     output: string;
 } & {
     format: string;
+} & {
+    initialVersion: string;
 }>;
 export declare const initCommand: CLI<{
     unmatched: string[];
@@ -16,4 +18,6 @@ export declare const initCommand: CLI<{
     output: string;
 } & {
     format: string;
+} & {
+    initialVersion: string;
 }>;

package/bin/commands/init.js

@@ -5,10 +5,22 @@ exports.withInitArgs = withInitArgs;
 const node_child_process_1 = require("node:child_process");
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
-const package_json_1 = require("../../package.json");
+const CLI_FORGE_PACKAGE_JSON = require("../../package.json");
 const src_1 = require("../../src");
 // import { CLI } from '../../src/lib/cli-forge';
 const fs_1 = require("../utils/fs");
+const CLI_FORGE_VERSION = CLI_FORGE_PACKAGE_JSON.version;
+const DEV_PEER_DEPS = Object.entries(CLI_FORGE_PACKAGE_JSON.peerDependencies).reduce((acc, [dep, version]) => {
+    if (
+    // The dev prop doesn't actually do anything for npm/pnpm/yarn,
+    // but we are using it to mark when a peer dep is only used at dev time.
+    // In these cases, we can safely add them to the devDependencies of the
+    // generated CLI.
+    CLI_FORGE_PACKAGE_JSON.peerDependenciesMeta[dep]?.dev) {
+        acc[dep] = version;
+    }
+    return acc;
+}, {});
 function withInitArgs(cmd) {
     return cmd
         .positional('cliName', {
@@ -24,7 +36,13 @@ function withInitArgs(cmd) {
         .option('format', {
         type: 'string',
         default: 'ts',
-        description: 'What format should the CLI be in? (js, ts)',
+        description: 'What format should the CLI be in?',
+        choices: ['js', 'ts'],
+    })
+        .option('initialVersion', {
+        type: 'string',
+        default: '0.0.1',
+        description: 'Initial version used when creating the package.json for the new CLI.',
     });
 }
 exports.initCommand = (0, src_1.default)('init', {
@@ -35,11 +53,22 @@ exports.initCommand = (0, src_1.default)('init', {
         (0, fs_1.ensureDirSync)(args.output);
         const packageJsonPath = (0, node_path_1.join)(args.output, 'package.json');
         const cliPath = (0, node_path_1.join)(args.output, 'bin', `${args.cliName}.${args.format}`);
-        const packageJsonContent = readJsonOr(packageJsonPath, { name: args.cliName });
+        const packageJsonContent = readJsonOr(packageJsonPath, {
+            name: args.cliName,
+            version: args.initialVersion,
+        });
         packageJsonContent.bin ??= {};
         packageJsonContent.bin[args.cliName] = (0, node_path_1.relative)(args.output, cliPath);
         packageJsonContent.dependencies ??= {};
-        packageJsonContent.dependencies['cli-forge'] ??= package_json_1.version;
+        packageJsonContent.dependencies['cli-forge'] ??= CLI_FORGE_VERSION;
+        if (args.format === 'ts') {
+            const latestTypescriptVersion = (0, node_child_process_1.execSync)('npm show typescript version').toString();
+            packageJsonContent.devDependencies = {
+                typescript: latestTypescriptVersion,
+                ...DEV_PEER_DEPS,
+                ...packageJsonContent.devDependencies,
+            };
+        }
         (0, node_fs_1.writeFileSync)(packageJsonPath, JSON.stringify(packageJsonContent, null, 2));
         (0, fs_1.ensureDirSync)((0, node_path_1.dirname)(cliPath));
         (0, node_fs_1.writeFileSync)(cliPath, args.format === 'ts'

package/bin/commands/init.js.map

@@ -1 +1 @@
-{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/bin/commands/init.ts"],"names":[],"mappings":";;;AAWA,oCAiBC;AA1BD,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,4CAA4C;KAC1D,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"}
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/bin/commands/init.ts"],"names":[],"mappings":";;;AA6BA,oCAwBC;AAnDD,2DAA8C;AAC9C,qCAAkE;AAClE,yCAAoD;AAEpD,6DAA6D;AAC7D,mCAAqC;AACrC,iDAAiD;AACjD,oCAA4C;AAE5C,MAAM,iBAAiB,GAAG,sBAAsB,CAAC,OAAO,CAAC;AACzD,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAClC,sBAAsB,CAAC,gBAAgB,CACxC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,EAAE;IAC/B;IACE,+DAA+D;IAC/D,wEAAwE;IACxE,uEAAuE;IACvE,iBAAiB;IACjB,sBAAsB,CAAC,oBAAoB,CACzC,GAA+D,CAChE,EAAE,GAAG,EACN,CAAC;QACD,GAAG,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC;IACrB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC,EAAE,EAA4B,CAAC,CAAC;AAEjC,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;SACD,MAAM,CAAC,gBAAgB,EAAE;QACxB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,OAAO;QAChB,WAAW,EACT,sEAAsE;KACzE,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,GAOpB,UAAU,CAAC,eAAe,EAAE;YAC9B,IAAI,EAAE,IAAI,CAAC,OAAO;YAClB,OAAO,EAAE,IAAI,CAAC,cAAc;SAC7B,CAAC,CAAC;QACH,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,iBAAiB,CAAC;QACnE,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YACzB,MAAM,uBAAuB,GAAG,IAAA,6BAAQ,EACtC,6BAA6B,CAC9B,CAAC,QAAQ,EAAE,CAAC;YACb,kBAAkB,CAAC,eAAe,GAAG;gBACnC,UAAU,EAAE,uBAAuB;gBACnC,GAAG,aAAa;gBAChB,GAAG,kBAAkB,CAAC,eAAe;aACtC,CAAC;QACJ,CAAC;QACD,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

@@ -1,16 +1,22 @@
 {
   "name": "cli-forge",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "dependencies": {
     "tslib": "^2.3.0",
-    "@cli-forge/parser": "0.4.0"
+    "@cli-forge/parser": "0.6.0"
   },
   "peerDependencies": {
-    "markdown-factory": "0.2.0"
+    "markdown-factory": "0.2.0",
+    "tsx": "4.19.0"
   },
   "peerDependenciesMeta": {
     "markdown-factory": {
-      "optional": true
+      "optional": true,
+      "dev": true
+    },
+    "tsx": {
+      "optional": true,
+      "dev": true
     }
   },
   "type": "commonjs",

package/src/index.d.ts

@@ -1 +1,2 @@
 export { default, cli, CLI, Command } from './lib/cli-forge';
+export { TestHarness } from './lib/test-harness';

package/src/index.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cli = exports.default = void 0;
+exports.TestHarness = exports.cli = exports.default = void 0;
 var cli_forge_1 = require("./lib/cli-forge");
 Object.defineProperty(exports, "default", { enumerable: true, get: function () { return cli_forge_1.default; } });
 Object.defineProperty(exports, "cli", { enumerable: true, get: function () { return cli_forge_1.cli; } });
+var test_harness_1 = require("./lib/test-harness");
+Object.defineProperty(exports, "TestHarness", { enumerable: true, get: function () { return test_harness_1.TestHarness; } });
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -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"}
+{"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

@@ -5,11 +5,45 @@ export interface CLIHandlerContext {
 export type CLICommandOptions<TInitial extends ParsedArgs, TArgs extends TInitial = TInitial> = {
     description?: string;
     builder?: (parser: CLI<TInitial>) => CLI<TArgs>;
-    handler: (args: TArgs, context: CLIHandlerContext) => void | Promise<void>;
+    handler?: (args: TArgs, context: CLIHandlerContext) => void | Promise<void>;
+    usage?: string;
+    examples?: string[];
 };
 export type Command<TInitial extends ParsedArgs = any, TArgs extends TInitial = TInitial> = ({
     name: string;
 } & CLICommandOptions<TInitial, TArgs>) | CLI<TArgs>;
+/**
+ * Error Handler for CLI applications. Error handlers should re-throw the error if they cannot handle it.
+ *
+ * @param e The error that was thrown.
+ * @param actions Actions that can be taken by the error handler. Prefer using these over process.exit for better support of interactive shells.
+ */
+export type ErrorHandler = (e: unknown, actions: {
+    /**
+     * Exits the process immediately.
+     * @param code
+     */
+    exit: (code?: number) => void;
+}) => void;
+/**
+ * The interface for a CLI application or subcommands.
+ *
+ * {@link cli} is provided as a small helper function to create a new CLI instance.
+ *
+ * @example
+ * ```ts
+ * import { cli } from 'cli-forge';
+ *
+ * cli('basic-cli').command('hello', {
+ *   builder: (args) =>
+ *    args.option('name', {
+ *      type: 'string',
+ *    }),
+ *   handler: (args) => {
+ *     console.log(`Hello, ${args.name}!`);
+ *   }).forge();
+ * ```
+ */
 export interface CLI<TArgs extends ParsedArgs = ParsedArgs> {
     command<TCommandArgs extends TArgs>(cmd: Command<TArgs, TCommandArgs>): CLI<TArgs>;
     /**
@@ -29,6 +63,21 @@ export interface CLI<TArgs extends ParsedArgs = ParsedArgs> {
      * @param commands Several commands to register. Can be the result of a call to {@link cli} or a configuration object.
      */
     commands(...commands: Command[]): CLI<TArgs>;
+    /**
+     * Enables the ability to run CLI commands that contain subcommands as an interactive shell.
+     * This presents as a small shell that only knows the current command and its subcommands.
+     * Any flags already consumed by the command will be passed to every subcommand invocation.
+     */
+    enableInteractiveShell(): CLI<TArgs>;
+    /**
+     * Registers a custom global error handler for the CLI. This handler will be called when an error is thrown
+     * during the execution of the CLI and not otherwise handled. Error handlers should re-throw the error if they
+     * cannot handle it, s.t. the next error handler can attempt to handle it.
+     *
+     * @param handler Typically called with an Error object, but you should be prepared to handle any type of error.
+     * @param actions Actions that can be taken by the error handler. Prefer using these over process.exit for better support of interactive shells.
+     */
+    errorHandler(handler: ErrorHandler): CLI<TArgs>;
     /**
      * Registers a new option for the CLI command. This option will be accessible
      * within the command handler, as well as any subcommands.
@@ -60,12 +109,44 @@ export interface CLI<TArgs extends ParsedArgs = ParsedArgs> {
             array: (TOptionConfig extends ArrayOptionConfig<string | number> ? TOptionConfig['items'] extends 'string' ? string : number : never)[];
         }[TOptionConfig['type']];
     }>;
+    /**
+     * Adds support for reading CLI options from environment variables.
+     * @param prefix The prefix to use when looking up environment variables. Defaults to the command name.
+     */
+    env(prefix?: string): CLI<TArgs>;
+    /**
+     * Sets a group of options as mutually exclusive. If more than one option is provided, there will be a validation error.
+     * @param options The options that should be mutually exclusive.
+     */
+    conflicts(...options: [string, string, ...string[]]): CLI<TArgs>;
+    /**
+     * Sets a group of options as mutually inclusive. If one option is provided, all other options must also be provided.
+     * @param option The option that implies the other options.
+     * @param impliedOptions The options which become required when the option is provided.
+     */
+    implies(option: string, ...impliedOptions: string[]): CLI<TArgs>;
     /**
      * Requires a command to be provided when executing the CLI. Useful if your parent command
      * cannot be executed on its own.
      * @returns Updated CLI instance.
      */
     demandCommand(): CLI<TArgs>;
+    /**
+     * Sets the usage text for the CLI. This text will be displayed in place of the default usage text
+     * @param usageText Text displayed in place of the default usage text for `--help` and in generated docs.
+     */
+    usage(usageText: string): CLI<TArgs>;
+    /**
+     * Sets the description for the CLI. This text will be displayed in the help text and generated docs.
+     * @param examples Examples to display in the help text and generated docs.
+     */
+    examples(...examples: string[]): CLI<TArgs>;
+    /**
+     * Allows overriding the version displayed when passing `--version`. Defaults to crawling
+     * the file system to get the package.json of the currently executing command.
+     * @param override
+     */
+    version(override?: string): CLI<TArgs>;
     /**
      * Prints help text to stdout.
      */
@@ -75,7 +156,7 @@ export interface CLI<TArgs extends ParsedArgs = ParsedArgs> {
      * @param args argv. Defaults to process.argv.slice(2)
      * @returns Promise that resolves when the handler completes.
      */
-    forge(args?: string[]): Promise<void>;
+    forge(args?: string[]): Promise<TArgs>;
 }
 /**
  * The base class for a CLI application. This class is used to define the structure of the CLI.
@@ -98,26 +179,40 @@ export interface CLI<TArgs extends ParsedArgs = ParsedArgs> {
  */
 export declare class InternalCLI<TArgs extends ParsedArgs = ParsedArgs> implements CLI<TArgs> {
     name: string;
-    private registeredCommands;
-    private commandChain;
+    /**
+     * For internal use only. Stick to properties available on {@link CLI}.
+     */
+    registeredCommands: Record<string, InternalCLI<any>>;
+    /**
+     * For internal use only. Stick to properties available on {@link CLI}.
+     */
+    commandChain: string[];
     private requiresCommand;
     private _configuration?;
+    private _versionOverride?;
+    private registeredErrorHandlers;
+    get configuration(): CLICommandOptions<any, any> | undefined;
+    private set configuration(value);
     private parser;
     /**
      * @param name What should the name of the cli command be?
      * @param configuration Configuration for the current CLI command.
      */
-    constructor(name: string);
-    get configuration(): CLICommandOptions<any, any> | undefined;
-    private set configuration(value);
+    constructor(name: string, rootCommandConfiguration?: CLICommandOptions<TArgs>);
     withRootCommandConfiguration<TRootCommandArgs extends TArgs>(configuration: CLICommandOptions<TArgs, TRootCommandArgs>): InternalCLI<TArgs>;
     command<TCommandArgs extends TArgs>(cmd: Command<TArgs, TCommandArgs>): CLI<TArgs>;
     command<TCommandArgs extends TArgs>(key: string, options: CLICommandOptions<TArgs, TCommandArgs>): CLI<TArgs>;
-    commands(commands: Command[]): typeof this;
-    commands(...commands: Command[]): typeof this;
+    commands(commands: Command[]): CLI<TArgs>;
+    commands(...commands: Command[]): CLI<TArgs>;
     option<TOption extends string, TOptionConfig extends OptionConfig>(name: TOption, config: TOptionConfig): any;
     positional<TOption extends string, TOptionConfig extends OptionConfig>(name: TOption, config: TOptionConfig): any;
+    conflicts(...args: [string, string, ...string[]]): CLI<TArgs>;
+    implies(option: string, ...impliedOptions: string[]): CLI<TArgs>;
+    env(prefix?: string): this;
     demandCommand(): this;
+    usage(usageText: string): this;
+    examples(...examples: string[]): this;
+    version(version?: string): this;
     /**
      * Gets help text for the current command as a string.
      * @returns Help text for the current command.
@@ -132,15 +227,21 @@ export declare class InternalCLI<TArgs extends ParsedArgs = ParsedArgs> implemen
      * @param cmd The command to run.
      * @param args The arguments to pass to the command.
      */
-    runCommand<T extends ParsedArgs>(cmd: InternalCLI<T>, args: T): Promise<void>;
+    runCommand<T extends ParsedArgs>(cmd: InternalCLI<T>, args: T, originalArgV: string[]): Promise<void>;
+    enableInteractiveShell(): this;
+    private versionHandler;
+    private withErrorHandlers;
+    errorHandler(handler: ErrorHandler): this;
     /**
      * Parses argv and executes the CLI
      * @param args argv. Defaults to process.argv.slice(2)
      * @returns Promise that resolves when the handler completes.
      */
-    forge(args?: string[]): Promise<void>;
+    forge: (args?: string[]) => Promise<Awaited<TArgs>>;
     getParser(): import("@cli-forge/parser").ReadonlyArgvParser<TArgs & {
         help: boolean;
+    } & {
+        version: boolean;
     }>;
     getSubcommands(): Readonly<Record<string, InternalCLI>>;
     clone(): InternalCLI<TArgs>;