@lerna/run

What is @lerna/run?

@lerna/run is a part of the Lerna monorepo management toolset. It allows you to run scripts or commands across multiple packages in a monorepo, making it easier to manage and automate tasks in a multi-package repository.

What are @lerna/run's main functionalities?

Run npm scripts in all packages

This command runs the 'test' script in all packages that contain it. It's useful for ensuring that all packages pass their tests before a release.

lerna run test

Run npm scripts in specific packages

This command runs the 'build' script only in the package named 'my-package'. This is useful for targeting specific packages for certain tasks.

lerna run build --scope my-package

Run npm scripts with parallel execution

This command runs the 'lint' script in all packages in parallel, which can speed up the process significantly compared to running them sequentially.

lerna run lint --parallel

Run npm scripts with a specific concurrency

This command runs the 'test' script in all packages but limits the number of concurrent executions to 4. This can help manage resource usage on your machine.

lerna run test --concurrency 4

Other packages similar to @lerna/run

nx

Nx is a set of extensible dev tools for monorepos, which helps you develop like Google, Facebook, and Microsoft. It offers similar functionalities to Lerna, including running scripts across multiple packages, but also provides advanced features like dependency graph visualization and affected command execution.

rush

Rush is a scalable monorepo manager for the web, which helps you manage large repositories with many projects. It offers similar script running capabilities as Lerna but focuses more on build orchestration and dependency management.

README

@lerna/run

Run an npm script in each package that contains that script

Usage

$ lerna run <script> -- [..args] # runs npm run my-script in all packages that have it
$ lerna run test
$ lerna run build

# watch all packages and transpile on change, streaming prefixed output
$ lerna run --parallel watch

Run an npm script in each package that contains that script. A double-dash (--) is necessary to pass dashed arguments to the script execution.

Options

lerna run respects the --concurrency, --scope, and --ignore flags (see Filter Flags).

$ lerna run --scope my-component test

--npm-client <client>

Must be an executable that knows how to run npm lifecycle scripts. The default --npm-client is npm.

$ lerna run build --npm-client=yarn

May also be configured in lerna.json:

{
  "command": {
    "run": {
      "npmClient": "yarn"
    }
  }
}

--stream

Stream output from child processes immediately, prefixed with the originating package name. This allows output from different packages to be interleaved.

$ lerna run watch --stream

--parallel

Similar to --stream, but completely disregards concurrency and topological sorting, running a given command or script immediately in all matching packages with prefixed streaming output. This is the preferred flag for long-running processes such as npm run watch run over many packages.

$ lerna run watch --parallel

Note: It is advised to constrain the scope of this command when using the --parallel flag, as spawning dozens of subprocesses may be harmful to your shell's equanimity (or maximum file descriptor limit, for example). YMMV

--no-bail

# Run an npm script in all packages that contain it, ignoring non-zero (error) exit codes
$ lerna run --no-bail test

By default, lerna run will exit with an error if any script run returns a non-zero exit code. Pass --no-bail to disable this behavior, running the script in all packages that contain it regardless of exit code.

Changelog

3.0.0 (2018-08-10)

Bug Fixes

• add: Always use POSIX paths when computing relative file: specifiers (ffe354f)
• add: Support explicit & implicit relative file: specifiers (41f231f)
• create: Use filename without scope when generating imports from test file (acfd48b)
• publish: Improve npm pack experience (627cfc2)

Features

• changed: Support list output options (6ecdd83)
• list: Extract @lerna/listable utility (bf56018)
• list: Improve scriptability with several new options (2e204af)
• npm-publish: Add npmPack export (088ea54)
• package: Add tarball property (be453cd)
• publish: Run npm pack before npm publish (8d80b2c)
• publish: Validate npm registry and package access prerequisites (ebc8ba6), closes #55 #1045 #1347
• Add @lerna/log-packed module, extracted from npm (9c767ac)
• Split lerna version from of lerna publish (#1522) (8b97394), closes #277 #936 #956 #961 #1056 #1118 #1385 #1483 #1494

BREAKING CHANGES

• changed: The package names emitted to stdout are no longer prefixed by a "- ", and private packages are no longer displayed by default.

• list: The default output of lerna ls no longer shows version strings or private packages.

• The new alias lerna la resembles the old output, with the addition of relative path to the package

• The new alias lerna ll is a shortcut for the new --long option

• A new --parseable option has been added to aid magical piping incantations

• • --preid now defaults to "alpha" during prereleases:

  The previous default for this option was undefined, which led to an awkward "1.0.1-0" result when passed to semver.inc().

  The new default "alpha" yields a much more useful "1.0.1-alpha.0" result. Any previous prerelease ID will be preserved, just as it was before.

• --no-verify is no longer passed to git commit by default, but controlled by the new --commit-hooks option:

  The previous behavior was too overzealous, and the new option operates exactly like the corresponding npm version option of the same name.

  As long as your pre-commit hooks are properly scoped to ignore changes in package.json files, this change should not affect you. If that is not the case, you may pass --no-commit-hooks to restore the previous behavior.

<a name="3.0.0-rc.0"></a>