check-updates

Installation

Install it as a development dependency:

npm install -D @zityhub/check-updates

Or run it directly using npx:

npx @zityhub/check-updates

Usage

Check if any of your project's dependencies have a major version update:

check-updates

2024-10-08T18:32:05.485Z ERROR Job check-updates finished failed
{
  "type": {
    "name": "job",
    "data": {
      "jobName": "check-updates",
      "message": "Major update available for: awilix,jsonpath-plus,stripe"
    }
  }
}

The command will return an error if there are any packages that need a major version update.

Exclude Packages

You can ignore specific dependencies to ensure the check returns an exit code 0. Excluded dependencies are reported as info (exit code 0) instead of failing:

check-updates --exclude=awilix --exclude=jsonpath-plus --exclude=stripe

2024-10-08T18:34:51.341Z INFO Job check-updates finished success
{
  "type": {
    "name": "job",
    "data": {
      "jobName": "check-updates",
      "message": "Major update available for: awilix,jsonpath-plus,stripe"
    }
  }
}

If some dependencies still have a pending major update after applying the excludes, only those are notified and the command returns an error:

check-updates --exclude=awilix

2024-10-08T18:34:51.341Z ERROR Job check-updates finished failed
{
  "type": {
    "name": "job",
    "data": {
      "jobName": "check-updates",
      "message": "Major update available for: jsonpath-plus,stripe"
    }
  }
}

Auto-generate the Exclude List

Maintaining the --exclude flags by hand is tedious. Run --add-exclude to regenerate them automatically: it reads the check-updates script from your package.json, detects which dependencies currently have a pending major update, and rewrites that script's --exclude flags to match.

check-updates --add-exclude

2024-10-08T18:40:12.001Z INFO Job check-updates finished success
{
  "type": {
    "name": "job",
    "data": {
      "jobName": "check-updates",
      "message": "Updated check-updates excludes: awilix,jsonpath-plus,stripe"
    }
  }
}

Given this script in your package.json:

{
  "scripts": {
    "check-updates": "check-updates --exclude=awilix"
  }
}

After running check-updates --add-exclude it becomes:

{
  "scripts": {
    "check-updates": "check-updates --exclude=awilix --exclude=jsonpath-plus --exclude=stripe"
  }
}

The exclude list is fully regenerated, so packages that no longer have a pending major update are removed. If there is no check-updates script in package.json, nothing is changed and the command exits successfully.

Add it as a Script in your Package

It is recommended to add it as a script in your package.json for easier usage:

{
  "scripts": {
    "check-updates": "check-updates"
  }
}