← All recipes
Open source

Format Java code

Recipe IDorg.openrewrite.java.format.AutoFormat
Artifactorg.openrewrite:rewrite-java

Format Java code using a standard comprehensive set of Java formatting recipes.

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.format.AutoFormat

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

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

Options

NameTypeDescription
styleStringAn OpenRewrite style formatted in YAML.
e.g. type: specs.openrewrite.org/v1beta/style name: com.yourorg.YesTabsNoStarImports styleConfigs: - org.openrewrite.java.style.TabsAndIndentsStyle: useTabCharacter: true

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