Add npm dependency
org.openrewrite.javascript.dependencies.add-dependency
Adds a new dependency to package.json and updates the lock file by running the package manager.
Recipe source
GitHub, Issue Tracker, Maven Central
This recipe is available under the Moderne Source Available License.
Options
| Type | Name | Description | Example |
|---|---|---|---|
null | packageName | The name of the npm package to add (e.g., lodash, @types/node) | lodash |
null | version | The version constraint to set (e.g., ^5.0.0, ~2.1.0, 3.0.0) | ^5.0.0 |
null | scope | Optional. The dependency scope: dependencies, devDependencies, peerDependencies, or optionalDependencies | dependencies |
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:
Install the recipe package
mod config recipes npm install @openrewrite/rewrite
Then, you can run the recipe via:
Run the recipe
mod run . --recipe org.openrewrite.javascript.dependencies.add-dependency