improve formatter configuration (openapi-processor/openapi-processor-spring#331)

Author: hauner

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/EclipseFormatter.kt

@@ -6,15 +6,17 @@
 package io.openapiprocessor.core.writer.java
 
 import io.openapiprocessor.core.writer.SourceFormatter
-import org.eclipse.jdt.core.formatter.CodeFormatter
 import org.eclipse.jdt.core.ToolFactory
+import org.eclipse.jdt.core.formatter.CodeFormatter
+import org.eclipse.jdt.core.formatter.DefaultCodeFormatterConstants
 import org.eclipse.jface.text.Document
 import java.io.StringReader
 import java.util.*
-import java.util.stream.Collectors
 
 
-class EclipseFormatter: SourceFormatter {
+private const val LINE_SEPARATOR = "\n"
+
+class EclipseFormatter : SourceFormatter {
     private lateinit var formatter: CodeFormatter
 
     init {
@@ -29,46 +31,41 @@ class EclipseFormatter: SourceFormatter {
                 0,
                 raw.length,
                 0,
-                "\n"
+                LINE_SEPARATOR
             )
 
             val document = Document(raw)
             textEdit.apply(document)
 
-            return correctEndOfFile(document.get())
+            val text =  document.get()
+            val trimmed = trimEnd(text)
+            return trimmed
+
         } catch (e: Exception) {
             throw FormattingException("failed to format the generated source: \n>>\n$raw\n<<", e)
         }
     }
 
-    private fun correctEndOfFile(formatted: String): String {
-        return StringBuilder()
-            .append(formatted)
-            .append("\n")
-            .toString()
+    fun trimEnd(source: String): String {
+        return source.lines()
+            .joinToString(LINE_SEPARATOR) {
+                it.trimEnd()
+            }
     }
 
     private fun initFormatter() {
-        formatter = ToolFactory.createCodeFormatter(convertOptions(loadStyleOptions()))
+        formatter = ToolFactory.createCodeFormatter(loadStyleOptions())
     }
 
-    private fun loadStyleOptions(): Properties {
+    private fun loadStyleOptions(): Map<String, String> {
+        val conventions = DefaultCodeFormatterConstants.getJavaConventionsSettings()
         val content = this.javaClass.getResource("/formatter.properties")!!.readText()
         val reader = StringReader(content)
         val properties = Properties()
         properties.load(reader)
-        return properties
-    }
 
-    private fun convertOptions(prop: Properties): HashMap<String, String> {
-        return prop.entries
-            .stream()
-            .collect(
-                Collectors.toMap(
-                    { e -> e.toString() },
-                    { v -> v.toString() },
-                    { _, next -> next })
-                { HashMap() }
-            )
+        conventions.putAll(properties as Map<out String, String>)
+
+        return conventions
     }
 }

openapi-processor-core/src/main/resources/formatter.properties

@@ -1,3 +1,14 @@
-org.eclipse.jdt.core.compiler.source = 1.8
+#org.eclipse.jdt.core.compiler.source = 14
+#org.eclipse.jdt.core.compiler.compliance = 14
+
+org.eclipse.jdt.core.formatter.lineSplit = 120
 org.eclipse.jdt.core.formatter.tabulation.char = space
-org.eclipse.jdt.core..formatter.tabulation.size = 4
+org.eclipse.jdt.core.formatter.tabulation.size = 4
+org.eclipse.jdt.core.formatter.alignment_for_enum_constants = 49
+org.eclipse.jdt.core.formatter.comment.format_javadoc_comments = true
+org.eclipse.jdt.core.formatter.comment.insert_new_line_for_parameter = do not insert
+org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_javadoc_comment = true
+
+org.eclipse.jdt.core.formatter.alignment_for_record_components = 52
+org.eclipse.jdt.core.formatter.keep_record_declaration_on_one_line = one_line_if_empty
+org.eclipse.jdt.core.formatter.parentheses_positions_in_record_declaration = separate_lines_if_wrapped

openapi-processor-core/src/testInt/kotlin/io/openapiprocessor/core/ProcessorTestSets.kt

@@ -21,6 +21,7 @@ val ALL_30: List<TestParams> = listOf(
     test30_D_("endpoint-exclude"),
     test30_D_("endpoint-http-mapping"), // framework specific
     test30_DR("extension-mapping"),
+    test30_DR("format-eclipse"),
     test30_DR("generated"),
     test30_DR("javadoc"),
     test30_DR("javadoc-with-mapping"),
@@ -97,6 +98,7 @@ val ALL_31: List<TestParams> = listOf(
     test31_D_("bean-validation-requestbody-mapping"),
     test31_DR("components-requestbodies"),
     test31_DR("extension-mapping"),
+    test31_DR("format-eclipse"),
     test31_DR("deprecated"),
     test31_D_("endpoint-exclude"),
     test31_D_("endpoint-http-mapping"), // framework specific

openapi-processor-core/src/testInt/resources/tests/format-eclipse/inputs.yaml

@@ -0,0 +1,4 @@
+items:
+  - inputs/openapi30.yaml
+  - inputs/openapi31.yaml
+  - inputs/mapping.yaml

openapi-processor-core/src/testInt/resources/tests/format-eclipse/inputs/mapping.yaml

@@ -0,0 +1,6 @@
+openapi-processor-mapping: v11
+
+options:
+  package-name: generated
+  format-code: eclipse
+  javadoc: true

openapi-processor-core/src/testInt/resources/tests/format-eclipse/inputs/openapi30.yaml

@@ -0,0 +1,72 @@
+openapi: 3.0.3
+info:
+  title: test javadoc
+  version: 1.0.0
+
+paths:
+  /foo:
+    get:
+      description: |
+          a *markdown* description with **text**
+
+          - one list item
+          - second list item
+
+          ```
+          code block
+          ```
+
+          more
+
+      parameters:
+        - name: f-o-o
+          description: this is a *parameter* description
+          example: this is an example
+          in: query
+          schema:
+            $ref: '#/components/schemas/Foo'
+        - name: bar
+          description: this is another *parameter* description
+          example: this is another example
+          in: query
+          schema:
+            type: string
+      requestBody:
+        description: this is the request body
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/Foo'
+        required: true
+      responses:
+        '200':
+          description: this is a *response* description
+          content:
+            application/json:
+                schema:
+                  $ref: '#/components/schemas/Foo'
+
+components:
+  schemas:
+
+    Foo:
+      description: >
+        this is the *Foo* schema description
+      type: object
+      properties:
+        foo-bar:
+          description: >
+            *property* description
+          type: string
+        enum:
+          # actually OpenAPI 3.0 doesn't allow this, but it is easier to support it instead of being strict.
+          description: >
+            enum *property* description
+          $ref: '#/components/schemas/FooEnum'
+
+    FooEnum:
+        description: "this is an *enum* description"
+        type: string
+        enum: ['foo', 'bar']

openapi-processor-core/src/testInt/resources/tests/format-eclipse/inputs/openapi31.yaml

@@ -0,0 +1,71 @@
+openapi: 3.1.0
+info:
+  title: test javadoc
+  version: 1.0.0
+
+paths:
+  /foo:
+    get:
+      description: |
+          a *markdown* description with **text**
+
+          - one list item
+          - second list item
+
+          ```
+          code block
+          ```
+
+          more
+
+      parameters:
+        - name: f-o-o
+          description: this is a *parameter* description
+          example: this is an example
+          in: query
+          schema:
+            $ref: '#/components/schemas/Foo'
+        - name: bar
+          description: this is another *parameter* description
+          example: this is another example
+          in: query
+          schema:
+            type: string
+      requestBody:
+        description: this is the request body
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/Foo'
+        required: true
+      responses:
+        '200':
+          description: this is a *response* description
+          content:
+            application/json:
+                schema:
+                  $ref: '#/components/schemas/Foo'
+
+components:
+  schemas:
+
+    Foo:
+      description: >
+        this is the *Foo* schema description
+      type: object
+      properties:
+        foo-bar:
+          description: >
+            *property* description
+          type: string
+        enum:
+          description: >
+            enum *property* description
+          $ref: '#/components/schemas/FooEnum'
+
+    FooEnum:
+        description: "this is an *enum* description"
+        type: string
+        enum: ['foo', 'bar']

openapi-processor-core/src/testInt/resources/tests/format-eclipse/outputs.yaml

@@ -0,0 +1,4 @@
+items:
+  - outputs/api/Api.java
+  - outputs/<model>/Foo.java
+  - outputs/<model>/FooEnum.java

openapi-processor-core/src/testInt/resources/tests/format-eclipse/outputs/api/Api.java

@@ -0,0 +1,33 @@
+package generated.api;
+
+import annotation.Mapping;
+import annotation.Parameter;
+import generated.model.Foo;
+import generated.support.Generated;
+
+@Generated(value = "openapi-processor-core", version = "test")
+public interface Api {
+
+    /**
+     * a <em>markdown</em> description with <strong>text</strong>
+     * <ul>
+     * <li>one list item</li>
+     * <li>second list item</li>
+     * </ul>
+     *
+     * <pre>
+     * <code>code block
+     * </code>
+     * </pre>
+     *
+     * more
+     *
+     * @param fOO  this is a <em>parameter</em> description
+     * @param bar  this is another <em>parameter</em> description
+     * @param body this is the request body
+     * @return this is a <em>response</em> description
+     */
+    @Mapping("/foo")
+    Foo getFoo(@Parameter Foo fOO, @Parameter String bar, @Parameter Foo[] body);
+
+}

openapi-processor-core/src/testInt/resources/tests/format-eclipse/outputs/model/default/Foo.java

@@ -0,0 +1,40 @@
+package generated.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import generated.support.Generated;
+
+/**
+ * this is the <em>Foo</em> schema description
+ */
+@Generated(value = "openapi-processor-core", version = "test")
+public class Foo {
+
+    /**
+     * <em>property</em> description
+     */
+    @JsonProperty("foo-bar")
+    private String fooBar;
+
+    /**
+     * enum <em>property</em> description
+     */
+    @JsonProperty("enum")
+    private FooEnum aEnum;
+
+    public String getFooBar() {
+        return fooBar;
+    }
+
+    public void setFooBar(String fooBar) {
+        this.fooBar = fooBar;
+    }
+
+    public FooEnum getEnum() {
+        return aEnum;
+    }
+
+    public void setEnum(FooEnum aEnum) {
+        this.aEnum = aEnum;
+    }
+
+}

openapi-processor-core/src/testInt/resources/tests/format-eclipse/outputs/model/default/FooEnum.java

@@ -0,0 +1,35 @@
+package generated.model;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+import generated.support.Generated;
+
+/**
+ * this is an <em>enum</em> description
+ */
+@Generated(value = "openapi-processor-core", version = "test")
+public enum FooEnum {
+    FOO("foo"),
+    BAR("bar");
+
+    private final String value;
+
+    FooEnum(String value) {
+        this.value = value;
+    }
+
+    @JsonValue
+    public String getValue() {
+        return this.value;
+    }
+
+    @JsonCreator
+    public static FooEnum fromValue(String value) {
+        for (FooEnum val : FooEnum.values()) {
+            if (val.value.equals(value)) {
+                return val;
+            }
+        }
+        throw new IllegalArgumentException(value);
+    }
+}