Remove npm dependency
Recipe ID
org.openrewrite.javascript.RemoveDependencyArtifact
org.openrewrite:rewrite-javascriptRemove 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.
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:8.88.0Options
| Name | Type | Description |
|---|---|---|
packageNamerequired | String | The name of the npm package to remove (e.g., lodash, @types/node).e.g. lodash |
scope | String | The 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.
- 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