Logo for jsDocs.io

lerna

  • Version 10.0.1
  • Published
  • 608 kB
  • 49 dependencies
  • MIT license

Install

npm i lerna
yarn add lerna
pnpm add lerna

Overview

Lerna is a fast, modern build system for managing and publishing multiple JavaScript/TypeScript packages from the same repository

Index

Functions

Type Aliases

Namespaces

Functions

function colorize

colorize: typeof colorize;

  • Apply terminal color/style formatting to text. Wraps util.styleText with a programmatic kill switch for tests, since test runner workers set FORCE_COLOR=1 which overrides NO_COLOR.

function exec

exec: (
    command: string,
    args: string[],
    opts?: LernaOptions
) => Promise<LernaReturnValue>;

  • Execute a command asynchronously, piping stdio by default.

    Parameter command

    Parameter args

    Parameter opts

    Returns

function execSync

execSync: (command: string, args: string[], opts?: any) => string;

  • Execute a command synchronously.

    Parameter command

    Parameter args

    Parameter opts

function getChildProcessCount

getChildProcessCount: () => number;

    function getExitCode

    getExitCode: (
        result: execa.ExecaError<string> & { code?: string | number }
    ) => number | undefined;

    • Parameter result

      Returns

    function spawn

    spawn: (
        command: string,
        args: string[],
        opts?: LernaOptions
    ) => Promise<LernaReturnValue>;

    • Spawn a command asynchronously, _always_ inheriting stdio.

      Parameter command

      Parameter args

      Parameter opts

    function spawnStreaming

    spawnStreaming: (
        command: string,
        args: string[],
        opts?: LernaOptions,
        prefix?: string
    ) => Promise<LernaReturnValue>;

    • Spawn a command asynchronously, streaming stdio with optional prefix.

      Parameter command

      Parameter args

      Parameter opts

      Parameter prefix

    Type Aliases

    type LernaChildProcess

    type LernaChildProcess = withPkg<execa.ExecaChildProcess<string>>;

      type LernaOptions

      type LernaOptions = withPkg<execa.Options>;

        type LernaReturnValue

        type LernaReturnValue = withPkg<execa.ExecaReturnValue<string>>;

          type StyleFormat

          type StyleFormat = Parameters<typeof styleText>[0];

            Namespaces

            namespace colorize

            namespace colorize {}

              function disable

              disable: () => void;

                function enable

                enable: () => void;

                  Package Files (2)

                  Dependencies (49)

                  Dev Dependencies (0)

                  No dev dependencies.

                  Peer Dependencies (0)

                  No peer dependencies.

                  Badge

                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/lerna.

                  • Markdown
                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/lerna)
                  • HTML
                    <a href="https://www.jsdocs.io/package/lerna"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>