IntelliJ Platform Plugin SDK Help

17. Code Style Settings

Code style settings enable defining formatting options. A code style settings provider creates an instance of the settings and also creates an options page in Settings. This example creates a Settings page that uses the default language code style settings, customized by a language code style settings provider.

Define Code Style Settings

Define SimpleCodeStyleSettings for Simple Language by subclassing CustomCodeStyleSettings.

public class SimpleCodeStyleSettings extends CustomCodeStyleSettings { public SimpleCodeStyleSettings(CodeStyleSettings settings) { super("SimpleCodeStyleSettings", settings); } }

Define Code Style Settings Provider

The code style settings provider gives the IntelliJ Platform a standard way to instantiate CustomCodeStyleSettings for the Simple Language.

Define SimpleCodeStyleSettingsProvider for Simple Language by subclassing CodeStyleSettingsProvider.

final class SimpleCodeStyleSettingsProvider extends CodeStyleSettingsProvider { @Override public CustomCodeStyleSettings createCustomSettings(@NotNull CodeStyleSettings settings) { return new SimpleCodeStyleSettings(settings); } @Override public String getConfigurableDisplayName() { return "Simple"; } @NotNull public CodeStyleConfigurable createConfigurable(@NotNull CodeStyleSettings settings, @NotNull CodeStyleSettings modelSettings) { return new CodeStyleAbstractConfigurable(settings, modelSettings, this.getConfigurableDisplayName()) { @Override protected @NotNull CodeStyleAbstractPanel createPanel(@NotNull CodeStyleSettings settings) { return new SimpleCodeStyleMainPanel(getCurrentSettings(), settings); } }; } private static class SimpleCodeStyleMainPanel extends TabbedLanguageCodeStylePanel { public SimpleCodeStyleMainPanel(CodeStyleSettings currentSettings, CodeStyleSettings settings) { super(SimpleLanguage.INSTANCE, currentSettings, settings); } } }

Register the Code Style Settings Provider

The SimpleCodeStyleSettingsProvider implementation is registered with the IntelliJ Platform in the plugin configuration file using the com.intellij.codeStyleSettingsProvider extension point.

<extensions defaultExtensionNs="com.intellij"> <codeStyleSettingsProvider implementation="org.intellij.sdk.language.SimpleCodeStyleSettingsProvider"/> </extensions>

Define the Language Code Style Settings Provider

Define SimpleLanguageCodeStyleSettingsProvider for Simple Language by subclassing LanguageCodeStyleSettingsProvider, which provides common code style settings for a specific language.

final class SimpleLanguageCodeStyleSettingsProvider extends LanguageCodeStyleSettingsProvider { @NotNull @Override public Language getLanguage() { return SimpleLanguage.INSTANCE; } @Override public void customizeSettings(@NotNull CodeStyleSettingsCustomizable consumer, @NotNull SettingsType settingsType) { if (settingsType == SettingsType.SPACING_SETTINGS) { consumer.showStandardOptions("SPACE_AROUND_ASSIGNMENT_OPERATORS"); consumer.renameStandardOption("SPACE_AROUND_ASSIGNMENT_OPERATORS", "Separator"); } else if (settingsType == SettingsType.BLANK_LINES_SETTINGS) { consumer.showStandardOptions("KEEP_BLANK_LINES_IN_CODE"); } } @Override public String getCodeSample(@NotNull SettingsType settingsType) { return """ # You are reading the ".properties" entry. ! The exclamation mark can also mark text as comments. website = language = English # The backslash below tells the application to continue reading # the value onto the next line. message = Welcome to \\ Wikipedia! # Add spaces to the key key\\ with\\ spaces = This is the value that could be looked up with the key "key with spaces". # Unicode tab : \\u0009"""; } }

Register the Language Code Style Settings Provider

The SimpleLanguageCodeStyleSettingsProvider implementation is registered with the IntelliJ Platform in the plugin configuration file using the com.intellij.langCodeStyleSettingsProvider extension point.

<extensions defaultExtensionNs="com.intellij"> <langCodeStyleSettingsProvider implementation="org.intellij.sdk.language.SimpleLanguageCodeStyleSettingsProvider"/> </extensions>

Run the Project

Run the plugin by using the Gradle runIde task.

In the IDE Development Instance, open the Simple Language code formatting page: Settings | Editor | Code Style | Simple.

Code Style Settings
Last modified: 27 February 2023