Upgrade Dependents

A utility to upgrade package dependents.

Overview

Upgrade Dependents will discover and upgrade all compatible dependents within a directory.

Features

• Adheres to Semantic Versioning 2.0.0 — no unexpected breaking changes
• Support for Semantic Release — seamless configuration via a plugin
• Yarn workspaces detection — simply run the command in a package directory
• CLI utility — for ad hoc uses
• Dry run mode — test without fear

Usage

CLI

The utility can be used without any configuration or installation with npx, which is available with [email protected] or later.

cd /workspace/packages/my-package
npx upgrade-dependents --help

Programmatically

Upgrade Dependents can be used programmatically via import.

import upgradeDependents from 'upgrade-dependents';

upgradeDependents("/workspace/packages/my-package");

Semantic Release

Upgrade Dependents can also be used as a plugin for Semantic Release. This is particularly useful when used with Semantic Release Monorepo.

Example configuration:

/workspace/packages/my-package/package.json

{
  "release": {
    "prepare": [
      "@semantic-release/changelog",
      "@semantic-release/npm",
      "upgrade-dependents/semantic-release"
      "@semantic-release/git"
    ]
  }
}

Installation

Node.js via Yarn

yarn add upgrade-dependents -D

Node.js via npm

npm i upgrade-dependents -D

License

Copyright © 2018 Morris Allison III. Released under the MIT license.