Switch to palantir-java-format

koppor · Nov 20, 2023 · 225a4ae · 225a4ae
1 parent 85cd85f
commit 225a4ae
Show file tree

Hide file tree

Showing 11 changed files with 176 additions and 53 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -2,5 +2,6 @@
     "java.configuration.updateBuildConfiguration": "interactive",
     "java.format.settings.url": "/config/VSCode Code Style.xml",
     "java.checkstyle.configuration": "${workspaceFolder}/config/checkstyle/checkstyle_reviewdog.xml",
-    "java.checkstyle.version": "10.3.4"
+    "java.checkstyle.version": "10.3.4",
+    "java.completion.importOrder": ["#"]
 }
diff --git a/build.gradle b/build.gradle
@@ -2,6 +2,16 @@ import org.gradle.internal.os.OperatingSystem
 import org.jabref.build.xjc.XjcPlugin
 import org.jabref.build.xjc.XjcTask
 
+buildscript {
+    repositories {
+        gradlePluginPortal()
+        mavenCentral()
+    }
+    dependencies {
+        classpath('com.palantir.javaformat:gradle-palantir-java-format:2.38.0')
+    }
+}
+
 plugins {
     id 'application'
 
@@ -22,21 +32,22 @@ plugins {
     id 'jacoco'
 
     id 'checkstyle'
+    id 'com.diffplug.spotless' version '6.22.0'
+    id 'org.openrewrite.rewrite' version '6.4.0'
 
     id 'project-report'
 
     id 'idea'
 
-    id 'org.openrewrite.rewrite' version '6.4.0'
 }
 
-// Enable following for debugging
-// gradle.startParameter.showStacktrace = org.gradle.api.logging.configuration.ShowStacktrace.
-
+apply plugin: 'com.palantir.java-format'
 apply plugin: XjcPlugin
-
 apply from: 'eclipse.gradle'
 
+// Enable following for debugging
+// gradle.startParameter.showStacktrace = org.gradle.api.logging.configuration.ShowStacktrace.
+
 group = "org.jabref"
 version = project.findProperty('projVersion') ?: '100.0.0'
 

diff --git a/config/IntelliJ Code Style.xml b/config/IntelliJ Code Style.xml
@@ -11,28 +11,20 @@
     </option>
     <option name="IMPORT_LAYOUT_TABLE">
       <value>
-        <package name="java" withSubpackages="true" static="false" />
-        <emptyLine />
-        <package name="javax" withSubpackages="true" static="false" />
-        <emptyLine />
-        <package name="javafx" withSubpackages="true" static="false" />
-        <emptyLine />
-        <package name="org.jabref" withSubpackages="true" static="false" />
+        <package name="" withSubpackages="true" static="true" />
         <emptyLine />
         <package name="" withSubpackages="true" static="false" />
-        <emptyLine />
-        <package name="" withSubpackages="true" static="true" />
       </value>
     </option>
   </JavaCodeStyleSettings>
   <codeStyleSettings language="JAVA">
+    <option name="RIGHT_MARGIN" value="255" />
     <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="0" />
     <option name="ALIGN_MULTILINE_CHAINED_METHODS" value="true" />
     <option name="SPACE_BEFORE_ARRAY_INITIALIZER_LBRACE" value="true" />
-    <option name="WRAP_COMMENTS" value="true" />
     <arrangement>
       <rules>
         <section>

diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
@@ -3,6 +3,8 @@
         "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
         "http://www.checkstyle.org/dtds/configuration_1_3.dtd">
 
+<!-- Extended version of https://github.com/jhipster/prettier-java/blob/main/docs/checkstyle/checkstyle.xml -->
+
 <module name="Checker">
     <property name="charset" value="UTF-8"/>
 
@@ -38,6 +40,8 @@
     <!-- LineLength not in place as PreviewerViewer and RelatedArticlesTab have line length with more than 500 charachters -->
 
     <module name="TreeWalker">
+        <module name="OuterTypeFilename"/>
+
         <!-- Checks for Javadoc comments: https://checkstyle.org/config_javadoc.html -->
         <module name="InvalidJavadocPosition"/>
         <module name="JavadocMethod">
@@ -53,12 +57,12 @@
         <module name="RedundantImport"/>
         <module name="AvoidStarImport"/>
         <module name="IllegalImport"/>
-        <module name="ImportOrder">
-            <property name="groups" value="java,javax,javafx,org.jabref,*"/>
-            <property name="ordered" value="true"/>
-            <property name="separated" value="true"/>
-            <property name="option" value="bottom"/>
-            <property name="sortStaticImportsAlphabetically" value="true"/>
+
+        <module name="CustomImportOrder">
+            <property name="sortImportsInGroupAlphabetically" value="true"/>
+            <property name="separateLineBetweenGroups" value="true"/>
+            <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
+            <property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/>
         </module>
 
         <!-- Checks for whitespace: https://checkstyle.org/config_whitespace.html -->
@@ -67,19 +71,53 @@
         <module name="EmptyLineSeparator">
             <!-- check all except variable declarations -->
             <property name="tokens"
-                      value="IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF, STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF"/>
+                        value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
+                            STATIC_INIT, INSTANCE_INIT, CTOR_DEF, VARIABLE_DEF, RECORD_DEF,
+                            COMPACT_CTOR_DEF"/>
             <property name="allowMultipleEmptyLines" value="false"/>
             <property name="allowMultipleEmptyLinesInsideClassMembers" value="false"/>
+            <property name="allowNoEmptyLineBetweenFields" value="true"/>
+        </module>
+        <module name="GenericWhitespace">
+        <message key="ws.followed"
+                value="GenericWhitespace ''{0}'' is followed by whitespace."/>
+        <message key="ws.preceded"
+                value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
+        <message key="ws.illegalFollow"
+                value="GenericWhitespace ''{0}'' should followed by whitespace."/>
+        <message key="ws.notPreceded"
+                value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
+        </module>
+        <module name="MethodParamPad">
+            <property name="tokens"
+                      value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
+                            SUPER_CTOR_CALL, ENUM_CONSTANT_DEF, RECORD_DEF"/>
+        </module>
+        <module name="NoLineWrap">
+            <property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/>
         </module>
-        <module name="GenericWhitespace"/>
-        <module name="MethodParamPad"/>
-        <module name="NoLineWrap"/>
         <module name="NoWhitespaceAfter"/>
-        <module name="NoWhitespaceBefore"/>
+        <module name="NoWhitespaceBefore">
+            <property name="tokens"
+                        value="COMMA, SEMI, POST_INC, POST_DEC, DOT,
+                            LABELED_STAT, METHOD_REF"/>
+            <property name="allowLineBreaks" value="true"/>
+        </module>
         <module name="ParenPad"/>
         <module name="SeparatorWrap">
             <property name="tokens" value="COMMA, SEMI, ELLIPSIS, ARRAY_DECLARATOR, RBRACK, METHOD_REF"/>
         </module>
+        <module name="SeparatorWrap">
+            <property name="id" value="SeparatorWrapDot"/>
+            <property name="tokens" value="DOT"/>
+            <property name="option" value="nl"/>
+        </module>
+        <module name="SeparatorWrap">
+            <property name="id" value="SeparatorWrapComma"/>
+            <property name="tokens" value="COMMA"/>
+            <property name="option" value="EOL"/>
+        </module>
+
         <module name="SingleSpaceSeparator"/>
         <module name="NoWhitespaceBeforeCaseDefaultColon"/>
         <module name="WhitespaceAfter"/>
@@ -135,6 +173,7 @@
         <module name="OneStatementPerLine">
             <property name="treatTryResourcesAsStatement" value="true"/>
         </module>
+        <module name="ModifierOrder"/>
 
         <module name="UnnecessarySemicolonInTryWithResources"/>
 
@@ -158,5 +197,11 @@
         <module name="IllegalIdentifierName"/>
 
         <module name="RecordTypeParameterNameCheck"/>
+
+        <module name="AnnotationLocation">
+            <property name="allowSamelineMultipleAnnotations" value="false"/>
+            <property name="allowSamelineSingleParameterlessAnnotation" value="false"/>
+            <property name="allowSamelineParameterizedAnnotation" value="false"/>
+        </module>
     </module>
 </module>
diff --git a/config/checkstyle/checkstyle_reviewdog.xml b/config/checkstyle/checkstyle_reviewdog.xml
@@ -3,6 +3,8 @@
         "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
         "http://www.checkstyle.org/dtds/configuration_1_3.dtd">
 
+<!-- Extended version of https://github.com/jhipster/prettier-java/blob/main/docs/checkstyle/checkstyle.xml -->
+
 <module name="Checker">
     <property name="charset" value="UTF-8"/>
 
@@ -15,7 +17,7 @@
     </module>
 
     <module name="BeforeExecutionExclusionFileFilter">
-        <property name="fileNamePattern" value="(module\-info|heylogs)\.java$"/>
+        <property name="fileNamePattern" value="module\-info\.java$"/>
     </module>
 
     <module name="FileTabCharacter"/>
@@ -38,6 +40,8 @@
     <!-- LineLength not in place as PreviewerViewer and RelatedArticlesTab have line length with more than 500 charachters -->
 
     <module name="TreeWalker">
+        <module name="OuterTypeFilename"/>
+
         <!-- Checks for Javadoc comments: https://checkstyle.org/config_javadoc.html -->
         <module name="InvalidJavadocPosition"/>
         <module name="JavadocMethod">
@@ -53,12 +57,12 @@
         <module name="RedundantImport"/>
         <module name="AvoidStarImport"/>
         <module name="IllegalImport"/>
-        <module name="ImportOrder">
-            <property name="groups" value="java,javax,javafx,org.jabref,*"/>
-            <property name="ordered" value="true"/>
-            <property name="separated" value="true"/>
-            <property name="option" value="bottom"/>
-            <property name="sortStaticImportsAlphabetically" value="true"/>
+
+        <module name="CustomImportOrder">
+            <property name="sortImportsInGroupAlphabetically" value="true"/>
+            <property name="separateLineBetweenGroups" value="true"/>
+            <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
+            <property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/>
         </module>
 
         <!-- Checks for whitespace: https://checkstyle.org/config_whitespace.html -->
@@ -67,19 +71,53 @@
         <module name="EmptyLineSeparator">
             <!-- check all except variable declarations -->
             <property name="tokens"
-                      value="IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF, STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF"/>
+                        value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
+                            STATIC_INIT, INSTANCE_INIT, CTOR_DEF, VARIABLE_DEF, RECORD_DEF,
+                            COMPACT_CTOR_DEF"/>
             <property name="allowMultipleEmptyLines" value="false"/>
             <property name="allowMultipleEmptyLinesInsideClassMembers" value="false"/>
+            <property name="allowNoEmptyLineBetweenFields" value="true"/>
+        </module>
+        <module name="GenericWhitespace">
+        <message key="ws.followed"
+                value="GenericWhitespace ''{0}'' is followed by whitespace."/>
+        <message key="ws.preceded"
+                value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
+        <message key="ws.illegalFollow"
+                value="GenericWhitespace ''{0}'' should followed by whitespace."/>
+        <message key="ws.notPreceded"
+                value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
+        </module>
+        <module name="MethodParamPad">
+            <property name="tokens"
+                      value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
+                            SUPER_CTOR_CALL, ENUM_CONSTANT_DEF, RECORD_DEF"/>
+        </module>
+        <module name="NoLineWrap">
+            <property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/>
         </module>
-        <module name="GenericWhitespace"/>
-        <module name="MethodParamPad"/>
-        <module name="NoLineWrap"/>
         <module name="NoWhitespaceAfter"/>
-        <module name="NoWhitespaceBefore"/>
+        <module name="NoWhitespaceBefore">
+            <property name="tokens"
+                        value="COMMA, SEMI, POST_INC, POST_DEC, DOT,
+                            LABELED_STAT, METHOD_REF"/>
+            <property name="allowLineBreaks" value="true"/>
+        </module>
         <module name="ParenPad"/>
         <module name="SeparatorWrap">
             <property name="tokens" value="COMMA, SEMI, ELLIPSIS, ARRAY_DECLARATOR, RBRACK, METHOD_REF"/>
         </module>
+        <module name="SeparatorWrap">
+            <property name="id" value="SeparatorWrapDot"/>
+            <property name="tokens" value="DOT"/>
+            <property name="option" value="nl"/>
+        </module>
+        <module name="SeparatorWrap">
+            <property name="id" value="SeparatorWrapComma"/>
+            <property name="tokens" value="COMMA"/>
+            <property name="option" value="EOL"/>
+        </module>
+
         <module name="SingleSpaceSeparator"/>
         <module name="NoWhitespaceBeforeCaseDefaultColon"/>
         <module name="WhitespaceAfter"/>
@@ -135,6 +173,7 @@
         <module name="OneStatementPerLine">
             <property name="treatTryResourcesAsStatement" value="true"/>
         </module>
+        <module name="ModifierOrder"/>
 
         <module name="UnnecessarySemicolonInTryWithResources"/>
 
@@ -158,5 +197,11 @@
         <module name="IllegalIdentifierName"/>
 
         <module name="RecordTypeParameterNameCheck"/>
+
+        <module name="AnnotationLocation">
+            <property name="allowSamelineMultipleAnnotations" value="false"/>
+            <property name="allowSamelineSingleParameterlessAnnotation" value="false"/>
+            <property name="allowSamelineParameterizedAnnotation" value="false"/>
+        </module>
     </module>
 </module>
diff --git a/...for-setting-up-a-local-workspace/guidelines-intellij-palantir-plugin-enable.png b/...for-setting-up-a-local-workspace/guidelines-intellij-palantir-plugin-enable.png
diff --git a/...or-setting-up-a-local-workspace/guidelines-intellij-palantir-plugin-install.png b/...or-setting-up-a-local-workspace/guidelines-intellij-palantir-plugin-install.png
diff --git a/...or-setting-up-a-local-workspace/guidelines-intellij-palantir-plugin-restart.png b/...or-setting-up-a-local-workspace/guidelines-intellij-palantir-plugin-restart.png