Upgrade npm dependency version
org.openrewrite.javascript.dependencies.upgrade-dependency-version
Upgrades the version of a direct dependency in package.json and updates the lock file by running the package manager. Either packageName or packagePattern must be specified.
Recipe source
GitHub: rewrite+org.openrewrite.javascript.dependencies.upgrade-dependency-version, Issue Tracker, Maven Central
This recipe is available under the Moderne Source Available License.
Options
| Type | Name | Description | Example |
|---|---|---|---|
null | packageName | Optional. The exact name of the npm package to upgrade (e.g., lodash, @types/node). Either this or packagePattern must be specified. | lodash |
null | packagePattern | Optional. A glob expression to match package names (e.g., @angular/*, @types/*). Either this or packageName must be specified. | @angular/* |
null | newVersion | The version constraint to set (e.g., ^5.0.0, ~2.1.0, 3.0.0) | ^5.0.0 |
Used by
This recipe is used as part of the following composite recipes:
- Upgrade to Angular 10
- Upgrade to Angular 11
- Upgrade to Angular 12
- Upgrade to Angular 13
- Upgrade to Angular 14
- Upgrade to Angular 15
- Upgrade to Angular 16
- Upgrade to Angular 17
- Upgrade to Angular 18
- Upgrade to Angular 19
- Upgrade to Angular 20
- Upgrade to Angular 21
- Upgrade to Angular 8
- Upgrade to Angular 9
Usage
In order to run JavaScript recipes, you will need to use the Moderne CLI. For JavaScript specific configuration instructions, please see our configuring JavaScript guide.
Once the CLI is installed, you can install this JavaScript recipe package by running the following command:
mod config recipes npm install @openrewrite/rewrite
Then, you can run the recipe via:
mod run . --recipe org.openrewrite.javascript.dependencies.upgrade-dependency-version