← All recipes
Moderne licensed

Remove npm dependency

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

Remove an npm dependency from package.json and regenerate the lock file. If the dependency does not exist in any scope, the recipe is a no-op.

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.RemoveDependency")
}

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.RemoveDependency --recipe-option "packageName=lodash"

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

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

Options

NameTypeDescription
packageNamerequiredStringThe name of the npm package to remove (e.g., lodash, @types/node).
e.g. lodash
scopeStringThe dependency scope to remove from: dependencies, devDependencies, peerDependencies, optionalDependencies, or bundledDependencies. If not specified, removes from all scopes.
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