Change npm dependency
Recipe ID
org.openrewrite.javascript.ChangeDependencyArtifact
org.openrewrite:rewrite-javascriptRenames an npm dependency in package.json and optionally updates its version constraint. After modifying the package.json, the lock file is regenerated by running the package manager. Not safe to use as a precondition: invokes the package manager and publishes per-project state shared with other dependency recipes.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.javascript.ChangeDependency --recipe-option "oldPackageName=lodash" --recipe-option "newPackageName=lodash-es"If the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite:rewrite-javascript:8.88.0Options
| Name | Type | Description |
|---|---|---|
oldPackageNamerequired | String | The current name of the npm package to rename. e.g. lodash |
newPackageNamerequired | String | The new name to use for the package. e.g. lodash-es |
newVersion | String | Optional new version constraint to set on the renamed package. e.g. ^5.0.0 |
scope | String | The dependency scope: dependencies, devDependencies, etc. When omitted, all scopes are searched.e.g. dependencies |
Data tables
Structured output this recipe can produce.
- Source files that had resultsSource files that were modified by the recipe run.
org.openrewrite.table.SourcesFileResults - Source files that had search resultsSearch results that were found during the recipe run.
org.openrewrite.table.SearchResults - Source files that errored on a recipeThe details of all errors produced by a recipe run.
org.openrewrite.table.SourcesFileErrors - Recipe performanceStatistics used in analyzing the performance of recipes.
org.openrewrite.table.RecipeRunStats