Moderne licensed

Add npm dependency

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

Add an npm dependency to package.json and regenerate the lock file by running the package manager. If the dependency already exists in any scope, the recipe is a no-op. 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.AddDependency")
}

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.AddDependency --recipe-option "packageName=lodash" --recipe-option "version=^5.0.0"

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

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

Options

Name	Type	Description
`packageName`required	`String`	The name of the npm package to add (e.g., `lodash`, `@types/node`). e.g. `lodash`
`version`required	`String`	The version constraint to set (e.g., `^5.0.0`, `~2.1.0`, `3.0.0`). e.g. `^5.0.0`
`scope`	`String`	The dependency scope: `dependencies`, `devDependencies`, `peerDependencies`, or `optionalDependencies`. Defaults to `dependencies`. 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