Moderne OnlyThis recipe is proprietary to Moderne and runs on the Moderne platform or CLI — it isn’t part of the open-source catalog. Available with a Moderne subscription.Contact Sales

Find and fix vulnerable npm dependencies

Recipe IDorg.openrewrite.nodejs.security.DependencyVulnerabilityCheck

Artifactorg.openrewrite.recipe:rewrite-nodejs

This software composition analysis (SCA) tool detects and upgrades dependencies with publicly disclosed vulnerabilities. This recipe both generates a report of vulnerable dependencies and upgrades to newer versions with fixes. This recipe by default only upgrades to the latest patch version. If a minor or major upgrade is required to reach the fixed version, this can be controlled using the maximumUpgradeDelta option. Vulnerability information comes from the GitHub Security Advisory Database, which aggregates vulnerability data from several public databases.

Customizing Vulnerability Data

Extend this recipe and override baselineVulnerabilities(ctx) to replace the bundled advisory database, or override supplementalVulnerabilities(ctx) to add organisation-specific advisories alongside the bundled data.

Single recipeOpenRewriteModerne Proprietary License

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

8 parameters

8 optional

Parameter	Example	Type	Required
addOverrideComments	true	Boolean	Optional
When enabled, adds a comment field (e.g. //overrides) alongside overrides to document which CVEs each override is fixing. Default is true.
cvePattern	CVE-2023-.*	String	Optional
Only fix vulnerabilities matching this regular expression pattern.
fixDeclaredVersions	true	Boolean	Optional
When enabled, also upgrades version specifiers declared in package.json that specify vulnerable versions, even if the lock file already resolves to a safe version. Default is false.
maximumUpgradeDelta	patch	String	Optional
The maximum difference to allow when upgrading a dependency version. Use none to only report vulnerabilities without making any changes.
minimumSeverity	moderate	String	Optional
Only fix vulnerabilities with a severity level equal to or higher than the specified minimum. Default is low.
preferDirectUpgrade	false	Boolean	Optional
When fixing transitive vulnerabilities, first try to find higher versions of direct dependencies that include safe transitive versions. Default is true.
scope	dependencies	String	Optional
Match dependencies with the specified scope. Default includes all scopes.
transitiveFixStrategy	override	String	Optional
Strategy for handling transitive dependency vulnerabilities. report only reports them without fixing. override adds overrides/resolutions for transitive vulnerabilities. lock-file updates the lock file to resolve safe versions without modifying package.json. Default is report.

Usage

Run this recipe

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe DependencyVulnerabilityCheck

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite.recipe:rewrite-nodejs:0.46.2

Data tables

Vulnerability report

org.openrewrite.nodejs.table.VulnerabilityReport

Lists all vulnerabilities found in project dependencies.

Column	Description
Source path	Path to the package.json file where the vulnerability was found.
CVE	The CVE identifier of the vulnerability.
Package	The name of the vulnerable package.
Version	The resolved version of the package.
Fixed version	The version that fixes the vulnerability.
Last affected	The last version affected by the vulnerability.
Upgradeable	Whether the vulnerability can be fixed with a version upgrade within the maximum delta.
Summary	Brief description of the vulnerability.
Severity	Severity level of the vulnerability.
Depth	Depth in the dependency tree (0 = direct, 1+ = transitive).
CWEs	CWE identifiers associated with this vulnerability.
Is direct	Whether this is a direct dependency.
Dependency path	Path showing how the vulnerable dependency is brought in.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.