@stacksjs/cli/dist/command.d.ts

TypeScript framework for CLI artisans. Build beautiful console apps with ease.

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)
  },
}