Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "tools/config"

Index

Functions

Functions

externalCommands

  • Imports commands for root or child scopes.

    Parameters

    • config: IConfig

      the current loaded config.

    • pargs: IKawkahParserResult

      parsed result to pass to command init.

    • cli: ICli

      the cli object to pass to command init.

    Returns IConfig

load

  • load(defaults?: Partial<IConfig>): Promise<{}>

  • Reads scopes recursing up building project configuration.

    Parameters

    • Optional defaults: Partial<IConfig>

      default values for the configuration.

    Returns Promise<{}>

readPackage

  • readPackage(filename: string): Promise<unknown>

  • Reads package.json

    Parameters

    • filename: string

      the path of the package to be found.

    Returns Promise<unknown>

readRoot

readScopes

  • readScopes(globs?: string[]): Promise<IScope[]>

  • Reads child workspaces or scopes using glob pattern matching.

    Parameters

    • Default value globs: string[] = []

      the globs of paths representing scoped workspaces.

    Returns Promise<IScope[]>

readUp

  • readUp(filename: string, maxLevels?: number): Promise<any[]>

  • Reads up finding matching files.

    Parameters

    • filename: string

      the file name to read up from.

    • Default value maxLevels: number = 5

      the max levels to recurse up (default: 5)

    Returns Promise<any[]>

Generated using TypeDoc