@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

5.4.0 (2022-08-08)

Bug Fixes

• core: update nx version range base to latest (#3283) (241cdde)
• create: default test script no longer errors (#3266) (dfd30fa)

Features

• init: create .gitignore with lerna init (#3270) (3461348)