@stacksjs/cli 0.70.23 → 0.70.25

package/dist/src/actions/index.d.ts

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

package/dist/src/actions/install.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Install an npm package.
+ *
+ * @param name - The package name to install.
+ * @param options - The options to pass to the install.
+ * @returns The result of the install.
+ */
+export declare function installPackage(name: string, options?: InstallPackageOptions): Promise<void>;
+/**
+ * Install a Stack into your project.
+ *
+ * @param name - The Stack name to install.
+ * @param options - The options to pass to the install.
+ * @returns The result of the install.
+ */
+export declare function installStack(name: string, options?: InstallPackageOptions): Promise<void>;
+declare interface InstallPackageOptions {
+  cwd?: string
+  dev?: boolean
+  silent?: boolean
+  packageManager?: string
+  preferOffline?: boolean
+  additionalArgs?: string[]
+}

package/dist/src/cli.d.ts

@@ -0,0 +1,14 @@
+import { CLI, onUnknownSubcommand } from '@stacksjs/clapp';
+export declare function cli(name?: string | CliOptions, options?: CliOptions): CLI;
+// Note: applyTheme and getAvailableThemes will be available after @stacksjs/clapp npm package is updated
+// import { applyTheme, getAvailableThemes } from '@stacksjs/clapp'
+export declare interface ParsedArgv {
+  args: ReadonlyArray<string>
+  options: {
+    [k: string]: any
+  }
+}
+declare interface CliOptions {
+  name?: string
+}
+export { CLI, onUnknownSubcommand };

package/dist/src/exec.d.ts

@@ -0,0 +1,40 @@
+import type { CliOptions, Subprocess } from '@stacksjs/types';
+import type { Result } from '@stacksjs/error-handling';
+/**
+ * Execute a command.
+ *
+ * @param command The command to execute.
+ * @param options The options to pass to the command.
+ * @returns The result of the command.
+ * @example
+ * ```ts
+ * const result = await exec('ls')
+ *
+ * if (result.isErr)
+ *   console.error(result.error)
+ * else
+ *   console.log(result)
+ * ```
+ * @example
+ * ```ts
+ * const result = await exec('ls', { cwd: '/home' })
+ * ```
+ */
+export declare function exec(command: string | string[], options?: CliOptions): Promise<Result<Subprocess, Error>>;
+/**
+ * Execute a command and return result.
+ *
+ * @param command The command to execute.
+ * @returns The result of the command.
+ * @example
+ * ```ts
+ * const output = execSync('ls')
+ *
+ * console.log(output)
+ * ```
+ * @example
+ * ```ts
+ * const output = execSync('ls', { cwd: '/home' })
+ * ```
+ */
+export declare function execSync(command: string | string[], options?: CliOptions): Promise<string>;

package/dist/src/helpers.d.ts

@@ -0,0 +1,14 @@
+import { bold, cyan, dim, gray, green, italic } from './utils';
+import { log } from '@stacksjs/logging';
+import type { IntroOptions, OutroOptions } from '@stacksjs/types';
+/**
+ * Prints the intro message.
+ */
+export declare function intro(command: string, options?: IntroOptions): Promise<number>;
+/**
+ * Prints the outro message.
+ */
+export declare function outro(text: string, options?: OutroOptions, error?: Error | string): Promise<number>;
+// Re-export commonly used CLI utilities
+export { log };
+export { italic, bold, cyan, dim, gray, green } from './utils';

package/dist/src/index.d.ts

@@ -0,0 +1,10 @@
+export * from './actions';
+export * from './cli';
+export * from './exec';
+export * from './helpers';
+export * from './parse';
+export * from './prompts';
+export * from './run';
+export * from './signals';
+export * from './spinner';
+export * from './utils';

package/dist/{parse.d.ts → src/parse.d.ts}

@@ -1,15 +1,20 @@
+export declare function parseArgv(argv?: string[]): ParsedArgv;
+export declare function parseArgs(argv?: string[]): string[];
+export declare function parseOptions(options?: CliOptions): CliOptions;
+// interface BuddyOptions {
+//   dryRun?: boolean
+//   verbose?: boolean
+// }
+export declare function buddyOptions(options?: string[] | Record<string, any>): string;
 declare interface ParsedArgv {
   args: string[]
   options: {
     [k: string]: string | boolean | number
   }
 }
-declare function isLongOption(arg?: string): boolean;
-declare function isShortOption(arg: string): boolean;
-declare function parseValue(value: string): string | boolean | number;
-declare function parseLongOption(options: { [k: string] }): number;
-declare function parseShortOption(options: { [k: string] }): number;
-export declare function parseArgv(argv?: string[]): ParsedArgv;
-export declare function parseArgs(argv?: string[]): string[];
-export declare function parseOptions(options?: CliOptions): CliOptions;
-export declare function buddyOptions(options?: string[] | Record<string, any>): string;
+declare interface CliOptions {
+  dryRun?: boolean
+  quiet?: boolean
+  verbose?: boolean
+  [k: string]: string | boolean | number | undefined
+}

package/dist/src/prompts.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Simple confirm prompt
+ */
+declare function confirm(options: ConfirmOptions | string): Promise<boolean>;
+/**
+ * Simple text prompt
+ */
+declare function text(options: TextOptions | string): Promise<string>;
+/**
+ * Simple select prompt (basic implementation)
+ */
+declare function select(options: SelectOptions): Promise<any>;
+/**
+ * Multiselect prompt (basic implementation)
+ */
+declare function multiselect(options: SelectOptions): Promise<any[]>;
+/**
+ * Password prompt (hidden input)
+ */
+declare function password(options: PasswordOptions | string): Promise<string>;
+export declare const prompts: {
+  
+};
+declare interface ConfirmOptions {
+  message: string
+  initial?: boolean
+}
+declare interface TextOptions {
+  message: string
+  initial?: string
+  placeholder?: string
+  validate?: (value: string) => boolean | string
+}
+declare interface PasswordOptions {
+  message: string
+  validate?: (value: string) => boolean | string
+}
+declare interface SelectOptions {
+  message: string
+  choices: Array<{ value: any, label: string }>
+  initial?: number
+}
+// Also export individual functions
+export { confirm, text, select, multiselect, password };

package/dist/src/run.d.ts

@@ -0,0 +1,63 @@
+import type { CliOptions, CommandError, Readable, Subprocess, Writable } from '@stacksjs/types';
+import type { Ok, Result } from '@stacksjs/error-handling';
+/**
+ * Run a command.
+ *
+ * @param command The command to run.
+ * @param options The options to pass to the command.
+ * @returns The result of the command.
+ * @example
+ * ```ts
+ * const result = await runCommand('ls')
+ *
+ * if (result.isErr)
+ *   console.error(result.error)
+ * else
+ *   console.log(result)
+ * ```
+ * @example
+ * ```ts
+ * const result = await runCommand('ls', { cwd: '/home' })
+ *
+ * if (result.isErr)
+ *   console.error(result.error)
+ * else
+ *   console.log(result)
+ * ```
+ */
+export declare function runCommand(command: string, options?: CliOptions): Promise<Result<Subprocess, CommandError>>;
+export declare function runProcess(command: string, options?: CliOptions): Promise<Result<Subprocess, CommandError>>;
+/**
+ * Run a command.
+ *
+ * @param command The command to run.
+ * @param options The options to pass to the command.
+ * @returns The result of the command.
+ * @example
+ * ```ts
+ * const result = runCommandSync('ls')
+ *
+ * if (result.isErr)
+ *   console.error(result.error)
+ * else
+ *   console.log(result)
+ * ```
+ * @example
+ * ```ts
+ * const result = runCommandSync('ls', { cwd: '/home' })
+ *
+ * if (result.isErr)
+ *   console.error(result.error)
+ * else
+ *   console.log(result)
+ * ```
+ */
+export declare function runCommandSync(command: string, options?: CliOptions): Promise<string>;
+/**
+ * Run many commands.
+ *
+ * @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<Ok<Subprocess<Writable, Readable, Readable>, Error>[]>;

package/dist/src/signals.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Register or replace the cleanup for `name`. Returns a disposer that
+ * un-registers this specific cleanup; useful in tests to avoid leaking
+ * across spec files.
+ *
+ * @example
+ * ```ts
+ * import { onSignal } from '@stacksjs/cli'
+ *
+ * const dispose = onSignal('queue-worker', async () => {
+ *   await worker.drain()
+ * })
+ *
+ * // Later, if the worker stops on its own:
+ * dispose()
+ * ```
+ */
+export declare function onSignal(name: string, cleanup: () => void | Promise<void>): () => void;
+/**
+ * Drop a registered handler by name. Equivalent to invoking the disposer
+ * returned by `onSignal`, but useful when the disposer wasn't kept.
+ */
+export declare function offSignal(name: string): void;
+/**
+ * Snapshot of currently-registered handler names — primarily for tests
+ * that want to assert cleanup wiring is in place.
+ */
+export declare function listSignalHandlers(): string[];
+declare type Signal = 'SIGINT' | 'SIGTERM' | 'SIGHUP';

package/dist/src/spinner.d.ts

@@ -0,0 +1,17 @@
+export declare function spinner(message?: string): Spinner;
+/**
+ * Run an async operation with a spinner
+ */
+export declare function withSpinner<T>(message: string, operation: () => Promise<T>, options?: { successMessage?: string; failMessage?: string }): Promise<T>;
+/**
+ * Spinner utilities for CLI with reactive terminal output
+ */
+export declare interface Spinner {
+  start: (message?: string) => void
+  stop: (message?: string) => void
+  succeed: (message?: string) => void
+  fail: (message?: string) => void
+  update: (message: string) => void
+  text: string
+  isSpinning: boolean
+}

package/dist/src/utils.d.ts

@@ -0,0 +1,137 @@
+export declare function stripAnsi(text: string): string;
+export declare function ansi256(code: number): ColorFn;
+export declare function ansi256Bg(code: number): ColorFn;
+export declare function trueColor(r: number, g: number, b: number): ColorFn;
+export declare function trueColorBg(r: number, g: number, b: number): ColorFn;
+export declare function link(url: string): ColorFn;
+export declare function link(text: ColorInput, url: string): string;
+export declare function getColor(colorName: string): ColorFn;
+export declare function colorize(text: ColorInput, colorOrFn: ColorLike): string;
+declare function supportsColor(): boolean;
+export declare function align(text: string, width?: number, alignMode?: Alignment): string;
+export declare function align(text: string, options?: AlignOptions): string;
+export declare function leftAlign(text: string, width?: number): string;
+export declare function rightAlign(text: string, width?: number): string;
+export declare function centerAlign(text: string, width?: number): string;
+export declare function box(text: string, options?: BoxOptions): string;
+export declare const stripColors: typeof stripAnsi;
+export declare const black: ColorFn;
+export declare const red: ColorFn;
+export declare const green: ColorFn;
+export declare const yellow: ColorFn;
+export declare const blue: ColorFn;
+export declare const magenta: ColorFn;
+export declare const cyan: ColorFn;
+export declare const white: ColorFn;
+export declare const gray: ColorFn;
+export declare const lightRed: ColorFn;
+export declare const lightGreen: ColorFn;
+export declare const lightYellow: ColorFn;
+export declare const lightBlue: ColorFn;
+export declare const lightMagenta: ColorFn;
+export declare const lightCyan: ColorFn;
+export declare const lightGray: ColorFn;
+export declare const bgBlack: ColorFn;
+export declare const bgRed: ColorFn;
+export declare const bgGreen: ColorFn;
+export declare const bgYellow: ColorFn;
+export declare const bgBlue: ColorFn;
+export declare const bgMagenta: ColorFn;
+export declare const bgCyan: ColorFn;
+export declare const bgWhite: ColorFn;
+export declare const bgGray: ColorFn;
+export declare const bgLightRed: ColorFn;
+export declare const bgLightGreen: ColorFn;
+export declare const bgLightYellow: ColorFn;
+export declare const bgLightBlue: ColorFn;
+export declare const bgLightMagenta: ColorFn;
+export declare const bgLightCyan: ColorFn;
+export declare const bgLightGray: ColorFn;
+export declare const bold: ColorFn;
+export declare const dim: ColorFn;
+export declare const italic: ColorFn;
+export declare const underline: ColorFn;
+export declare const inverse: ColorFn;
+export declare const hidden: ColorFn;
+export declare const strikethrough: ColorFn;
+export declare const reset: ColorFn;
+export declare const colors: ColorsApi;
+export declare const kolorist: KoloristApi;
+export declare const quotes: any;
+declare interface AlignOptions {
+  width?: number
+  align?: Alignment
+  padChar?: string
+}
+declare interface BoxOptions {
+  align?: Alignment
+  borderColor?: ColorLike
+  borderStyle?: 'single' | 'double' | 'round'
+  margin?: number
+  padding?: number
+  title?: string
+}
+declare type ColorInput = string | number;
+declare type ColorFn = (_text: ColorInput) => string;
+declare type ColorLike = ColorFn | string;
+declare type Alignment = 'left' | 'center' | 'right';
+declare type NamedColorMap = {
+  black: ColorFn
+  red: ColorFn
+  green: ColorFn
+  yellow: ColorFn
+  blue: ColorFn
+  magenta: ColorFn
+  cyan: ColorFn
+  white: ColorFn
+  gray: ColorFn
+
+  lightRed: ColorFn
+  lightGreen: ColorFn
+  lightYellow: ColorFn
+  lightBlue: ColorFn
+  lightMagenta: ColorFn
+  lightCyan: ColorFn
+  lightGray: ColorFn
+
+  bgBlack: ColorFn
+  bgRed: ColorFn
+  bgGreen: ColorFn
+  bgYellow: ColorFn
+  bgBlue: ColorFn
+  bgMagenta: ColorFn
+  bgCyan: ColorFn
+  bgWhite: ColorFn
+  bgGray: ColorFn
+
+  bgLightRed: ColorFn
+  bgLightGreen: ColorFn
+  bgLightYellow: ColorFn
+  bgLightBlue: ColorFn
+  bgLightMagenta: ColorFn
+  bgLightCyan: ColorFn
+  bgLightGray: ColorFn
+
+  bold: ColorFn
+  dim: ColorFn
+  italic: ColorFn
+  underline: ColorFn
+  inverse: ColorFn
+  hidden: ColorFn
+  strikethrough: ColorFn
+  reset: ColorFn
+}
+declare type ColorsApi = NamedColorMap & {
+  ansi256: typeof ansi256
+  ansi256Bg: typeof ansi256Bg
+  trueColor: typeof trueColor
+  trueColorBg: typeof trueColorBg
+  link: typeof link
+  stripColors: typeof stripColors
+}
+declare type KoloristApi = ColorsApi & {
+  grey: ColorFn
+  lightGrey: ColorFn
+  bgLightGrey: ColorFn
+  supportsColor: () => boolean
+}

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@stacksjs/cli",
   "type": "module",
-  "version": "0.70.23",
+  "version": "0.70.25",
   "description": "TypeScript framework for CLI artisans. Build beautiful console apps with ease.",
   "author": "Chris Breuer",
-  "contributors": ["Chris Breuer <chris@stacksjs.org>"],
+  "contributors": [
+    "Chris Breuer <chris@stacksjs.com>"
+  ],
   "license": "MIT",
   "funding": "https://github.com/sponsors/chrisbbreuer",
   "homepage": "https://github.com/stacksjs/stacks/tree/main/storage/framework/core/cli#readme",
@@ -34,40 +36,39 @@
   ],
   "exports": {
     ".": {
+      "bun": "./src/index.ts",
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
     "./*": {
+      "bun": "./src/*",
       "import": "./dist/*"
     }
   },
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": ["README.md", "dist"],
+  "files": [
+    "README.md",
+    "dist"
+  ],
   "scripts": {
     "build": "bun build.ts",
     "typecheck": "bun tsc --noEmit",
     "test": "bun test",
     "prepublishOnly": "bun run build"
   },
+  "dependencies": {
+    "@stacksjs/clapp": "^0.2.8"
+  },
   "devDependencies": {
-    "@antfu/install-pkg": "^1.0.0",
-    "@clack/core": "^0.4.1",
-    "@stacksjs/collections": "0.70.22",
-    "@stacksjs/config": "0.70.22",
-    "@stacksjs/development": "0.70.22",
-    "@stacksjs/error-handling": "0.70.22",
-    "@stacksjs/logging": "0.70.22",
-    "@stacksjs/path": "0.70.22",
-    "@stacksjs/types": "0.70.22",
-    "@stacksjs/utils": "0.70.22",
-    "@stacksjs/validation": "0.70.22",
-    "@types/prompts": "^2.4.9",
-    "ansi-escapes": "^7.0.0",
-    "cac": "^6.7.14",
-    "consola": "^3.4.2",
-    "kolorist": "1.8.0",
-    "ora": "^8.2.0",
-    "prompts": "^2.4.2",
-    "supports-hyperlinks": "^4.0.0"
+    "@stacksjs/collections": "0.70.23",
+    "@stacksjs/config": "0.70.23",
+    "better-dx": "^0.2.12",
+    "@stacksjs/error-handling": "0.70.23",
+    "@stacksjs/logging": "0.70.23",
+    "@stacksjs/path": "0.70.23",
+    "@stacksjs/types": "0.70.23",
+    "@stacksjs/utils": "0.70.23",
+    "@stacksjs/validation": "0.70.23"
   }
 }

package/dist/app.d.ts

@@ -1,52 +0,0 @@
-import type { State } from '@clack/core';
-
-declare const unicode: (...args: any[]) => unknown;
-declare const S_BAR_START: unknown;
-declare const S_RADIO_ACTIVE: unknown;
-declare const S_BAR_H: unknown;
-declare function symbol(state: State): void;
-declare interface LimitOptionsParams<TOption> {
-  options: TOption[]
-  maxItems: number | undefined
-  cursor: number
-  style: (option: TOption, active: boolean) => string
-}
-declare function limitOptions<TOption>(params: LimitOptionsParams<TOption>): string[];
-export declare function text(opts: TextOptions): void;
-export declare interface PasswordOptions {
-  message: string
-  mask?: string
-  validate?: (value: string) => string | void
-}
-export declare function password(opts: PasswordOptions): void;
-export declare interface ConfirmOptions {
-  message: string
-  active?: string
-  inactive?: string
-  initialValue?: boolean
-}
-export declare function confirm(opts: ConfirmOptions): void;
-declare type Primitive = Readonly<string | boolean | number>
-
-type Option<Value> = Value extends Primitive
-  ? { value: Value, label?: string, hint?: string }
-  : { value: Value, label: string, hint?: string }
-
-export interface SelectOptions<Value> {
-  message: string
-  options: Option<Value>[]
-  initialValue?: Value
-  maxItems?: number
-}
-export declare function select<Value>(opts: SelectOptions<Value>): void;
-export declare function selectKey<Value extends string>(opts: SelectOptions<Value>): void;
-export declare function multiselect<Value>(opts: MultiSelectOptions<Value>): void;
-export declare function groupMultiselect<Value>(opts: GroupMultiSelectOptions<Value>): void;
-export declare function note(message, title): void;
-export declare function cancel(message): void;
-export declare function intro(title): void;
-export declare function outro(message): void;
-export declare function spinner(): Spinner;
-declare function ansiRegex(): void;
-
-export { isCancel } from '@clack/core'

package/dist/cli.d.ts

@@ -1,15 +0,0 @@
-import type { CliOptions } from '@stacksjs/types';
-import { CAC } from 'cac';
-
-export declare interface ParsedArgv {
-  args: ReadonlyArray<string>
-  options: {
-    [k: string]: any
-  }
-}
-declare interface CliOptions {
-  name?: string
-}
-export declare function cli(name?: string | CliOptions, options?: CliOptions): CAC;
-
-export { CAC }

package/dist/command.d.ts

@@ -1,52 +0,0 @@
-import type { CliOptions, Readable, Subprocess } from '@stacksjs/types';
-
-declare type CommandOptionTuple = [string, string, { default: boolean }]
-interface CommandOptionObject {
-  name: string
-  description: string
-  default: boolean | string
-}
-type CommandOptions = CommandOptionTuple | CommandOptionObject[]
-interface Options {
-  name: string
-  description: string
-  active: boolean
-  options: CommandOptions
-  run: (options?: CliOptions) => Promise<any>
-  onFail: (error: Error) => void
-  onSuccess: () => void
-}
-
-export class Command {
-  name: Options['name']
-  description: Options['description']
-  options: Options['options']
-  run: Options['run']
-  onFail: Options['onFail']
-  onSuccess: Options['onSuccess']
-
-  constructor({ name, description, options, run, onFail, onSuccess }: Options) {
-    this.name = name
-    this.description = description
-    this.options = options
-    this.run = run
-    this.onFail = onFail
-    this.onSuccess = onSuccess
-  }
-}
-
-export const command = {
-  run: async (
-    command: string,
-    options?: CliOptions,
-  ): Promise<Result<Subprocess<Writable, Readable, Readable>, Error>> => {
-    return await runCommand(command, options)
-  },
-
-  runSync: async (
-    command: string,
-    options?: CliOptions,
-  ): Promise<Result<Subprocess<Writable, Readable, Readable>, Error>> => {
-    return await runCommand(command, options)
-  },
-}

package/dist/console.d.ts

@@ -1,17 +0,0 @@
-import prompts from 'prompts';
-import { log } from '@stacksjs/logging';
-
-
-export { log, prompts }
-
-export default function terminalLink(text: string, url: string, { target = 'stdout', ...options }: { target?: string, fallback?: boolean | Function }): string {
-  if (!supportsHyperlinks[target]) {
-    if (options.fallback === false) {
-      return text
-    }
-
-    return typeof options.fallback === 'function' ? options.fallback(text, url) : `${text} (\u200B${url}\u200B)`
-  }
-
-  return ansiEscapes.link(text, url)
-};

package/dist/exec.d.ts

@@ -1,5 +0,0 @@
-import type { CliOptions, Subprocess } from '@stacksjs/types';
-
-export declare function exec(command: string | string[], options?: CliOptions): Promise<Result<Subprocess, Error>>;
-export declare function execSync(command: string | string[], options?: CliOptions): Promise<string>;
-declare function exitHandler(type: 'spawn' | 'spawnSync', subprocess: Subprocess, exitCode: number | null, signalCode: number | null, error?: Error): void;

package/dist/helpers.d.ts

@@ -1,4 +0,0 @@
-import type { IntroOptions, OutroOptions } from '@stacksjs/types';
-
-export declare function intro(command: string, options?: IntroOptions): Promise<number>;
-export declare function outro(text: string, options?: OutroOptions, error?: Error | string): Promise<number>;

package/dist/index.d.ts

@@ -1,10 +0,0 @@
-export * from './actions'
-export * from './cli'
-export * from './command'
-export * from './console'
-export * from './exec'
-export * from './helpers'
-export * from './parse'
-export * from './run'
-export * from './spinner'
-export * from './utils'