Comment on page

Find files

org.openrewrite.FindSourceFiles
Find files by source path.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-core
version: 8.9.5
Options
Type
Name
Description
String
filePattern
A glob expression representing a file path to search for (relative to the project root).
Data Tables (Only available on the Moderne platform)
Source files that matched
Source files that matched some criteria.
Column Name
Description
Source path before the run
The source path of the file before the run.
LST type
The LST model type that the file is parsed as.
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.FindSourceFilesExample. 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.FindSourceFilesExample
displayName: Find files example
recipeList:
  - org.openrewrite.FindSourceFiles:
      filePattern: .github/workflows/*.yml
Now that com.yourorg.FindSourceFilesExample has been defined activate it in your build file:
Gradle
Maven
Moderne CLI
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.5.6")
}
​
rewrite {
    activeRecipe("com.yourorg.FindSourceFilesExample")
}
​
repositories {
    mavenCentral()
}
2.Run gradle rewriteRun to run the recipe.
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.13.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.FindSourceFilesExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe FindSourceFiles
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, Shannon Pamperl, Sam Snyder​

Type	Name	Description
`String`	filePattern	A glob expression representing a file path to search for (relative to the project root).

Column Name	Description
Source path before the run	The source path of the file before the run.
LST type	The LST model type that the file is parsed as.

Find colliding source files

Find instances of type Quark

Last modified 10d ago