Find Gradle projects

org.openrewrite.gradle.search.FindGradleProject

Gradle projects are those with build.gradle or build.gradle.kts files.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-gradle

• version: 8.23.1

Options

Type	Name	Description	Example
SearchCriteria	searchCriteria	Whether to identify gradle projects by source file name or the presence of a marker Valid options: File, Marker	Marker

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.FindGradleProjectExample. 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.FindGradleProjectExample
displayName: Find Gradle projects example
recipeList:
  - org.openrewrite.gradle.search.FindGradleProject:
      searchCriteria: Marker

Now that com.yourorg.FindGradleProjectExample has been defined activate it in your build file:

Gradle

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

build.gradle

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

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

repositories {
    mavenCentral()
}

2. Run gradle rewriteRun 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 FindGradleProjectExample

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.

Contributors

Jonathan Schneider, Knut Wannheden