← All recipes
Moderne licensed

Upgrade npm dependency version

Recipe IDorg.openrewrite.javascript.UpgradeDependencyVersion
Artifactorg.openrewrite:rewrite-javascript

Upgrades the version constraint of matching npm dependencies in package.json and regenerates the lock file by running the package manager. Matching is by exact package name or glob pattern. v1 uses simple string inequality for the upgrade check (always overwrites). A future version will use semver to skip already-up-to-date constraints. Not safe to use as a precondition: invokes the package manager and publishes per-project state shared with other dependency recipes.

Single recipeMSAL

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.javascript.UpgradeDependencyVersion --recipe-option "newVersion=^5.0.0"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite:rewrite-javascript:8.88.0

Options

NameTypeDescription
packageNameStringExact package name to match. Mutually exclusive with packagePattern; at least one is required.
e.g. lodash
packagePatternStringGlob pattern matching package names (e.g., @types/*). Mutually exclusive with packageName; at least one is required.
e.g. @types/*
newVersionrequiredStringThe new version constraint to set on matching dependencies.
e.g. ^5.0.0

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