@cloud-copilot/cli 0.1.1

package/dist/cjs/utils.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Optionally print a message and exit the process with the given exit code.
+ *
+ * @param exitCode the exit code to use
+ * @param message the message to print
+ */
+export declare function exit(exitCode: number, message: string | undefined): void;
+//# sourceMappingURL=utils.d.ts.map

package/dist/cjs/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,QASjE"}

package/dist/cjs/utils.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exit = exit;
+/**
+ * Optionally print a message and exit the process with the given exit code.
+ *
+ * @param exitCode the exit code to use
+ * @param message the message to print
+ */
+function exit(exitCode, message) {
+    if (message) {
+        if (exitCode === 0) {
+            console.log(message);
+        }
+        else {
+            console.error(message);
+        }
+    }
+    process.exit(exitCode);
+}
+//# sourceMappingURL=utils.js.map

package/dist/cjs/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;AAMA,oBASC;AAfD;;;;;GAKG;AACH,SAAgB,IAAI,CAAC,QAAgB,EAAE,OAA2B;IAChE,IAAI,OAAO,EAAE,CAAC;QACZ,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;YACnB,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QACtB,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACxB,CAAC;IACH,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;AACxB,CAAC"}

package/dist/esm/cli.d.ts

@@ -0,0 +1,140 @@
+/**
+ * A boolean argument that has no values.
+ */
+export type BooleanArgument = {
+    /**
+     * The single character flag for the argument.
+     */
+    character: string;
+    /**
+     * Must be 'none' for a boolean argument.
+     */
+    values: 'none';
+    /**
+     * The description of the argument.
+     */
+    description: string;
+};
+/**
+ * A standard argument that has one or more values.
+ */
+export type StandardArgument = {
+    /**
+     * Whether the argument accepts single or multiple values.
+     */
+    values: 'single' | 'multiple';
+    /**
+     * The type of the values accepted.
+     */
+    type: 'string' | 'number';
+    /**
+     * The description of the argument.
+     */
+    description: string;
+};
+export type EnumArgument = {
+    /**
+     * Whether the argument accepts single or multiple values.
+     */
+    values: 'single' | 'multiple';
+    /**
+     * Must be 'enum' for an enum argument.
+     */
+    type: 'enum';
+    /**
+     * The valid values for the argument.
+     */
+    validValues: string[];
+    /**
+     * The description of the argument.
+     */
+    description: string;
+};
+/**
+ * A CLI argument that can be accepted for a command.
+ */
+export type CliArgument = BooleanArgument | StandardArgument | EnumArgument;
+export type Command = {
+    description: string;
+    options: Record<string, CliArgument>;
+};
+export type OptionConfig = {
+    type: 'string' | 'number' | 'boolean';
+    values: 'single' | 'multiple';
+    description: string;
+    character?: string;
+};
+/**
+ * A map of CLI argument keys to their configuration.
+ */
+export type Config<T extends Record<string, CliArgument>> = T;
+/**
+ * Create a type safe configuration for CLI arguments.
+ *
+ * @param config the configuration for the CLI arguments.
+ * @returns the configuration object.
+ */
+export declare function createConfig<T extends Record<string, CliArgument>>(config: T): T;
+type ParsedArgs<T extends Record<string, CliArgument>> = {
+    [K in keyof T as K]: T[K] extends {
+        type: 'string';
+    } ? T[K]['values'] extends 'single' ? string | undefined : string[] : T[K] extends {
+        type: 'number';
+    } ? T[K]['values'] extends 'single' ? number | undefined : number[] : T[K] extends {
+        type: 'boolean';
+    } ? boolean : never;
+};
+/**
+ * Additional arguments that can be used to configure the CLI parser.
+ */
+export interface AdditionalCliArguments {
+    /**
+     * The version of the CLI command. If provided, the CLI provides a --version flag that prints the version and exits.
+     */
+    version?: string;
+    /**
+     * The argument string from the CLI. If not provided, the process.argv.slice(2) is used.
+     */
+    args?: string[];
+    /**
+     * The environment variables to use for parsing. If not provided, process.env is used.
+     */
+    env?: Record<string, string>;
+    /**
+     * The prefix to use for environment variables. If provided, the CLI will look for environment variables with the prefix followed by an underscore.
+     */
+    envPrefix?: string;
+    /**
+     * The name of the operands to display in the help message. Defaults to "operands".
+     */
+    operandsName?: string;
+    /**
+     * Whether a subcommand is required. If true, the CLI will exit with an error if no subcommand is provided.
+     */
+    requireSubcommand?: boolean;
+    /**
+     * If there are zero arguments, show the help message. Defaults to false.
+     */
+    showHelpIfNoArgs?: boolean;
+}
+export type SelectedCommandWithArgs<C extends Record<string, Command>, O extends Record<string, CliArgument>> = {
+    [K in keyof C]: {
+        command: K | undefined;
+        args: ParsedArgs<C[K]['options']> & ParsedArgs<O>;
+        operands: string[];
+        anyValues: boolean;
+    };
+}[keyof C];
+/**
+ * Parse CLI Arguments and return the parsed typesafe results.
+ *
+ * @param command the name of the command arguments are being parsed for.
+ * @param subcommands the list of subcommands that can be used, if any.
+ * @param cliOptions the configuration options for the CLI command.
+ * @param additionalArgs additional arguments to be used for parsing and displaying help.
+ * @returns the parsed arguments, operands, and subcommand if applicable.
+ */
+export declare function parseCliArguments<O extends Record<string, CliArgument>, C extends Record<string, Command>>(command: string, subcommands: C, cliOptions: Config<O>, additionalArgs?: AdditionalCliArguments): SelectedCommandWithArgs<C, O>;
+export declare function printHelpContents<O extends Record<string, CliArgument>, C extends Record<string, Command>>(command: string, subcommands: C, cliOptions: O, additionalArgs?: AdditionalCliArguments, selectedSubcommand?: string | undefined): void;
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/esm/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAA;IAE7B;;OAEG;IACH,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAA;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAA;IAE7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,EAAE,MAAM,EAAE,CAAA;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG,gBAAgB,GAAG,YAAY,CAAA;AAE3E,MAAM,MAAM,OAAO,GAAG;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;CACrC,CAAA;AAUD,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAA;IACrC,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAA;IAC7B,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,CAAA;AAE7D;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAEhF;AAED,KAAK,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI;KACtD,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;QAChC,IAAI,EAAE,QAAQ,CAAA;KACf,GACG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,QAAQ,GAC7B,MAAM,GAAG,SAAS,GAClB,MAAM,EAAE,GACV,CAAC,CAAC,CAAC,CAAC,SAAS;QACT,IAAI,EAAE,QAAQ,CAAA;KACf,GACD,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,QAAQ,GAC7B,MAAM,GAAG,SAAS,GAClB,MAAM,EAAE,GACV,CAAC,CAAC,CAAC,CAAC,SAAS;QACT,IAAI,EAAE,SAAS,CAAA;KAChB,GACD,OAAO,GACP,KAAK;CACd,CAAA;AASD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B;AAED,MAAM,MAAM,uBAAuB,CACjC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IACnC;KACD,CAAC,IAAI,MAAM,CAAC,GAAG;QACd,OAAO,EAAE,CAAC,GAAG,SAAS,CAAA;QACtB,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAA;QACjD,QAAQ,EAAE,MAAM,EAAE,CAAA;QAClB,SAAS,EAAE,OAAO,CAAA;KACnB;CACF,CAAC,MAAM,CAAC,CAAC,CAAA;AAEV;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACrC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEjC,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,CAAC,EACd,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,EACrB,cAAc,CAAC,EAAE,sBAAsB,GACtC,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,CAiT/B;AA+MD,wBAAgB,iBAAiB,CAC/B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACrC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEjC,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,CAAC,EACd,UAAU,EAAE,CAAC,EACb,cAAc,CAAC,EAAE,sBAAsB,EACvC,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,GACtC,IAAI,CAoDN"}