Options
All
  • Public
  • Public/Protected
  • All
Menu

Package @tscmono/cli

@tscmono/cli

Index

Command Classes

Plugins Variables

Lifecycle Functions

Plugins Functions

Plugins Variables

Const plugins

plugins: { refresh: (...args: K) => Promise<T>; value: Promise<T> } = registerCache('plugins',getPluginsFromRoot,)

Cached variant of the getPluginsFromRoot function

Type declaration

  • refresh: (...args: K) => Promise<T>
      • (...args: K): Promise<T>

      • Parameters

        • Rest ...args: K

        Returns Promise<T>

  • value: Promise<T>

Lifecycle Functions

Const run

  • run(args: string[]): Promise<void>

  • Run a CLI instance

    Parameters

    • args: string[]

    Returns Promise<void>

Plugins Functions

Const getPlugins

  • getPlugins(pwd?: string, from?: string): Promise<Map<string, any>>

  • Resolve installed plugins from a given path, and any installed presets

    Parameters

    • Default value pwd: string = process.cwd()

      Path to be used when resolving plugins

    • Default value from: string = "root"

      Name to be used for logging purposes (defaults to 'root' and should be used as package name of preset)

    Returns Promise<Map<string, any>>

Const getPluginsFromRoot

  • getPluginsFromRoot(rootDir?: string): Promise<any[]>

  • Obtain plugins from installed plugins and presets of project root

    Parameters

    • Default value rootDir: string = process.cwd()

      Root directory to treat as project root

    Returns Promise<any[]>

Generated using TypeDoc