upgradeps
Version:
Audit and upgrade all dependencies in package.json.
191 lines (124 loc) • 5.36 kB
Markdown
# upgradeps · [](https://www.npmjs.com/package/upgradeps) [](https://www.repostatus.org/#active)
Audit and upgrade all dependencies in package.json.
**upgradeps** is a small command-line tool that inspects the dependencies declared in your package.json file, compares them with the latest versions published on the npm registry, and optionally updates package.json for you.
## Features
- Works as a dry run by default, never changing files unless explicitly told to.
- Supports all standard dependency groups: dependencies, devDependencies, peerDependencies, optionalDependencies, bundledDependencies.
- Lets you restrict upgrades to minor and patch versions only.
- Can remove semver `^` carets and lock your package.json to exact versions.
- Can use npm or yarn as the package manager.
- Supports a simple JSON configuration file so you do not have to repeat flags.
## Quick start
From the root of a Node project:
1. Audit dependencies without changing anything:
```sh
npx upgradeps
```
2. Apply all available upgrades:
```sh
npx upgradeps -u
```
3. Apply upgrades and remove `^` carets:
```sh
npx upgradeps -u -f
```
4. Upgrade only minor and patch versions:
```sh
npx upgradeps -u -m
```
## CLI usage
upgradeps is intended to be used via npx:
```sh
npx upgradeps [options]
```
### -f / --fixed
Remove the `^` caret symbol from versions when upgrading, turning ranges into fixed versions.
This flag has an effect only when used together with -u.
```sh
npx upgradeps -u -f
```
### -g / --groups <groups>
Comma-separated list of dependency groups to process.
Available groups:
- bundledDependencies
- dependencies
- devDependencies
- optionalDependencies
- peerDependencies
If omitted, all groups present in package.json are processed.
```sh
npx upgradeps -g dependencies,devDependencies
```
### -m / --minor
Process only minor and patch updates, ignoring major version bumps.
Use this when you want safe, non-breaking upgrades.
```sh
npx upgradeps -m
```
### -r / --registry <registry>
Use a custom npm registry URL.
```sh
npx upgradeps -r https://registry.npmjs.org
```
### -s / --skip <packages>
Comma-separated list of package names that should never be upgraded.
This is useful when a dependency is pinned for compatibility reasons.
```sh
npx upgradeps -u -s react,react-dom
```
### -u / --upgrade
Modify package.json in place, writing upgraded versions back to each dependency group.
Without this flag, upgradeps only prints a report.
```sh
npx upgradeps -u
```
### -v / --verbose
Print information about all dependencies (including those that are already at their latest version).
```sh
npx upgradeps -v
```
### -y / --yarn
Use yarn instead of npm when running install commands during an upgrade.
```sh
npx upgradeps -u -y
```
## Configuration file
Instead of repeating the same flags, you can add a `.upgradeps.json` file next to your package.json to define default behavior.
If you run upgradeps without any options, `.upgradeps.json` is loaded (if it exists) and its values are used (with built-in defaults where needed). If you pass any CLI options, `.upgradeps.json` is ignored for that run and only CLI flags + defaults are used.
### Example .upgradeps.json
```json
{
"fixed": false,
"groups": ["dependencies", "devDependencies"],
"minor": false,
"registry": "",
"skip": ["react", "react-dom"],
"upgrade": false,
"verbose": false,
"yarn": false
}
```
### Available options
All properties are optional. When a property is omitted, its default is used.
- **`fixed`** (boolean): Remove `^` carets when upgrading. Default: `false`
- **`groups`** (array of strings): Specify dependency groups to process. Default: `[]` (all supported groups present in package.json)
- **`minor`** (boolean): Process only minor and patch updates. Default: `false`
- **`registry`** (string): Set custom npm registry URL. Default: `""`
- **`skip`** (array of strings): Packages to skip during upgrade. Default: `[]` (none)
- **`upgrade`** (boolean): Automatically upgrade package.json. Default: `false`
- **`verbose`** (boolean): Print information for latest dependencies as well. Default: `false`
- **`yarn`** (boolean): Use yarn instead of npm. Default: `false`
### CLI vs config
- Running upgradeps with no options uses `.upgradeps.json` (if present) + built-in defaults.
- Running upgradeps with one or more options uses only CLI flags + built-in defaults (`.upgradeps.json` is ignored for that run).
In other words, `.upgradeps.json` is for _plain_ runs with no flags (as soon as you pass options, you're opting into a fully CLI-driven run).
## Tips
- Run a dry audit first (without -u) to see what will change.
- Commit your package.json and lockfile before running upgradeps so you can easily revert if needed.
- Combine -m with -u to perform safe, incremental updates on large projects.
## License
ISC
## Links
- npm package page: https://www.npmjs.com/package/upgradeps
- Repository and issue tracker: https://github.com/lropero/upgradeps