Node.js dependency insight

org.openrewrite.nodejs.search.DependencyInsight

Identify the direct and transitive Node.js dependencies used in a project.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe

• artifactId: rewrite-nodejs

• version: 0.2.1

Options

Type	Name	Description	Example
String	namePattern	Name glob pattern used to match dependencies.	@apollo*
String	version	Optional. Match only dependencies with the specified version. Node-style version selectors may be used.All versions are searched by default.	1.x
Boolean	onlyDirect	Optional. If enabled, transitive dependencies will not be considered. All dependencies are searched by default.	true

Data Tables (Only available on the Moderne platform)

Dependencies in use

Direct and transitive dependencies in use.

Column Name	Description
Name	The name of the node package.
Requested version	The requested version.
Version	The resolved version.

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.DependencyInsightExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.DependencyInsightExample
displayName: Node.js dependency insight example
recipeList:
  - org.openrewrite.nodejs.search.DependencyInsight:
      namePattern: '@apollo*'
      version: 1.x
      onlyDirect: true

Now that com.yourorg.DependencyInsightExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-nodejs:0.2.1 in your build file:

Gradle

1. Add the following to your build.gradle file:

build.gradle

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

rewrite {
    activeRecipe("com.yourorg.DependencyInsightExample")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-nodejs:0.2.1")
}

2. Run gradle rewriteRun to run the recipe.

Maven

1. Add the following to your pom.xml file:

pom.xml

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.DependencyInsightExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-nodejs</artifactId>
            <version>0.2.1</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

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 DependencyInsightExample

See how this recipe works across multiple open-source repositories

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.