← All recipes
Moderne licensed

Automatically select recipe examples from the unit test cases of a recipe

Recipe IDorg.openrewrite.java.recipes.SelectRecipeExamples
Artifactorg.openrewrite.recipe:rewrite-rewrite

Add @DocumentExample to the first non-issue and not a disabled unit test of a recipe as an example, if there are not any examples yet.

Single recipeMSAL

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.recipes.SelectRecipeExamples

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

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

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