Moderne licensed

Change npm dependency

Recipe IDorg.openrewrite.javascript.ChangeDependencyArtifactorg.openrewrite:rewrite-javascript

Renames 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.

Single recipeMSAL

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.javascript.ChangeDependency")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite:rewrite-javascript:8.92.8")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

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:RELEASE

Options

Name	Type	Description
`oldPackageName`required	`String`	The current name of the npm package to rename. e.g. `lodash`
`newPackageName`required	`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.

Node.js lock regeneration failuresLock files that could not be regenerated after a dependency edit, and why.org.openrewrite.javascript.table.NodeLockRegenerationFailures
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