README.md

Check My Package Version

Script to check package version against branches.

Motivation

On projects where versioning is manual, this script can be used in continuous integration (CI) to notify that the current branch is not at a higher version than the main branch.

Usage

You can run right from npx:

npx check-my-package-version --help

Output:

Usage: check-my-package-version [options]

Options:
  -V, --version         output the version number
  -o, --org <name>      organization name
  -p, --project <name>  project name
  -f, --file <path>     package.json file path (default: "package.json")
  -b, --branch <name>   branch name (default: "main")
  -h, --help            display help for command

Example using https://github.com/facebook/react/:

npx check-my-package-version -o facebook -p react

Monorepo

If you are using a monorepo, you can use the --file option to specify the path to the package.json file:

npx check-my-package-version -o babel -p babel --file packages/babel-core/package.json

Installation

Running the follow command to install the package:

# with NPM
npm install --save-dev check-my-package-version

# with Yarn
yarn add --dev check-my-package-version