syncpack

What is syncpack?

Syncpack is a tool for managing multiple package.json files in a monorepo or multi-package repository. It helps ensure consistency across dependencies, scripts, and other configurations.

What are syncpack's main functionalities?

List Dependencies

Lists all dependencies across multiple package.json files, helping you identify inconsistencies.

const { list } = require('syncpack');
list();

Fix Versions

Fixes version mismatches across multiple package.json files, ensuring all packages use the same version of a dependency.

const { fix } = require('syncpack');
fix();

Set Version

Sets a specific version for a dependency across all package.json files.

const { set } = require('syncpack');
set('react', '17.0.2');

Format

Formats all package.json files to ensure a consistent style.

const { format } = require('syncpack');
format();

Other packages similar to syncpack

lerna

Lerna is a tool for managing JavaScript projects with multiple packages. It optimizes the workflow around managing multi-package repositories with git and npm. Compared to Syncpack, Lerna offers more comprehensive features for managing monorepos, including versioning and publishing.

yarn

Yarn is a package manager that doubles down as a project manager. It offers workspaces that can manage multiple packages within a single repository. While Syncpack focuses on consistency across package.json files, Yarn provides a broader set of features for dependency management and project workflows.

pnpm

pnpm is a fast, disk space-efficient package manager. It also supports workspaces for managing multiple packages in a monorepo. Compared to Syncpack, pnpm is more focused on performance and efficient storage, while Syncpack is specialized in ensuring consistency across package.json files.

README

syncpack

Synchronises the versions of dependencies used across multiple package.json files, such as packages/*/package.json in Lerna Monorepos.

Overview

Imagine the packages guybrush, herman, and elaine all have react as a dependency, but versions '15.4.0', '15.5.4', and '15.6.1' respectively.

/Users/foldleft/Dev/monorepo/packages/
├── guybrush
│   └── package.json
├── herman
│   └── package.json
└── elaine
    └── package.json

Running syncpack will update each package.json to use version '15.6.1' of react in dependencies, devDependencies, and peerDependencies as needed.

Installation

npm install --global syncpack

Usage

Command Line

Usage: syncpack [options] [pattern]

Options:

  -h, --help     output usage information
  -V, --version  output the version number

The default pattern of './packages/*/package.json' can be overridden as follows syncpack './**/package.json'

Changelog

0.2.0

20 August 2017

• feat(sync): synchronise versions across multiple package.json 7d5848a
• chore(release): 0.2.0 257ebf3