@lerna/package-graph

What is @lerna/package-graph?

@lerna/package-graph is a utility for managing and analyzing the dependency graph of packages within a monorepo. It helps in understanding the relationships between different packages and can be used to perform operations like finding dependencies, dependents, and traversing the graph.

What are @lerna/package-graph's main functionalities?

Creating a Package Graph

This feature allows you to create a graph of packages from an array of package objects. The graph can then be used to analyze the relationships between the packages.

const { PackageGraph } = require('@lerna/package-graph');
const packages = [
  { name: 'package-a', version: '1.0.0', dependencies: { 'package-b': '^1.0.0' } },
  { name: 'package-b', version: '1.0.0', dependencies: {} }
];
const graph = new PackageGraph(packages);
console.log(graph);

Finding Package Dependencies

This feature allows you to find the dependencies of a specific package within the graph. In this example, it retrieves the dependencies of 'package-a'.

const { PackageGraph } = require('@lerna/package-graph');
const packages = [
  { name: 'package-a', version: '1.0.0', dependencies: { 'package-b': '^1.0.0' } },
  { name: 'package-b', version: '1.0.0', dependencies: {} }
];
const graph = new PackageGraph(packages);
const packageA = graph.get('package-a');
console.log(packageA.localDependencies);

Finding Package Dependents

This feature allows you to find the dependents of a specific package within the graph. In this example, it retrieves the dependents of 'package-b'.

const { PackageGraph } = require('@lerna/package-graph');
const packages = [
  { name: 'package-a', version: '1.0.0', dependencies: { 'package-b': '^1.0.0' } },
  { name: 'package-b', version: '1.0.0', dependencies: {} }
];
const graph = new PackageGraph(packages);
const packageB = graph.get('package-b');
console.log(packageB.localDependents);

Other packages similar to @lerna/package-graph

depgraph

depgraph is a tool for creating and analyzing dependency graphs. It provides similar functionality to @lerna/package-graph, such as creating graphs and finding dependencies and dependents, but it is more general-purpose and can be used outside of monorepos.

madge

madge is a JavaScript library that can create dependency graphs for JavaScript and TypeScript projects. It offers visualization features and can detect circular dependencies, which makes it a more feature-rich alternative for visualizing dependencies compared to @lerna/package-graph.

dependency-cruiser

dependency-cruiser is a tool to analyze and visualize dependencies in JavaScript and TypeScript projects. It offers extensive configuration options and can be used to enforce dependency rules, making it a more comprehensive tool for dependency management compared to @lerna/package-graph.

README

@lerna/package-graph

Lerna's internal representation of a package graph

Usage

You probably shouldn't, at least directly.

Install lerna for access to the lerna CLI.

Changelog

3.18.0 (2019-10-15)

Bug Fixes

• bootstrap: Move all filter logging into get-filtered-packages method (54dca56)
• options: Explicit --conventional-graduate (f73e6ed)
• options: Explicit --conventional-prerelease (f3581ae)
• options: Explicit --force-local (6948a11)
• options: Explicit --force-publish (343a751)
• options: Explicit --ignore-prepublish (fa21723)
• options: Explicit --ignore-scripts (efcb3bd)
• options: Explicit --pre-dist-tag (1d9552c)
• options: Explicit --use-workspaces (ac8385d)

Features

• filter-options: Add --exclude-dependents option (ff50e29), closes #2198
• filter-options: Allow command to continue if no packages are matched (#2280) (a706023)
• filter-options: Rename --include-filtered-* options (f2c3a92)
• filter-options: Use figgy-pudding in getFilteredPackages() (73badee)
• Remove unused @lerna/batch-packages (d136fb5)
• Remove unused @lerna/run-parallel-batches (ec95403)
• Upgrade to yargs@14 (5e60213)
• package-graph: Deprecate method pruneCycleNodes() (ccf32e1)