@stacksjs/cli 0.51.0 → 0.52.0

package/README.md

@@ -68,7 +68,7 @@ command.parse() // parse the command
 You may now run the command via:
 
 ```bash
-esno command.ts
+tsx command.ts
 ```
 
 To view a more detailed example, check out [Buddy](../../buddy/).
@@ -98,7 +98,7 @@ pnpm test
 
 Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
 
-## 💪🏼 Contributing
+## 🚜 Contributing
 
 Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
 

package/dist/index.d.ts

@@ -1,8 +1,117 @@
-export * from './actions';
-export * from './command';
-export * from './console';
-export * from './helpers';
-export * from './run';
-export * from './spinner';
-export * from './utilities';
+import * as _stacksjs_types from '@stacksjs/types';
+import { CommandReturnValue, IntroOptions, OutroOptions, CliOptions, ResultAsync, CommandResult } from '@stacksjs/types';
 export { ExitCode } from '@stacksjs/types';
+export { cac as command } from 'cac';
+export { execaCommand as spawn } from 'execa';
+import ora from 'ora';
+export { ansi256Bg, bgBlack, bgBlue, bgCyan, bgGray, bgGreen, bgLightBlue, bgLightCyan, bgLightGray, bgLightGreen, bgLightMagenta, bgLightRed, bgLightYellow, bgMagenta, bgRed, bgWhite, bgYellow, black, blue, bold, cyan, dim, gray, green, hidden, inverse, italic, lightBlue, lightCyan, lightGray, lightGreen, lightMagenta, lightRed, lightYellow, link, magenta, red, reset, strikethrough, underline, white, yellow } from 'kolorist';
+export { log } from '@stacksjs/logging';
+
+/**
+ * Install an npm package.
+ *
+ * @param pkg - The package name to install.
+ * @returns The result of the install.
+ */
+declare function installPackage(pkg: string): Promise<CommandReturnValue>;
+/**
+ * Install a Stack into your project.
+ *
+ * @param pkg - The Stack name to install.
+ * @returns The result of the install.
+ */
+declare function installStack(name: string): Promise<CommandReturnValue>;
+
+declare const prompt: <T extends {
+    type?: "text" | undefined;
+    default?: string | undefined;
+    placeholder?: string | undefined;
+    initial?: string | undefined;
+} | {
+    type: "confirm";
+    initial?: boolean | undefined;
+} | {
+    type: "select";
+    initial?: string | undefined;
+    options: (string | {
+        label: string;
+        value: string;
+        hint?: string | undefined;
+    })[];
+} | {
+    type: "multiselect";
+    initial?: string | undefined;
+    options: string[] | {
+        label: string;
+        value: string;
+        hint?: string | undefined;
+    }[];
+    required?: boolean | undefined;
+}>(message: string, opts?: T | undefined) => Promise<T extends {
+    type?: "text" | undefined;
+    default?: string | undefined;
+    placeholder?: string | undefined;
+    initial?: string | undefined;
+} ? string : T extends {
+    type: "confirm";
+    initial?: boolean | undefined;
+} ? boolean : string[]>;
+
+/**
+ * Prints the intro message.
+ */
+declare function intro(command: string, options?: IntroOptions): Promise<number | undefined>;
+/**
+ * Prints the outro message.
+ */
+declare function outro(text: string, options: OutroOptions, error?: Error | string): void;
+declare function startSpinner(text?: string): _stacksjs_types.SpinnerOptions;
+
+interface ParsedArgv {
+    args: ReadonlyArray<string>;
+    options: {
+        [k: string]: string | boolean | number;
+    };
+}
+declare function parseArgv(argv?: ReadonlyArray<string>): ParsedArgv;
+declare function parseOptions(argv?: ReadonlyArray<string>): {
+    [k: string]: string | boolean | number;
+};
+declare function parseArgs(argv?: ReadonlyArray<string>): ReadonlyArray<string>;
+
+/**
+ * Execute a command.
+ *
+ * @param command The command to execute.
+ * @param options The options to pass to the command.
+ * @param errorMsg The name of the error to throw if the command fails.
+ * @returns The result of the command.
+ */
+declare function exec(command: string, options?: CliOptions): ResultAsync<CommandReturnValue, Error>;
+/**
+ * Execute a command and return result.
+ *
+ * @param command The command to execute.
+ * @returns The result of the command.
+ */
+declare function execSync(command: string): string;
+/**
+ * Run a command the Stacks way.
+ *
+ * @param command The command to run.
+ * @param options The options to pass to the command.
+ * @returns The result of the command.
+ */
+declare function runCommand(command: string, options?: CliOptions): Promise<ResultAsync<CommandReturnValue, Error>>;
+/**
+ * Run many commands—the Stacks way.
+ *
+ * @param commands The command to run.
+ * @param options The options to pass to the command.
+ * @returns The result of the command.
+ */
+declare function runCommands(commands: string[], options?: CliOptions): Promise<CommandResult | CommandResult[]>;
+
+declare const spinner: typeof ora;
+
+export { exec, execSync, installPackage, installStack, intro, outro, parseArgs, parseArgv, parseOptions, prompt, runCommand, runCommands, spinner, startSpinner };

package/dist/index.mjs

@@ -1,8 +1,193 @@
-export * from "./actions/index.mjs";
-export * from "./command.mjs";
-export * from "./console.mjs";
-export * from "./helpers.mjs";
-export * from "./run.mjs";
-export * from "./spinner.mjs";
-export * from "./utilities.mjs";
-export { ExitCode } from "@stacksjs/types";
+import { installPackage as installPackage$1 } from '@antfu/install-pkg';
+export { cac as command } from 'cac';
+import { execaCommand } from 'execa';
+export { execaCommand as spawn } from 'execa';
+import { log } from '@stacksjs/logging';
+export { log } from '@stacksjs/logging';
+import { frameworkVersion, determineDebugLevel } from '@stacksjs/utils';
+import ora from 'ora';
+import { cyan, bold, dim, bgCyan, italic, red, green } from 'kolorist';
+export { ansi256Bg, bgBlack, bgBlue, bgCyan, bgGray, bgGreen, bgLightBlue, bgLightCyan, bgLightGray, bgLightGreen, bgLightMagenta, bgLightRed, bgLightYellow, bgMagenta, bgRed, bgWhite, bgYellow, black, blue, bold, cyan, dim, gray, green, hidden, inverse, italic, lightBlue, lightCyan, lightGray, lightGreen, lightMagenta, lightRed, lightYellow, link, magenta, red, reset, strikethrough, underline, white, yellow } from 'kolorist';
+import { execSync as execSync$1 } from 'node:child_process';
+import { ExitCode } from '@stacksjs/types';
+export { ExitCode } from '@stacksjs/types';
+import { projectPath } from '@stacksjs/path';
+import { ResultAsync, err } from '@stacksjs/error-handling';
+
+async function installPackage(pkg) {
+  return await installPackage$1(pkg, { silent: true });
+}
+async function installStack(name) {
+  return await installPackage$1(`@stacksjs/${name}`, { silent: true });
+}
+
+const prompt = log.prompt;
+
+const spinner = ora;
+
+async function intro(command, options) {
+  const version = await frameworkVersion();
+  console.log();
+  console.log(cyan(bold("Stacks CLI")) + dim(` v${version}`));
+  console.log();
+  log.info(`Preparing to run the  ${bgCyan(italic(bold(` ${command} `)))}  command.`);
+  if (options?.showPerformance === false)
+    return;
+  return performance.now();
+}
+function outro(text, options, error) {
+  if (options.isError) {
+    if (error)
+      log.error(error);
+  } else {
+    log.success(text);
+  }
+  if (options.startTime) {
+    let time = performance.now() - options.startTime;
+    if (options.useSeconds) {
+      time = time / 1e3;
+      time = Math.round(time * 100) / 100;
+    }
+    if (options.isError)
+      log.error(red(`in ${time}${options.useSeconds ? "s" : "ms"}`));
+    else
+      log.success(green(`Done in ${time}${options.useSeconds ? "s" : "ms"}`));
+  }
+}
+function startSpinner(text) {
+  if (!text)
+    text = "Executing...";
+  const spin = spinner({
+    text
+  }).start();
+  setTimeout(() => {
+    spin.text = italic("This may take a few moments...");
+    spin.spinner = "clock";
+  }, 7500);
+  return spin;
+}
+
+function isLongOption(arg) {
+  return arg.startsWith("--");
+}
+function isShortOption(arg) {
+  return arg.startsWith("-") && !isLongOption(arg);
+}
+function parseValue(value) {
+  if (value === "true")
+    return true;
+  if (value === "false")
+    return false;
+  const numberValue = parseFloat(value);
+  if (!isNaN(numberValue))
+    return numberValue;
+  return value.replace(/"/g, "");
+}
+function parseLongOption(arg, argv, index, options) {
+  const [key, value] = arg.slice(2).split("=");
+  if (value !== void 0) {
+    options[key] = parseValue(value);
+  } else if (index + 1 < argv.length && !argv[index + 1].startsWith("-")) {
+    options[key] = argv[index + 1];
+    index++;
+  } else {
+    options[key] = true;
+  }
+  return index;
+}
+function parseShortOption(arg, argv, index, options) {
+  const [key, value] = arg.slice(1).split("=");
+  if (value !== void 0) {
+    for (let j = 0; j < key.length; j++)
+      options[key[j]] = parseValue(value);
+  } else {
+    for (let j = 0; j < key.length; j++) {
+      if (index + 1 < argv.length && j === key.length - 1 && !argv[index + 1].startsWith("-")) {
+        options[key[j]] = parseValue(argv[index + 1]);
+        index++;
+      } else {
+        options[key[j]] = true;
+      }
+    }
+  }
+  return index;
+}
+function parseArgv(argv) {
+  if (argv === void 0)
+    argv = process.argv.slice(2);
+  const args = [];
+  const options = {};
+  for (let i = 0; i < argv.length; i++) {
+    const arg = argv[i];
+    if (isLongOption(arg))
+      i = parseLongOption(arg, argv, i, options);
+    else if (isShortOption(arg))
+      i = parseShortOption(arg, argv, i, options);
+    else
+      args.push(arg);
+  }
+  return { args, options };
+}
+function parseOptions(argv) {
+  if (argv === void 0)
+    argv = process.argv.slice(2);
+  return parseArgv(argv).options;
+}
+function parseArgs(argv) {
+  if (argv === void 0)
+    argv = process.argv.slice(2);
+  return parseArgv(argv).args;
+}
+
+function exec(command, options) {
+  const cwd = options?.cwd || projectPath();
+  const stdio = determineDebugLevel(options) ? "inherit" : "ignore";
+  const shell = options?.shell || false;
+  return ResultAsync.fromPromise(
+    execaCommand(command, { stdio, cwd, shell }),
+    () => new Error(`Failed to run command: ${italic(command)}`)
+  );
+}
+function execSync(command) {
+  return execSync$1(command, { encoding: "utf-8" });
+}
+async function runCommand(command, options) {
+  console.log("runCommand", command, options);
+  return await exec(command, options);
+}
+async function runCommands(commands, options) {
+  console.log("runCommands", commands, options);
+  const results = [];
+  const numberOfCommands = commands.length;
+  if (!numberOfCommands) {
+    log.error(new Error("No commands were specified"));
+    process.exit();
+  }
+  const spinner = determineSpinner(options);
+  console.log("spinner", spinner);
+  for (const command of commands) {
+    const result = await runCommand(command, options);
+    if (result.isOk()) {
+      results.push(result);
+    } else if (result.isErr()) {
+      if (spinner) {
+        err(result.error);
+        process.exit(ExitCode.FatalError);
+      }
+      results.push(result);
+      break;
+    }
+  }
+  if (spinner)
+    spinner.stop();
+  if (numberOfCommands === 1)
+    return results[0];
+  return results;
+}
+function determineSpinner(options) {
+  if (!determineDebugLevel(options))
+    return startSpinner(options?.spinnerText);
+  return void 0;
+}
+
+export { exec, execSync, installPackage, installStack, intro, outro, parseArgs, parseArgv, parseOptions, prompt, runCommand, runCommands, spinner, startSpinner };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/cli",
   "type": "module",
-  "version": "0.51.0",
-  "packageManager": "pnpm@7.26.3",
+  "version": "0.52.0",
+  "packageManager": "pnpm@8.5.1",
   "description": "The simple way to create beautiful CLIs.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -29,6 +29,12 @@
     "ez-spawn",
     "stacks"
   ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    }
+  },
   "main": "dist/index.mjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -39,31 +45,27 @@
     "dist",
     "README.md"
   ],
-  "engines": {
-    "node": ">=v18.14.0",
-    "pnpm": ">=7.26.3"
-  },
   "peerDependencies": {
     "@antfu/install-pkg": "^0.1.1",
     "cac": "^6.7.14",
-    "execa": "^6.1.0",
-    "ora": "^6.1.2",
-    "prompts": "^2.4.2",
-    "@stacksjs/config": "0.51.0",
-    "@stacksjs/error-handling": "0.51.0",
-    "@stacksjs/logging": "0.51.0",
-    "@stacksjs/path": "0.51.0",
-    "@stacksjs/types": "0.51.0",
-    "@stacksjs/utils": "0.51.0"
+    "execa": "^7.1.1",
+    "ora": "^6.3.1",
+    "@stacksjs/config": "0.52.0",
+    "@stacksjs/error-handling": "0.52.0",
+    "@stacksjs/logging": "0.52.0",
+    "@stacksjs/path": "0.52.0",
+    "@stacksjs/types": "0.52.0",
+    "@stacksjs/utils": "0.52.0"
+  },
+  "dependencies": {
+    "kolorist": "1.8.0"
   },
   "devDependencies": {
-    "esno": "^0.16.3",
-    "mkdist": "^1.1.0",
-    "@stacksjs/testing": "0.51.0"
+    "@stacksjs/development": "0.52.0"
   },
   "scripts": {
-    "build": "mkdist -d",
-    "dev": "mkdist -d",
+    "build": "unbuild",
+    "dev": "unbuild --stub",
     "typecheck": "tsc --noEmit"
   }
 }

package/dist/actions/index.d.ts

@@ -1 +0,0 @@
-export * from './install';

package/dist/actions/index.mjs

@@ -1 +0,0 @@
-export * from "./install.mjs";

package/dist/actions/install.d.ts

@@ -1,15 +0,0 @@
-import type { CommandResult } from '@stacksjs/types';
-/**
- * Install an npm package.
- *
- * @param pkg - The package name to install.
- * @returns The result of the install.
- */
-export declare function installPackage(pkg: string): Promise<CommandResult<string>>;
-/**
- * Install a Stack into your project.
- *
- * @param pkg - The Stack name to install.
- * @returns The result of the install.
- */
-export declare function installStack(name: string): Promise<CommandResult<string>>;

package/dist/actions/install.mjs

@@ -1,7 +0,0 @@
-import { installPackage as installPkg } from "@antfu/install-pkg";
-export async function installPackage(pkg) {
-  return await installPkg(pkg, { silent: true });
-}
-export async function installStack(name) {
-  return await installPkg(`@stacksjs/${name}`, { silent: true });
-}

package/dist/command.d.ts

@@ -1,4 +0,0 @@
-import { execaCommand } from 'execa';
-declare const spawn: typeof execaCommand;
-declare const command: (name?: string | undefined) => import("cac").CAC;
-export { spawn, command };

package/dist/command.mjs

@@ -1,5 +0,0 @@
-import cac from "cac";
-import { execaCommand } from "execa";
-const spawn = execaCommand;
-const command = cac;
-export { spawn, command };

package/dist/console.d.ts

@@ -1,3 +0,0 @@
-import { log } from '@stacksjs/logging';
-declare const prompts: any;
-export { log, prompts };

package/dist/console.mjs

@@ -1,4 +0,0 @@
-import { log } from "@stacksjs/logging";
-import Prompts from "prompts";
-const { prompts } = Prompts;
-export { log, prompts };

package/dist/helpers.d.ts

@@ -1,10 +0,0 @@
-import type { IntroOptions, OutroOptions } from '@stacksjs/types';
-/**
- * Prints the intro message.
- */
-export declare function intro(command: string, options?: IntroOptions): Promise<number | undefined>;
-/**
- * Prints the outro message.
- */
-export declare function outro(text: string, options: OutroOptions, error?: Error | string): void;
-export declare function startSpinner(text?: string): import("ora").Ora;

package/dist/helpers.mjs

@@ -1,45 +0,0 @@
-import { frameworkVersion } from "@stacksjs/utils";
-import { log } from "./console.mjs";
-import { spinner } from "./spinner.mjs";
-import { bgCyan, bold, cyan, dim, green, italic, red } from "./utilities.mjs";
-export async function intro(command, options) {
-  const version = await frameworkVersion();
-  console.log();
-  console.log(cyan(bold("Stacks CLI")) + dim(` v${version}`));
-  console.log();
-  log.info(`Preparing to run the  ${bgCyan(italic(bold(` ${command} `)))}  command.`);
-  if (options?.showPerformance === false)
-    return;
-  return performance.now();
-}
-export function outro(text, options, error) {
-  if (options.isError) {
-    if (error)
-      log.error(error);
-  } else {
-    log.success(text);
-  }
-  if (options.startTime) {
-    let time = performance.now() - options.startTime;
-    if (options.useSeconds) {
-      time = time / 1e3;
-      time = Math.round(time * 100) / 100;
-    }
-    if (options.isError)
-      log.error(red(`in ${time}${options.useSeconds ? "s" : "ms"}`));
-    else
-      log.success(green(`Done in ${time}${options.useSeconds ? "s" : "ms"}`));
-  }
-}
-export function startSpinner(text) {
-  if (!text)
-    text = "Executing...";
-  const spin = spinner({
-    text
-  }).start();
-  setTimeout(() => {
-    spin.text = italic("This may take a few moments...");
-    spin.spinner = "clock";
-  }, 7500);
-  return spin;
-}

package/dist/run.d.ts

@@ -1,28 +0,0 @@
-import type { CliOptions, CommandResult, Result } from '@stacksjs/types';
-import type { Err } from '@stacksjs/error-handling';
-import { ResultAsync } from '@stacksjs/error-handling';
-/**
- * Execute a command.
- *
- * @param command The command to execute.
- * @param options The options to pass to the command.
- * @param errorMsg The name of the error to throw if the command fails.
- * @returns The result of the command.
- */
-export declare function exec(command: string, options?: CliOptions): ResultAsync<CommandResult<string>, Error>;
-/**
- * Run a command the Stacks way.
- *
- * @param command The command to run.
- * @param options The options to pass to the command.
- * @returns The result of the command.
- */
-export declare function runCommand(command: string, options?: CliOptions): Promise<Result<CommandResult<string>, Error>>;
-/**
- * Run many commands—the Stacks way.
- *
- * @param commands The command to run.
- * @param options The options to pass to the command.
- * @returns The result of the command.
- */
-export declare function runCommands(commands: string[], options?: CliOptions): Promise<Result<CommandResult<string>, Error>[] | Result<CommandResult<string>, Error> | Err<CommandResult<string>, string>>;

package/dist/run.mjs

@@ -1,49 +0,0 @@
-import { determineDebugMode } from "@stacksjs/config";
-import { ResultAsync, err } from "@stacksjs/error-handling";
-import { projectPath } from "@stacksjs/path";
-import { spawn } from "./command.mjs";
-import { startSpinner } from "./helpers.mjs";
-import { italic } from "./index.mjs";
-export function exec(command, options) {
-  const cwd = options?.cwd || projectPath();
-  const stdio = determineDebugMode(options) ? "inherit" : "ignore";
-  const shell = options?.shell || false;
-  return ResultAsync.fromPromise(
-    spawn(command, { stdio, cwd, shell }),
-    () => new Error(`Failed to run command: ${italic(command)}`)
-  );
-}
-export async function runCommand(command, options) {
-  return await exec(command, options);
-}
-export async function runCommands(commands, options) {
-  const results = [];
-  const numberOfCommands = commands.length;
-  if (!numberOfCommands)
-    return err("No commands were specified");
-  const spinner = determineSpinner(options);
-  for (const command of commands) {
-    const result = await runCommand(command, options);
-    if (result?.isOk())
-      results.push(result);
-    if (result?.isErr()) {
-      if (spinner) {
-        spinner.fail("Failed to run command.");
-        err(result.error);
-        process.exit();
-      }
-      results.push(result);
-      break;
-    }
-  }
-  if (spinner)
-    spinner.stop();
-  if (numberOfCommands === 1)
-    return results[0];
-  return results;
-}
-function determineSpinner(options) {
-  if (!determineDebugMode(options))
-    return startSpinner(options?.spinnerText);
-  return void 0;
-}

package/dist/spinner.d.ts

@@ -1,2 +0,0 @@
-import ora from 'ora';
-export declare const spinner: typeof ora;

package/dist/spinner.mjs

@@ -1,2 +0,0 @@
-import ora from "ora";
-export const spinner = ora;

package/dist/utilities.d.ts

@@ -1 +0,0 @@
-export { ansi256Bg, bgBlack, bgBlue, bgCyan, bgGray, bgGreen, bgLightBlue, bgLightCyan, bgLightGray, bgLightGreen, bgLightMagenta, bgLightRed, bgLightYellow, bgMagenta, bgRed, bgWhite, bgYellow, black, blue, bold, cyan, dim, gray, green, hidden, inverse, italic, lightBlue, lightCyan, lightGray, lightGreen, lightMagenta, lightRed, lightYellow, link, magenta, red, reset, strikethrough, underline, white, yellow } from 'kolorist';

package/dist/utilities.mjs

@@ -1 +0,0 @@
-export { ansi256Bg, bgBlack, bgBlue, bgCyan, bgGray, bgGreen, bgLightBlue, bgLightCyan, bgLightGray, bgLightGreen, bgLightMagenta, bgLightRed, bgLightYellow, bgMagenta, bgRed, bgWhite, bgYellow, black, blue, bold, cyan, dim, gray, green, hidden, inverse, italic, lightBlue, lightCyan, lightGray, lightGreen, lightMagenta, lightRed, lightYellow, link, magenta, red, reset, strikethrough, underline, white, yellow } from "kolorist";