← All recipes
Open source

Order imports

Recipe IDorg.openrewrite.java.OrderImports
Artifactorg.openrewrite:rewrite-java

Groups and orders import statements. If a style has been defined, this recipe will order the imports according to that style. If no style is detected, this recipe will default to ordering imports in the same way that IntelliJ IDEA does.

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.OrderImports

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

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

Options

NameTypeDescription
removeUnusedBooleanRemove unnecessary imports.
styleStringAn OpenRewrite style formatted in YAML.
e.g. type: specs.openrewrite.org/v1beta/style name: com.yourorg.CustomImportLayout styleConfigs: - org.openrewrite.java.style.ImportLayoutStyle: classCountToUseStarImport: 999 nameCountToUseStarImport: 999 layout: - 'import java.*' - 'import javax.*' - '<blank line>' - 'import all other imports' - '<blank line>' - 'import static all other imports' packagesToFold: - 'import java.awt.*' - 'import static org.junit.jupiter.api.Assertions.*

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