GithubJoin us on SlackJoin us on Discord
Search…
Introduction to OpenRewrite
Getting Started
Quickstart: Maven and Gradle
Recipe Development Environment
Tutorials & Guides
Authoring Recipes
Running Recipes
Running Rewrite on a Gradle project without modifying the build
Running Rewrite without build tool plugins
Reference
Latest versions of every OpenRewrite module
Maven Plugin Configuration
Gradle Plugin Configuration
JsonPath and JsonPathMatcher
Declarative YAML Format
Method Patterns
Dependency Version Selectors
Framework Provided Markers
Recipes
Concepts & Explanations
Abstract Syntax Trees
Recipes
Visitors
Styles
Environment
Markers
JavaTemplate
Pointcut Expressions
Design Partners
Design Partner 1
Powered By GitBook
Styles
Preserves the stylistic expectations of each project on ASTs generated from source files in that project.
Styles implement the org.openrewrite.Style interface.
Styles are given to a org.openrewrite.Parser at construction. These styles flow from the parser to any ASTs that are produced by that parser, providing a durable record of the style of the surrounding project that goes with that AST.
Styles are persisted with a top-level SourceFile AST element when that AST is serialized. Then when batch processing ASTs from a variety of projects en masse, the transformation can be contextualized to the style of the individual projects that source files originated from.

Declarative Styles

Styles are typically defined declaratively in a YML file an included in an Environment. For example, the style below configures an import layout style for Java:
---
type: specs.openrewrite.org/v1beta/style
name: io.moderne.spring.style
styleConfigs:
- org.openrewrite.java.style.ImportLayoutStyle:
classCountToUseStarImport: 999
nameCountToUseStarImport: 999
layout:
- import java.*
- <blank line>
- import javax.*
- <blank line>
- import all other imports
- <blank line>
- import org.springframework.*
- <blank line>
- import static all other imports
packagesToFold:
- java.awt.*
- java.swing.*
- org.openrewrite.java.style.TabsAndIndentsStyle:
useTabCharacter: true
tabSize: 1
indentSize: 1
continuationIndent: 2
indentsRelativeToExpressionStart: false
Property
Description
type
specs.openrewrite.org./v1beta/style
name
A name-spaced unique name you are giving to the style
styleConfigs
A list of configurations.
Each list entry is the fully-qualified class name of a Style implementation. The value is itself a map of key-value pairs that invoke setters on the style.

Next Steps

In Environment, we'll see how these styles are activated and applied to the parsers that consume code. It will also show how to discover and activate recipes of visitors.
Concepts & Explanations - Previous
Visitors
Next - Concepts & Explanations
Environment
Last modified 10mo ago
Export as PDF
Copy link
On this page
Declarative Styles
Next Steps