From e0754df0438c8dedc40ff58826dc2588c5f0897e Mon Sep 17 00:00:00 2001
From: Dan Caseley <dan@caseley.me.uk>
Date: Wed, 16 Jun 2021 17:48:59 +0100
Subject: [PATCH] [doc] Initial IDE config guide

---
 documentation/developer/building.md       | 13 ++++++
 resources/intellij/Smack Import Order.xml | 18 --------
 resources/intellij/smack_formatter.xml    | 51 +++++++++++++++++++++++
 3 files changed, 64 insertions(+), 18 deletions(-)
 delete mode 100644 resources/intellij/Smack Import Order.xml
 create mode 100644 resources/intellij/smack_formatter.xml

diff --git a/documentation/developer/building.md b/documentation/developer/building.md
index 84163fc7f..2e35e634b 100644
--- a/documentation/developer/building.md
+++ b/documentation/developer/building.md
@@ -48,3 +48,16 @@ git clone git@github.com:igniterealtime/Smack.git
 cd Smack
 gradle assemble
 ```
+
+IDE Config
+----------
+
+### Eclipse
+
+Import IDE settings from `./resources/eclipse/` to configure proper ordering of imports and correct formatting that should pass the CheckStyle rules.
+
+### IntelliJ IDEA
+
+Import Java Code Style settings from `./resources/intellij/smack_formatter.xml` to configure import optimisation and code formatting to pass the CheckStyle rules when building or submitting PRs.
+
+_We've noticed, at time of writing, that IntelliJ often requires a restart when applying new rules - no amount of OK/Apply will do the trick._
diff --git a/resources/intellij/Smack Import Order.xml b/resources/intellij/Smack Import Order.xml
deleted file mode 100644
index 3209e4f5f..000000000
--- a/resources/intellij/Smack Import Order.xml	
+++ /dev/null
@@ -1,18 +0,0 @@
-<code_scheme name="Smack" version="173">
-  <JavaCodeStyleSettings>
-    <option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="10000" />
-    <option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="1000" />
-    <option name="IMPORT_LAYOUT_TABLE">
-      <value>
-        <package name="" withSubpackages="true" static="true" />
-        <emptyLine />
-        <package name="java" withSubpackages="true" static="false" />
-        <package name="javax" withSubpackages="true" static="false" />
-        <emptyLine />
-        <package name="org.jivesoftware" withSubpackages="true" static="false" />
-        <emptyLine />
-        <package name="" withSubpackages="true" static="false" />
-      </value>
-    </option>
-  </JavaCodeStyleSettings>
-</code_scheme>
diff --git a/resources/intellij/smack_formatter.xml b/resources/intellij/smack_formatter.xml
new file mode 100644
index 000000000..961dda2b6
--- /dev/null
+++ b/resources/intellij/smack_formatter.xml
@@ -0,0 +1,51 @@
+<code_scheme name="Project" version="173">
+  <option name="FORMATTER_TAGS_ENABLED" value="true" />
+  <JavaCodeStyleSettings>
+    <option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="99" />
+    <option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="99" />
+    <option name="IMPORT_LAYOUT_TABLE">
+      <value>
+        <package name="" withSubpackages="true" static="true" />
+        <emptyLine />
+        <package name="java" withSubpackages="true" static="false" />
+        <package name="javax" withSubpackages="true" static="false" />
+        <emptyLine />
+        <package name="org.jivesoftware.smack" withSubpackages="true" static="false" />
+        <package name="org.jivesoftware.smackx" withSubpackages="true" static="false" />
+        <emptyLine />
+        <package name="" withSubpackages="true" static="false" />
+      </value>
+    </option>
+    <option name="JD_KEEP_EMPTY_LINES" value="false" />
+  </JavaCodeStyleSettings>
+  <codeStyleSettings language="JAVA">
+    <option name="KEEP_LINE_BREAKS" value="false" />
+    <option name="KEEP_FIRST_COLUMN_COMMENT" value="false" />
+    <option name="KEEP_CONTROL_STATEMENT_IN_ONE_LINE" value="false" />
+    <option name="KEEP_BLANK_LINES_IN_DECLARATIONS" value="1" />
+    <option name="KEEP_BLANK_LINES_IN_CODE" value="1" />
+    <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1" />
+    <option name="INDENT_CASE_FROM_SWITCH" value="false" />
+    <option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
+    <option name="ALIGN_MULTILINE_RESOURCES" value="false" />
+    <option name="SPACE_WITHIN_ARRAY_INITIALIZER_BRACES" value="true" />
+    <option name="SPACE_BEFORE_ARRAY_INITIALIZER_LBRACE" value="true" />
+    <option name="CALL_PARAMETERS_WRAP" value="1" />
+    <option name="METHOD_PARAMETERS_WRAP" value="1" />
+    <option name="RESOURCE_LIST_WRAP" value="5" />
+    <option name="EXTENDS_LIST_WRAP" value="1" />
+    <option name="THROWS_LIST_WRAP" value="1" />
+    <option name="EXTENDS_KEYWORD_WRAP" value="1" />
+    <option name="THROWS_KEYWORD_WRAP" value="1" />
+    <option name="BINARY_OPERATION_WRAP" value="1" />
+    <option name="BINARY_OPERATION_SIGN_ON_NEXT_LINE" value="true" />
+    <option name="TERNARY_OPERATION_WRAP" value="5" />
+    <option name="ARRAY_INITIALIZER_WRAP" value="1" />
+    <option name="METHOD_ANNOTATION_WRAP" value="0" />
+    <option name="CLASS_ANNOTATION_WRAP" value="0" />
+    <option name="FIELD_ANNOTATION_WRAP" value="0" />
+    <indentOptions>
+      <option name="CONTINUATION_INDENT_SIZE" value="16" />
+    </indentOptions>
+  </codeStyleSettings>
+</code_scheme>
\ No newline at end of file