← All recipes
Open source

Module contains file

Recipe IDorg.openrewrite.java.search.ModuleContainsFile
Artifactorg.openrewrite:rewrite-java

Intended to be used primarily as a precondition for other recipes, this recipe checks if a module contains a specific file or files matching a pattern. Only files belonging to modules containing the specified file are marked with a SearchResult marker. This is more specific than RepositoryContainsFile which marks all files in the repository if any file matches.

Single recipeApache 2.0

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.search.ModuleContainsFile

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite:rewrite-java:8.88.0

Options

NameTypeDescription
filePatternStringA glob expression representing a file path to search for (relative to the project root). Blank/null matches all. Multiple patterns may be specified, separated by a semicolon ;. If multiple patterns are supplied any of the patterns matching will be interpreted as a match.
e.g. .github/workflows/*.yml

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