@storybook/csf-tools

@nutol/monorepo

This module contains a set of common scripts to maintain a lerna monorepo.

• script-util: common utility functions for lerna
• check-package-locks: check if package-lock.json files has local packages.
• rebuild-package-locks: rebuild package-lock.json files for all packages or packages matching given scopes.
• run-lerna: run lerna command with LERNA_ROOT_PATH environment variable set to the root path of the monorepo
• config-lerna-scopes: return a list of scope names for conventional commits.
• update-package-deps: update package dependencies to match versions of local packages.
• update-package-json: update package.json files for all packages based on metadata from the root package.json for the monorepo
• update-ts-project-refs: update tsconfig.json with TypeScript project references based on the dependency graph.

Basic use

To use @nutol/monorepo for your lerna monorepo, run the following command to add @nutol/monorepo as a dev dependency to the root project.

npm i @nutol/monorepo --save-dev

The following commands are exposed by @nutol/monorepo.

• nb-run-lerna: run lerna command with LERNA_ROOT_PATH environment variable set to the root path of the monorepo

• nb-check-package-locks: check if package-lock.json files has local packages.

• nb-rebuild-package-locks: rebuild package-lock.json files for all packages or packages matching given scopes.

• nb-update-package-deps: update package dependencies to match versions of local packages.

• nb-update-package-json: update package.json files for all packages based on metadata from the root package.json for the monorepo.

• nb-update-ts-project-refs: update tsconfig.json with TypeScript project references based on the dependency graph.

These commands can be invoked using npx:

npx nb-update-ts-project-refs
npx nb-rebuild-package-locks

The --dry-run option can be used to preview changes without applying them.

npx nb-update-ts-project-refs --dry-run

To access such scripts programmatically:

const {
  checkPackageLocks,
  configLernaScopes,
  runLerna,
  updatePackageDeps,
  updatePackageJson,
  updateTsProjectRefs,
  getPackages,
  loadLernaRepo,
  runMain,
} = require('@nutol/monorepo');

Contributions

• Guidelines
• Join the team

Tests

run npm test from the root folder.

Contributors

See all contributors.

License

MIT