opendev/gerrit
Code Issues Proposed changes

Add code style settings for IntelliJ

Browse Source 
Change-Id: Ib444fb91f19ef69218dad7a9cb8dda4f072c508f
This commit is contained in:
Alice Kober-Sotzek
2016-11-25 14:04:53 +01:00
parent 0014ea8240
commit 74d2f5b746
2 changed files with 555 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
Documentation/dev-intellij.txt
View File

@@ -43,6 +43,30 @@ it, please complete the following steps:
. Click on *Inherit project compile output path*.
. Click on *Use module compile output path*.
== Recommended settings
=== Code style
. Go to *File -> Settings -> Editor -> Code Style*.
. Click on *Manage*.
. Click on *Import*.
. Choose `IntelliJ IDEA Code Style XML`.
. Select the file `$(gerrit_source_code)/tools/intellij/Gerrit_Code_Style.xml`.
. Make sure that `Google Format (Gerrit)` is chosen as *Scheme*.
In addition, the EditorConfig settings (which ensure a consistent style between
Eclipse, IntelliJ, and other editors) should be applied on top of that. Those
settings are in the file `.editorconfig` of the Gerrit source code. IntelliJ
will automatically pick up those settings if the EditorConfig plugin is enabled
and configured correctly as can be verified by:
. Go to *File -> Settings -> Plugins*.
. Ensure that the EditorConfig plugin is enabled.
. Go to *File -> Settings -> Editor -> Code Style*.
. Ensure that *Enable EditorConfig support* is checked.
NOTE: If IntelliJ notifies you later on that the EditorConfig settings override
the code style settings, simply confirm that.
== Run configurations
Run configurations can be accessed on the toolbar. To edit them or add new ones,
choose *Edit Configurations* on the drop-down list of the run configurations