Turn off the JavadocComment (#152)

Turn off the javadoc formatter entirely. We still indent the javadoc prefix to the corect column, but don't do any code reflowing or HTML tag correction anymore.
palantir · Jan 28, 2020 · 56c4824 · 56c4824
1 parent b194b37
commit 56c4824
Show file tree

Hide file tree

Showing 27 changed files with 133 additions and 361 deletions.
diff --git a/changelog/@unreleased/pr-152.v2.yml b/changelog/@unreleased/pr-152.v2.yml
@@ -0,0 +1,5 @@
+type: improvement
+improvement:
+  description: Turn off the javadoc formatter entirely.
+  links:
+  - https://github.com/palantir/palantir-java-format/pull/152
diff --git a/palantir-java-format/src/main/java/com/palantir/javaformat/java/Formatter.java b/palantir-java-format/src/main/java/com/palantir/javaformat/java/Formatter.java
@@ -93,20 +93,26 @@ public final class Formatter {
 
     private final JavaFormatterOptions options;
     private final boolean debugMode;
+    private final JavaFormatterInternalOptions internalOptions;
 
     @VisibleForTesting
-    Formatter(JavaFormatterOptions options, boolean debugMode) {
+    Formatter(JavaFormatterOptions options, boolean debugMode, JavaFormatterInternalOptions internalOptions) {
         this.options = options;
         this.debugMode = debugMode;
+        this.internalOptions = internalOptions;
     }
 
     /** A new Formatter instance with default options. */
     public static Formatter create() {
-        return new Formatter(JavaFormatterOptions.defaultOptions(), false);
+        return new Formatter(
+                JavaFormatterOptions.defaultOptions(),
+                false,
+                JavaFormatterInternalOptions.builder().build());
     }
 
     public static Formatter createFormatter(JavaFormatterOptions options) {
-        return new Formatter(options, false);
+        return new Formatter(
+                options, false, JavaFormatterInternalOptions.builder().build());
     }
 
     /**
@@ -273,7 +279,8 @@ public ImmutableList<Replacement> getFormatReplacements(String input, Collection
         // 'de-linting' changes (e.g. import ordering).
         javaInput = ModifierOrderer.reorderModifiers(javaInput, characterRanges);
 
-        JavaCommentsHelper commentsHelper = new JavaCommentsHelper(javaInput.getLineSeparator(), options);
+        JavaCommentsHelper commentsHelper =
+                new JavaCommentsHelper(javaInput.getLineSeparator(), options, internalOptions);
         JavaOutput javaOutput;
         try {
             javaOutput = format(javaInput, options, commentsHelper, debugMode);

diff --git a/palantir-java-format/src/main/java/com/palantir/javaformat/java/JavaCommentsHelper.java b/palantir-java-format/src/main/java/com/palantir/javaformat/java/JavaCommentsHelper.java
@@ -33,10 +33,12 @@ public final class JavaCommentsHelper implements CommentsHelper {
     private final JavaFormatterOptions options;
     private final JavadocFormatter javadocFormatter;
 
-    public JavaCommentsHelper(String lineSeparator, JavaFormatterOptions options) {
+    public JavaCommentsHelper(
+            String lineSeparator, JavaFormatterOptions options, JavaFormatterInternalOptions internalOptions) {
         this.lineSeparator = lineSeparator;
         this.options = options;
-        this.javadocFormatter = new JavadocFormatter(options.maxLineLength());
+        this.javadocFormatter =
+                internalOptions.reformatJavadoc() ? new JavadocFormatter(options.maxLineLength()) : null;
     }
 
     @Override
@@ -45,7 +47,7 @@ public String rewrite(Tok tok, int maxWidth, int column0) {
             return tok.getOriginalText();
         }
         String text = tok.getOriginalText();
-        if (tok.isJavadocComment()) {
+        if (javadocFormatter != null && tok.isJavadocComment()) {
             text = javadocFormatter.formatJavadoc(text, column0);
         }
         List<String> lines = new ArrayList<>();

diff --git a/...-java-format/src/main/java/com/palantir/javaformat/java/JavaFormatterInternalOptions.java b/...-java-format/src/main/java/com/palantir/javaformat/java/JavaFormatterInternalOptions.java
@@ -0,0 +1,20 @@
+package com.palantir.javaformat.java;
+
+import com.google.errorprone.annotations.Immutable;
+import org.immutables.value.Value;
+
+@Value.Immutable
+@Immutable
+interface JavaFormatterInternalOptions {
+
+    @Value.Default
+    default boolean reformatJavadoc() {
+        return false;
+    }
+
+    class Builder extends ImmutableJavaFormatterInternalOptions.Builder {}
+
+    static Builder builder() {
+        return new Builder();
+    }
+}
diff --git a/palantir-java-format/src/main/java/com/palantir/javaformat/java/SnippetFormatter.java b/palantir-java-format/src/main/java/com/palantir/javaformat/java/SnippetFormatter.java
diff --git a/...ntir-java-format/src/test/java/com/palantir/javaformat/java/FormatterIntegrationTest.java b/...ntir-java-format/src/test/java/com/palantir/javaformat/java/FormatterIntegrationTest.java
@@ -85,7 +85,8 @@ private static Formatter createFormatter() {
                 JavaFormatterOptions.builder()
                         .style(JavaFormatterOptions.Style.PALANTIR)
                         .build(),
-                isDebugMode());
+                isDebugMode(),
+                JavaFormatterInternalOptions.builder().build());
     }
 
     @TestTemplate

diff --git a/palantir-java-format/src/test/java/com/palantir/javaformat/java/JavadocFormattingTest.java b/palantir-java-format/src/test/java/com/palantir/javaformat/java/JavadocFormattingTest.java
@@ -28,9 +28,12 @@
 @Execution(ExecutionMode.CONCURRENT)
 public final class JavadocFormattingTest {
 
-    private final Formatter formatter = Formatter.createFormatter(JavaFormatterOptions.builder()
-            .style(JavaFormatterOptions.Style.GOOGLE)
-            .build());
+    private final Formatter formatter = new Formatter(
+            JavaFormatterOptions.builder()
+                    .style(JavaFormatterOptions.Style.GOOGLE)
+                    .build(),
+            false,
+            JavaFormatterInternalOptions.builder().reformatJavadoc(true).build());
 
     @Test
     public void notJavadoc() {

diff --git a/palantir-java-format/src/test/java/com/palantir/javaformat/java/MainTest.java b/palantir-java-format/src/test/java/com/palantir/javaformat/java/MainTest.java
@@ -142,13 +142,15 @@ public void javadoc() throws Exception {
             "/**",
             " * graph",
             " *",
-            " * <p>graph",
+            " * graph",
             " *",
-            " * @param foo lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do" + " eiusmod tempor",
-            " *     incididunt ut labore et dolore magna aliqua",
+            " * @param foo lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do"
+                    + " eiusmod tempor incididunt ut labore et dolore magna aliqua",
             " */",
             "class Test {",
-            "  /** creates entropy */",
+            "  /**",
+            "   * creates entropy",
+            "   */",
             "  public static void main(String... args) {}",
             "}",
             "",