Class ShellContext

constructor

• new ShellContext(): ShellContext

• Returns ShellContext

execaOptions

logCommand

sleep

$

• get $(): ExecaScriptMethod<Options & {
      env: {};
      verbose: undefined | ((verboseLine: string, verboseObject: VerboseObject) => void);
  }>

• Returns ExecaScriptMethod<Options & {
      env: {};
      verbose: undefined | ((verboseLine: string, verboseObject: VerboseObject) => void);
  }>

cwd

• get cwd(): string

• get current word directory

  Returns string

cd

• cd(dir): ShellContext

• change work directory

  Parameters

  • dir: string

  Returns ShellContext

env

• env(key): this

• set/get/delete env set: ctx.env('key', 'val') set: ctx.env('key=val') delete: ctx.env('key', void 0)

  Parameters

  • key: string

  Returns this
• env(key, val): this

• Parameters

  • key: string
  • val: undefined | string

  Returns this

exec

• exec(command, options?): ResultPromise<Options>

• NOTE!!!: New multiple commands are written as a single string with multiple lines, execute command,

  Parameters

  • command: string
  • Optionaloptions: Options

  Returns ResultPromise<Options>

  Example

  await ctx.exec('echo 1')
  
  await ctx.exec(`
    echo 1
    sleep 1
    echo 2
  `)
  Copy

monitor

• monitor(dir, run, options?): void

• restart processes when file changes

  Parameters

  • dir: string
  • run: string | string[] | ((p: {
        current: null | ChildProcess;
    }) => void)
  • options: WatchDirOptions & {
        ignore?: ((event: string, file: null | string) => boolean);
    } = {}

  Returns void

  Example

  ctx.monitor('./src', 'tsc')
   ctx.monitor('./src', 'webpack')
   ctx.monitor('./src', 'foy watch')
   ctx.monitor('./src', ['rm -rf dist', 'foy watch'])
   ctx.monitor('./src', async p => {
     await fs.rmrf('dist')
     p.current = ctx.exec('webpack serve')
   })
  Copy

popd

• popd(): ShellContext

• like popd in shell

  Returns ShellContext

pushd

• pushd(dir): ShellContext

• like pushd in shell

  Parameters

  • dir: string

  Returns ShellContext

resetEnv

• resetEnv(): ShellContext

• reset env to default

  Returns ShellContext