Skip to content

Commit 2bab48a

Browse files
java-team-github-botgoogle-java-format Team
authored andcommitted
Automatic code cleanup.
PiperOrigin-RevId: 906651400
1 parent ea731d2 commit 2bab48a

6 files changed

Lines changed: 28 additions & 78 deletions

File tree

core/pom.xml

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@
3939
<groupId>com.google.guava</groupId>
4040
<artifactId>guava</artifactId>
4141
</dependency>
42+
<dependency>
43+
<groupId>org.commonmark</groupId>
44+
<artifactId>commonmark</artifactId>
45+
<version>0.28.0</version>
46+
</dependency>
4247

4348
<!-- Compile-time dependencies -->
4449
<dependency>
@@ -61,16 +66,6 @@
6166
<artifactId>auto-service-annotations</artifactId>
6267
<optional>true</optional>
6368
</dependency>
64-
<dependency>
65-
<groupId>org.commonmark</groupId>
66-
<artifactId>commonmark</artifactId>
67-
<version>0.28.0</version>
68-
</dependency>
69-
<dependency>
70-
<groupId>org.commonmark</groupId>
71-
<artifactId>commonmark-ext-gfm-tables</artifactId>
72-
<version>0.28.0</version>
73-
</dependency>
7469

7570
<!-- Test dependencies -->
7671
<dependency>

core/src/main/java/com/google/googlejavaformat/java/javadoc/JavadocFormatter.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@
4444
import com.google.googlejavaformat.java.javadoc.Token.MarkdownCodeSpanStart;
4545
import com.google.googlejavaformat.java.javadoc.Token.MarkdownFencedCodeBlock;
4646
import com.google.googlejavaformat.java.javadoc.Token.MarkdownHardLineBreak;
47-
import com.google.googlejavaformat.java.javadoc.Token.MarkdownTable;
4847
import com.google.googlejavaformat.java.javadoc.Token.MoeBeginStripComment;
4948
import com.google.googlejavaformat.java.javadoc.Token.MoeEndStripComment;
5049
import com.google.googlejavaformat.java.javadoc.Token.OptionalLineBreak;
@@ -138,7 +137,6 @@ private static String render(List<Token> input, int blockIndent, boolean classic
138137
case MarkdownHardLineBreak unused -> output.writeMarkdownHardLineBreak();
139138
case Literal t -> output.writeLiteral(t);
140139
case MarkdownFencedCodeBlock t -> output.writeMarkdownFencedCodeBlock(t);
141-
case MarkdownTable t -> output.writeMarkdownTable(t);
142140
case ListItemCloseTag unused -> {}
143141
case OptionalLineBreak unused -> {}
144142
case ParagraphCloseTag unused -> {}

core/src/main/java/com/google/googlejavaformat/java/javadoc/JavadocWriter.java

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@
3535
import com.google.googlejavaformat.java.javadoc.Token.ListOpenTag;
3636
import com.google.googlejavaformat.java.javadoc.Token.Literal;
3737
import com.google.googlejavaformat.java.javadoc.Token.MarkdownFencedCodeBlock;
38-
import com.google.googlejavaformat.java.javadoc.Token.MarkdownTable;
3938
import com.google.googlejavaformat.java.javadoc.Token.MoeBeginStripComment;
4039
import com.google.googlejavaformat.java.javadoc.Token.MoeEndStripComment;
4140
import com.google.googlejavaformat.java.javadoc.Token.PreCloseTag;
@@ -45,7 +44,6 @@
4544
import com.google.googlejavaformat.java.javadoc.Token.StartOfLineToken;
4645
import com.google.googlejavaformat.java.javadoc.Token.TableCloseTag;
4746
import com.google.googlejavaformat.java.javadoc.Token.TableOpenTag;
48-
import java.util.List;
4947

5048
/**
5149
* Stateful object that accepts "requests" and "writes," producing formatted Javadoc.
@@ -356,20 +354,6 @@ void writeMarkdownFencedCodeBlock(MarkdownFencedCodeBlock token) {
356354
requestBlankLine();
357355
}
358356

359-
void writeMarkdownTable(MarkdownTable token) {
360-
if (wroteAnythingSignificant && !atStartOfLine) {
361-
requestBlankLine();
362-
}
363-
flushWhitespace();
364-
List<String> lines = token.value().lines().toList();
365-
output.append(lines.get(0));
366-
for (String line : lines.subList(1, lines.size())) {
367-
writeNewline(AutoIndent.NO_AUTO_INDENT);
368-
output.append(line);
369-
}
370-
requestBlankLine();
371-
}
372-
373357
@Override
374358
public String toString() {
375359
return output.toString();

core/src/main/java/com/google/googlejavaformat/java/javadoc/MarkdownPositions.java

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,11 @@
2828
import com.google.googlejavaformat.java.javadoc.Token.MarkdownCodeSpanEnd;
2929
import com.google.googlejavaformat.java.javadoc.Token.MarkdownCodeSpanStart;
3030
import com.google.googlejavaformat.java.javadoc.Token.MarkdownFencedCodeBlock;
31-
import com.google.googlejavaformat.java.javadoc.Token.MarkdownTable;
3231
import com.google.googlejavaformat.java.javadoc.Token.ParagraphCloseTag;
3332
import com.google.googlejavaformat.java.javadoc.Token.ParagraphOpenTag;
3433
import java.util.Objects;
3534
import java.util.regex.Matcher;
3635
import java.util.regex.Pattern;
37-
import org.commonmark.ext.gfm.tables.TableBlock;
38-
import org.commonmark.ext.gfm.tables.TablesExtension;
3936
import org.commonmark.node.BulletList;
4037
import org.commonmark.node.Code;
4138
import org.commonmark.node.FencedCodeBlock;
@@ -96,10 +93,6 @@ void visit(Node node) {
9693
case OrderedList orderedList -> addSpan(orderedList, LIST_OPEN_TOKEN, LIST_CLOSE_TOKEN);
9794
case ListItem listItem -> alreadyVisitedChildren = visitListItem(listItem);
9895
case FencedCodeBlock fencedCodeBlock -> visitFencedCodeBlock(fencedCodeBlock);
99-
case TableBlock tableBlock -> {
100-
visitTableBlock(tableBlock);
101-
alreadyVisitedChildren = true;
102-
}
10396
case Code code -> visitCodeSpan(code);
10497
// TODO: others
10598
default -> {}
@@ -150,12 +143,6 @@ private void visitFencedCodeBlock(FencedCodeBlock fencedCodeBlock) {
150143
positionToToken.get(start).addLast(token);
151144
}
152145

153-
private void visitTableBlock(TableBlock tableBlock) {
154-
int start = startPosition(tableBlock);
155-
int end = endPosition(tableBlock);
156-
positionToToken.get(start).addLast(new MarkdownTable(input.substring(start, end)));
157-
}
158-
159146
private void visitCodeSpan(Code code) {
160147
int start = startPosition(code);
161148
int end = endPosition(code);
@@ -213,10 +200,7 @@ public String toString() {
213200
}
214201

215202
private static final Parser PARSER =
216-
Parser.builder()
217-
.includeSourceSpans(IncludeSourceSpans.BLOCKS_AND_INLINES)
218-
.extensions(ImmutableList.of(TablesExtension.create()))
219-
.build();
203+
Parser.builder().includeSourceSpans(IncludeSourceSpans.BLOCKS_AND_INLINES).build();
220204

221205
private static final HeaderOpenTag HEADER_OPEN_TOKEN = new HeaderOpenTag("");
222206
private static final HeaderCloseTag HEADER_CLOSE_TOKEN = new HeaderCloseTag("");

core/src/main/java/com/google/googlejavaformat/java/javadoc/Token.java

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -140,20 +140,6 @@ record MarkdownCodeSpanEnd(String value) implements Token {}
140140
record MarkdownFencedCodeBlock(String value, String start, String end, String literal)
141141
implements Token {}
142142

143-
/**
144-
* A Markdown table, like:
145-
*
146-
* {@snippet :
147-
* | foo | bar |
148-
* | --- | --- |
149-
* | baz | qux |
150-
* }
151-
*
152-
* @param value the full text of the table as it appeared in the input, including the delimiters
153-
* and the literal content.
154-
*/
155-
record MarkdownTable(String value) implements Token {}
156-
157143
/**
158144
* Whitespace that is not in a {@code <pre>} or {@code <table>} section. Whitespace includes
159145
* leading newlines, asterisks, and tabs and spaces. In the output, it is translated to newlines

core/src/test/java/com/google/googlejavaformat/java/JavadocFormattingTest.java

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1516,6 +1516,15 @@ class Test {}
15161516
doFormatTest(input, expected);
15171517
}
15181518

1519+
private void doFormatTest(String input, String expected) {
1520+
try {
1521+
String actual = formatter.formatSource(input);
1522+
assertThat(actual).isEqualTo(expected);
1523+
} catch (FormatterException e) {
1524+
throw new AssertionError(e);
1525+
}
1526+
}
1527+
15191528
@Test
15201529
public void windowsLineSeparator() throws FormatterException {
15211530
String input =
@@ -2007,37 +2016,25 @@ public void markdownTables() {
20072016
assume().that(MARKDOWN_JAVADOC_SUPPORTED).isTrue();
20082017
String input =
20092018
"""
2010-
/// Table McTableface
2011-
///
20122019
/// | foo | bar |
20132020
/// | --- | --- |
20142021
/// | baz | qux |
20152022
///
20162023
/// - |foo|bar|
20172024
/// |--:|:--|
20182025
/// |baz|qux|
2019-
///
2020-
/// - Another list.
2021-
///
2022-
/// | which | contains |
2023-
/// | ----- | -------- |
2024-
/// | a | table |
20252026
class Test {}
20262027
""";
2027-
// We don't currently try to align the column markers in the rows of the last table.
2028-
String expected = input;
2028+
// TODO: unmangle the tables
2029+
String expected =
2030+
"""
2031+
/// | foo | bar | | --- | --- | | baz | qux |
2032+
/// - |foo|bar| |--:|:--| |baz|qux|
2033+
class Test {}
2034+
""";
20292035
doFormatTest(input, expected);
20302036
}
20312037

2032-
private void doFormatTest(String input, String expected) {
2033-
try {
2034-
String actual = formatter.formatSource(input);
2035-
assertThat(actual).isEqualTo(expected);
2036-
} catch (FormatterException e) {
2037-
throw new AssertionError(e);
2038-
}
2039-
}
2040-
20412038
// TODO: b/346668798 - Test the following Markdown constructs, and make the tests work as needed.
20422039
// We can assume that the CommonMark parser correctly handles Markdown, so the question is whether
20432040
// they are subsequently mishandled by our formatting logic. So for example the CommonMark parser
@@ -2077,4 +2074,10 @@ private void doFormatTest(String input, String expected) {
20772074
//
20782075
// - Autolinks
20792076
// <http://example.com> should be preserved. https://spec.commonmark.org/0.31.2/#autolink
2077+
//
2078+
// - Tables
2079+
// | foo | bar |
2080+
// | --- | --- |
2081+
// | baz | qux |
2082+
// Probably we should just try not to mangle them. https://spec.commonmark.org/0.31.2/#tables
20802083
}

0 commit comments

Comments
 (0)