Styles

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:
1
---
2
type: specs.openrewrite.org/v1beta/style
3
name: io.moderne.spring.style
4
styleConfigs:
5
  - org.openrewrite.java.style.ImportLayoutStyle:
6
      classCountToUseStarImport: 999
7
      nameCountToUseStarImport: 999
8
      layout:
9
        - import java.*
10
        - <blank line>
11
        - import javax.*
12
        - <blank line>
13
        - import all other imports
14
        - <blank line>
15
        - import org.springframework.*
16
        - <blank line>
17
        - import static all other imports
18
      packagesToFold:
19
        - java.awt.*
20
        - java.swing.*
21
  - org.openrewrite.java.style.TabsAndIndentsStyle:
22
      useTabCharacter: true
23
      tabSize: 1
24
      indentSize: 1
25
      continuationIndent: 2
26
      indentsRelativeToExpressionStart: false
Copied!
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 6mo ago

Export as PDF

Copy link

Contents

Declarative Styles

Next Steps