Add flag control for javadoc formatting

cushon · cpovirk · commit 8df44e5994c9 · 2019-11-12T09:50:54.000-05:00
Fixes #139, #149 ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=279811849
diff --git a/core/src/main/java/com/google/googlejavaformat/java/CommandLineOptions.java b/core/src/main/java/com/google/googlejavaformat/java/CommandLineOptions.java
@@ -42,6 +42,7 @@ final class CommandLineOptions {
   private final boolean setExitIfChanged;
   private final Optional<String> assumeFilename;
   private final boolean reflowLongStrings;
+  private final boolean formatJavadoc;
 
   CommandLineOptions(
       ImmutableList<String> files,
@@ -59,7 +60,8 @@ final class CommandLineOptions {
       boolean dryRun,
       boolean setExitIfChanged,
       Optional<String> assumeFilename,
-      boolean reflowLongStrings) {
+      boolean reflowLongStrings,
+      boolean formatJavadoc) {
     this.files = files;
     this.inPlace = inPlace;
     this.lines = lines;
@@ -76,6 +78,7 @@ final class CommandLineOptions {
     this.setExitIfChanged = setExitIfChanged;
     this.assumeFilename = assumeFilename;
     this.reflowLongStrings = reflowLongStrings;
+    this.formatJavadoc = formatJavadoc;
   }
 
   /** The files to format. */
@@ -164,6 +167,10 @@ boolean isSelection() {
     return !lines().isEmpty() || !offsets().isEmpty() || !lengths().isEmpty();
   }
 
+  boolean formatJavadoc() {
+    return formatJavadoc;
+  }
+
   static Builder builder() {
     return new Builder();
   }
@@ -186,6 +193,7 @@ static class Builder {
     private boolean setExitIfChanged = false;
     private Optional<String> assumeFilename = Optional.empty();
     private boolean reflowLongStrings = true;
+    private boolean formatJavadoc = true;
 
     ImmutableList.Builder<String> filesBuilder() {
       return files;
@@ -265,6 +273,11 @@ Builder reflowLongStrings(boolean reflowLongStrings) {
       return this;
     }
 
+    Builder formatJavadoc(boolean formatJavadoc) {
+      this.formatJavadoc = formatJavadoc;
+      return this;
+    }
+
     CommandLineOptions build() {
       return new CommandLineOptions(
           files.build(),
@@ -282,7 +295,8 @@ CommandLineOptions build() {
           dryRun,
           setExitIfChanged,
           assumeFilename,
-          reflowLongStrings);
+          reflowLongStrings,
+          formatJavadoc);
     }
   }
 }
diff --git a/core/src/main/java/com/google/googlejavaformat/java/CommandLineOptionsParser.java b/core/src/main/java/com/google/googlejavaformat/java/CommandLineOptionsParser.java
@@ -108,6 +108,9 @@ static CommandLineOptions parse(Iterable<String> options) {
         case "--skip-reflowing-long-strings":
           optionsBuilder.reflowLongStrings(false);
           break;
+        case "--skip-javadoc-formatting":
+          optionsBuilder.formatJavadoc(false);
+          break;
         case "-":
           optionsBuilder.stdin(true);
           break;
diff --git a/core/src/main/java/com/google/googlejavaformat/java/JavaCommentsHelper.java b/core/src/main/java/com/google/googlejavaformat/java/JavaCommentsHelper.java
@@ -30,9 +30,11 @@
 public final class JavaCommentsHelper implements CommentsHelper {
 
   private final String lineSeparator;
+  private final JavaFormatterOptions options;
 
   public JavaCommentsHelper(String lineSeparator, JavaFormatterOptions options) {
     this.lineSeparator = lineSeparator;
+    this.options = options;
   }
 
   @Override
@@ -41,7 +43,7 @@ public String rewrite(Tok tok, int maxWidth, int column0) {
       return tok.getOriginalText();
     }
     String text = tok.getOriginalText();
-    if (tok.isJavadocComment()) {
+    if (tok.isJavadocComment() && options.formatJavadoc()) {
       text = JavadocFormatter.formatJavadoc(text, column0);
     }
     List<String> lines = new ArrayList<>();
diff --git a/core/src/main/java/com/google/googlejavaformat/java/JavaFormatterOptions.java b/core/src/main/java/com/google/googlejavaformat/java/JavaFormatterOptions.java
@@ -48,16 +48,22 @@ int indentationMultiplier() {
   }
 
   private final Style style;
+  private final boolean formatJavadoc;
 
-  private JavaFormatterOptions(Style style) {
+  private JavaFormatterOptions(Style style, boolean formatJavadoc) {
     this.style = style;
+    this.formatJavadoc = formatJavadoc;
   }
 
   /** Returns the multiplier for the unit of indent. */
   public int indentationMultiplier() {
     return style.indentationMultiplier();
   }
 
+  boolean formatJavadoc() {
+    return formatJavadoc;
+  }
+
   /** Returns the code style. */
   public Style style() {
     return style;
@@ -76,6 +82,7 @@ public static Builder builder() {
   /** A builder for {@link JavaFormatterOptions}. */
   public static class Builder {
     private Style style = Style.GOOGLE;
+    private boolean formatJavadoc = true;
 
     private Builder() {}
 
@@ -84,8 +91,13 @@ public Builder style(Style style) {
       return this;
     }
 
+    Builder formatJavadoc(boolean formatJavadoc) {
+      this.formatJavadoc = formatJavadoc;
+      return this;
+    }
+
     public JavaFormatterOptions build() {
-      return new JavaFormatterOptions(style);
+      return new JavaFormatterOptions(style, formatJavadoc);
     }
   }
 }
diff --git a/core/src/main/java/com/google/googlejavaformat/java/Main.java b/core/src/main/java/com/google/googlejavaformat/java/Main.java
@@ -96,7 +96,10 @@ public int format(String... args) throws UsageException {
     }
 
     JavaFormatterOptions options =
-        JavaFormatterOptions.builder().style(parameters.aosp() ? Style.AOSP : Style.GOOGLE).build();
+        JavaFormatterOptions.builder()
+            .style(parameters.aosp() ? Style.AOSP : Style.GOOGLE)
+            .formatJavadoc(parameters.formatJavadoc())
+            .build();
 
     if (parameters.stdin()) {
       return formatStdin(parameters, options);
diff --git a/core/src/main/java/com/google/googlejavaformat/java/UsageException.java b/core/src/main/java/com/google/googlejavaformat/java/UsageException.java
@@ -48,6 +48,8 @@ final class UsageException extends Exception {
     "    Do not remove unused imports. Imports will still be sorted.",
     " . --skip-reflowing-long-strings",
     "    Do not reflow string literals that exceed the column limit.",
+    " . --skip-javadoc-formatting",
+    "    Do not reformat javadoc.",
     "  --dry-run, -n",
     "    Prints the paths of the files whose contents would change if the formatter were run"
         + " normally.",
diff --git a/core/src/test/java/com/google/googlejavaformat/java/CommandLineOptionsParserTest.java b/core/src/test/java/com/google/googlejavaformat/java/CommandLineOptionsParserTest.java
@@ -54,6 +54,7 @@ public void defaults() {
     assertThat(options.dryRun()).isFalse();
     assertThat(options.setExitIfChanged()).isFalse();
     assertThat(options.reflowLongStrings()).isTrue();
+    assertThat(options.formatJavadoc()).isTrue();
   }
 
   @Test
@@ -195,4 +196,12 @@ public void skipReflowLongStrings() {
                 .reflowLongStrings())
         .isFalse();
   }
+
+  @Test
+  public void skipJavadocFormatting() {
+    assertThat(
+            CommandLineOptionsParser.parse(Arrays.asList("--skip-javadoc-formatting"))
+                .formatJavadoc())
+        .isFalse();
+  }
 }
diff --git a/core/src/test/java/com/google/googlejavaformat/java/MainTest.java b/core/src/test/java/com/google/googlejavaformat/java/MainTest.java
@@ -565,4 +565,34 @@ public void noReflowLongStrings() throws Exception {
     assertThat(main.format("--skip-reflowing-long-strings", "-")).isEqualTo(0);
     assertThat(out.toString()).isEqualTo(joiner.join(expected));
   }
+
+  @Test
+  public void noFormatJavadoc() throws Exception {
+    String[] input = {
+      "/**",
+      " * graph",
+      " *",
+      " * graph",
+      " *",
+      " * @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",
+      "   */",
+      "  public static void main(String... args) {}",
+      "}",
+      "",
+    };
+    InputStream in = new ByteArrayInputStream(joiner.join(input).getBytes(UTF_8));
+    StringWriter out = new StringWriter();
+    Main main =
+        new Main(
+            new PrintWriter(out, true),
+            new PrintWriter(new BufferedWriter(new OutputStreamWriter(System.err, UTF_8)), true),
+            in);
+    assertThat(main.format("--skip-javadoc-formatting", "-")).isEqualTo(0);
+    assertThat(out.toString()).isEqualTo(joiner.join(input));
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -30,9 +30,11 @@`
`30`	`30`	`public final class JavaCommentsHelper implements CommentsHelper {`
`31`	`31`
`32`	`32`	`private final String lineSeparator;`
	`33`	`+ private final JavaFormatterOptions options;`
`33`	`34`
`34`	`35`	`public JavaCommentsHelper(String lineSeparator, JavaFormatterOptions options) {`
`35`	`36`	`this.lineSeparator = lineSeparator;`
	`37`	`+ this.options = options;`
`36`	`38`	`}`
`37`	`39`
`38`	`40`	`@Override`
`@@ -41,7 +43,7 @@ public String rewrite(Tok tok, int maxWidth, int column0) {`
`41`	`43`	`return tok.getOriginalText();`
`42`	`44`	`}`
`43`	`45`	`String text = tok.getOriginalText();`
`44`		`- if (tok.isJavadocComment()) {`
	`46`	`+ if (tok.isJavadocComment() && options.formatJavadoc()) {`
`45`	`47`	`text = JavadocFormatter.formatJavadoc(text, column0);`
`46`	`48`	`}`
`47`	`49`	`List<String> lines = new ArrayList<>();`
Original file line number	Diff line number	Diff line change
`@@ -48,16 +48,22 @@ int indentationMultiplier() {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`private final Style style;`
	`51`	`+ private final boolean formatJavadoc;`
`51`	`52`
`52`		`- private JavaFormatterOptions(Style style) {`
	`53`	`+ private JavaFormatterOptions(Style style, boolean formatJavadoc) {`
`53`	`54`	`this.style = style;`
	`55`	`+ this.formatJavadoc = formatJavadoc;`
`54`	`56`	`}`
`55`	`57`
`56`	`58`	`/** Returns the multiplier for the unit of indent. */`
`57`	`59`	`public int indentationMultiplier() {`
`58`	`60`	`return style.indentationMultiplier();`
`59`	`61`	`}`
`60`	`62`
	`63`	`+ boolean formatJavadoc() {`
	`64`	`+ return formatJavadoc;`
	`65`	`+ }`
	`66`	`+`
`61`	`67`	`/** Returns the code style. */`
`62`	`68`	`public Style style() {`
`63`	`69`	`return style;`
`@@ -76,6 +82,7 @@ public static Builder builder() {`
`76`	`82`	`/** A builder for {@link JavaFormatterOptions}. */`
`77`	`83`	`public static class Builder {`
`78`	`84`	`private Style style = Style.GOOGLE;`
	`85`	`+ private boolean formatJavadoc = true;`
`79`	`86`
`80`	`87`	`private Builder() {}`
`81`	`88`
`@@ -84,8 +91,13 @@ public Builder style(Style style) {`
`84`	`91`	`return this;`
`85`	`92`	`}`
`86`	`93`
	`94`	`+ Builder formatJavadoc(boolean formatJavadoc) {`
	`95`	`+ this.formatJavadoc = formatJavadoc;`
	`96`	`+ return this;`
	`97`	`+ }`
	`98`	`+`
`87`	`99`	`public JavaFormatterOptions build() {`
`88`		`- return new JavaFormatterOptions(style);`
	`100`	`+ return new JavaFormatterOptions(style, formatJavadoc);`
`89`	`101`	`}`
`90`	`102`	`}`
`91`	`103`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,7 @@ public void defaults() {`
`54`	`54`	`assertThat(options.dryRun()).isFalse();`
`55`	`55`	`assertThat(options.setExitIfChanged()).isFalse();`
`56`	`56`	`assertThat(options.reflowLongStrings()).isTrue();`
	`57`	`+ assertThat(options.formatJavadoc()).isTrue();`
`57`	`58`	`}`
`58`	`59`
`59`	`60`	`@Test`
`@@ -195,4 +196,12 @@ public void skipReflowLongStrings() {`
`195`	`196`	`.reflowLongStrings())`
`196`	`197`	`.isFalse();`
`197`	`198`	`}`
	`199`	`+`
	`200`	`+ @Test`
	`201`	`+ public void skipJavadocFormatting() {`
	`202`	`+ assertThat(`
	`203`	`+ CommandLineOptionsParser.parse(Arrays.asList("--skip-javadoc-formatting"))`
	`204`	`+ .formatJavadoc())`
	`205`	`+ .isFalse();`
	`206`	`+ }`
`198`	`207`	`}`