{{announcement.body}}
{{announcement.title}}

Managing Code Style on a Directory Level With EditorConfig

DZone 's Guide to

Managing Code Style on a Directory Level With EditorConfig

Learn more about the newest addition to IntelliJ IDEA — EditorConfig support.

· Java Zone ·
Free Resource

As JetBrains announced a short while ago, in the upcoming version 2019.2, IntelliJ IDEA and other IntelliJ-based IDEs are extending EditorConfig support, thus allowing you to manage all code style settings for each set of files individually. All you need to do is place an .editorconfig file in the root directory containing the files whose code style you want to define. You can have as many .editorconfig files within a project as needed, so you can specify different code styles for different modules. All options from the .editorconfig file are applied to the directory where it resides as well as all of its sub-directories on top of the current project code style defined in Settings/Preferences|Editor|Code Style. If anything is not defined in .editorconfig, it’s taken from the project settings.

In v2019.2, in addition to the standard EditorConfig options, we are adding a bunch of custom IntelliJ IDEA options, so now you can conveniently manage all your code style settings on the directory level.

The options are divided into the following categories:

  • Standard options such as indent_size, indent_style, and so on. These options do not have any domain-specific prefixes.
  • Generic IntelliJ IDEA options that have the ij_ prefix and are applicable to all languages:
    • ij_visual_guides
    • ij_formatter_off_tag
    • ij_formatter_on_tag
    • ij_formatter_tags_enabled
    • ij_wrap_on_typing
    • ij_continuation_indent_size
    • ij_smart_tabs
  • Common IntelliJ IDEA language options supported by many (but not all) languages. They start with the ij_any prefix, for example, ij_any_brace_style.
  • IntelliJ IDEA language-specific options starting with the ij_<lang>_ prefix where <lang> is the language domain ID (normally a lower-case language name). For example, ij_java_blank_lines_after_imports.

Note: The same options may be defined as a common option and a language-specific option, for example, ij_<...>_brace_style. Language-specific options have higher priority over common or generic options.

Try it Out

Let’s give this feature a try using the ij_visual_guides option.

  1. In the Project view, select a source directory and select New|EditorConfig File from the context menu:create_new_editorconfig
  2. To create an empty file, do not select any properties in the dialog that opens: editorconfig_properties
  3. Add the following line: ij_visual_guides = 40,60 (once you start typing, code completion will suggest the available properties). You will immediately see visual guides painted at columns 40 and 60:editorconfig_visual_guides

Preview Code Style Settings

You can now easily preview how changes to your code style settings will impact the actual source files. To do this, click the eye icon in the left gutter of the EditorConfig file and select a source file affected by it. The preview of this file will open on the right:

editorconfig_preview_changes

You can make changes in the Preview pane to try and test how your configuration changes are reflected without worrying about making unwanted changes to the source code — all these changes are discarded when the EditorConfig file is closed.

If you’re excited to try this feature right now without having to wait for the release, download a new IntelliJ IDEA 2019.2 EAP build right now from their website or update using the ToolBox App.

Please share your thoughts and feedback in the comments section below, in our issue tracker, or on Twitter.

Happy Developing!

Topics:
java ,intellij idea ,intellij ,editorconfig ,directory ,code style ,code management

Published at DZone with permission of

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}