@lerna/bootstrap

What is @lerna/bootstrap?

@lerna/bootstrap is a part of the Lerna monorepo management toolset. It is used to install and link dependencies for a multi-package repository, ensuring that all inter-package dependencies are properly resolved and symlinked.

What are @lerna/bootstrap's main functionalities?

Install dependencies

This feature installs all the dependencies for the packages in the monorepo. It uses the npm client and hoists common dependencies to the root node_modules directory.

const { bootstrap } = require('@lerna/bootstrap');

bootstrap({
  cwd: process.cwd(),
  npmClient: 'npm',
  hoist: true
}).then(() => {
  console.log('Dependencies installed and linked');
});

Link local packages

This feature links local packages together, ensuring that inter-package dependencies are resolved using symlinks. This is useful for development as changes in one package are immediately reflected in dependent packages.

const { bootstrap } = require('@lerna/bootstrap');

bootstrap({
  cwd: process.cwd(),
  npmClient: 'npm',
  hoist: true
}).then(() => {
  console.log('Local packages linked');
});

Run lifecycle scripts

This feature runs specified lifecycle scripts (e.g., prepublish, postinstall) for all packages in the monorepo. This ensures that any necessary build steps or other setup tasks are performed.

const { bootstrap } = require('@lerna/bootstrap');

bootstrap({
  cwd: process.cwd(),
  npmClient: 'npm',
  hoist: true,
  scripts: ['prepublish', 'postinstall']
}).then(() => {
  console.log('Lifecycle scripts executed');
});

Other packages similar to @lerna/bootstrap

yarn

Yarn is a package manager that also supports monorepos through its workspaces feature. It installs dependencies and links local packages similarly to @lerna/bootstrap, but it is a more general-purpose tool with a broader scope.

pnpm

pnpm is a fast, disk space-efficient package manager that also supports monorepos. It uses a content-addressable file system to store all files from all module directories on a disk. It is similar to @lerna/bootstrap in that it can install and link dependencies, but it offers additional performance benefits.

rush

Rush is a monorepo management tool that provides sophisticated support for managing large repositories with many packages. It includes features for installing dependencies, linking local packages, and running lifecycle scripts, similar to @lerna/bootstrap, but it also offers advanced features like incremental builds and change tracking.

README

@lerna/bootstrap

description TODO

Usage

TODO

Changelog

3.0.0-beta.9 (2018-03-24)

Bug Fixes

• filter-options: Move include/exclude validation into filter-packages (503251d)
• git-utils: Remove unused methods, stop mocking tests (3e00d7a)
• publish: Split --skip-* properly, leave working tree clean (5b4b2c9)

Features

• command: Remove legacy config handling (d305a38)
• command: Rename this.repository -> this.project (43e98a0)
• project: Normalize config.commands -> config.command (24e55e3)
• project: Use cosmiconfig to locate and read lerna.json (b8c2789)

BREAKING CHANGES

• publish: Previously, gitHead annotations were leftover if --skip-npm was passed, despite no actual requirement for that property when no publishing is going on.

Now, all publish-related operations are truly skipped with --skip-npm, and all git commit/push-related operations are skipped with --skip-git. Passing --skip-npm will now also always push to remote, which represents a breaking change from 2.x behavior.

Thanks @KingScooty for raising the issue!

• command: lerna.json bootstrapConfig and publishConfig namespaces are no longer honored. These config blocks should be moved to command.bootstrap and command.publish, respectively.

<a name="3.0.0-beta.8"></a>