Styles

Preserves the stylistic expectations of each project on LSTs 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 LSTs that are produced by that parser, providing a durable record of the style of the surrounding project that goes with that LST.
Styles are persisted with a top-level SourceFile LST element when that LST is serialized. Then when batch processing LSTs 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.
For more information on how to work with and use declarative styles, please read our Declarative YAML guide.
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.

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.

Visitors

Environment

Last modified 29d ago