formatter.md

title
15. Formatter

A formatter allows to reformat the code automatically based on code style settings.

15.1. Define a block

The formatter uses the blocks to receive formatting rules for each PSI element. Our goal is to cover each PSI element with such block. Since each block builds own children blocks we can generate extra blocks or skip any PSI elements.

{% include /code_samples/simple_language_plugin/src/com/simpleplugin/SimpleBlock.java %}

15.2. Define a formatting model builder

Let's define a formatter which removes extra spaces except the single ones around the property separator.

{% include /code_samples/simple_language_plugin/src/com/simpleplugin/SimpleFormattingModelBuilder.java %}

15.3. Register the formatter

<lang.formatter language="Simple" implementationClass="com.simpleplugin.SimpleFormattingModelBuilder"/>

15.4. Run the project

Now add some extra spaces and reformat the code via Code | Reformat Code.

Previous Top Next