`Spotless` formatting #2524

MaicolAntali · 2023-11-04T12:20:36Z

Purpose

Adds the Spotless plugin to check that formatting follows the Google Java Style Guide

Description

Related with #2284

⚠️ This is a daft PR to discuss the configuration and how run it (in a new workflow or use the build workflow).
(I have applied some default configurations)

Checklist

New code follows the Google Java Style Guide
If necessary, new public API validates arguments, for example rejects null
New public API has Javadoc
- Javadoc uses @since $next-version$
  ( $next-version$ is a special placeholder which is automatically replaced during release)
If necessary, new unit tests have been added
- Assertions in unit tests use Truth, see existing tests
- No JUnit 3 features are used (such as extending class TestCase)
- If this pull request fixes a bug, a new test was added for a situation which failed previously and is now fixed
mvn clean verify javadoc:jar passes without errors

eamonnmcmanus

Thanks, this is very helpful! Just a few comments. If mvn verify passes then I think this should be good.

pom.xml

MaicolAntali · 2023-11-04T17:10:11Z

If mvn verify passes then I think this should be good.

I thought the same thing, also because the documentation says:

By default, spotless: check is bound to verify maven phase.

Until, I executed:mvn spotless:check and some error came out. I don’t know why they don’t come out with mvn check 🤔

eamonnmcmanus · 2023-11-04T17:18:38Z

Until, I executed:mvn spotless:check and some error came out. I don’t know why they don’t come out with mvn check 🤔

Well, can you temporarily introduce a deliberate formatting error into the PR, and verify that the CI fails?

gson/src/main/java/com/google/gson/Gson.java

Moves the `spotless` plugin out of `<pluginManagement>`

MaicolAntali · 2023-11-04T18:27:32Z

For the first time, I'm happy that CI fails 🤣

I will run mvn spotless:apply, check that every changes is correct and then I'll commit the changes.

pom.xml

Marcono1234 · 2023-11-05T20:43:17Z

pom.xml

+          <formats>
+            <format>
+              <includes>
+                <include>*.md</include>
+                <include>.gitignore</include>
+              </includes>
+              <trimTrailingWhitespace/>
+              <endWithNewline/>
+              <indent>
+                <spaces>true</spaces>
+                <spacesPerTab>4</spacesPerTab>
+              </indent>
+            </format>
+          </formats>


Is this <formats> section needed? If I understand it correctly that would only apply to *.md and .gitignore the way it is currently configured; and I am not sure if we should impose any formatting rules on them.

Formatting rules are very weak on.md and .gitignore. They replace tab characters with 4 spaces and trim trailing whitespace.

I think they are good general rules, but if you prefer to remove them, let me know.

Ok, I just asked because this section looked like the section from the Spotless examples and it isn't needed for Java formatting.

The combination of *.md with trimTrailingWhitespace should be removed though because they can break Markdown formatting. Arguably the Spotless examples are also flawed (diffplug/spotless#1877).

Edit: Nevermind, if the Markdown files are consistently using a trailing \ instead of two spaces for a hard line break, then it should be fine to remove trailing whitespace. But it might be good to add a comment here mentioning that a trailing \ can be used instead of trailing whitespace in Markdown files.

gson/src/main/java/com/google/gson/JsonNull.java

+   *
+   * @since 1.8
+   */
+  public static final JsonNull INSTANCE = new JsonNull();


gson/src/main/java/com/google/gson/Gson.java

gson/src/main/java/com/google/gson/GsonBuilder.java

gson/src/main/java/com/google/gson/JsonObject.java

gson/src/main/java/com/google/gson/internal/bind/util/ISO8601Utils.java

MaicolAntali · 2023-11-06T10:49:23Z

I'm not sure why the Build fails.
If I run mvn clean verify javadoc:jar on my machine, everything works fine

eamonnmcmanus · 2023-11-06T16:22:51Z

It's great to see this progress!

A couple of things. First, I think reformatting the existing files should be a separate PR from the one that adds the Spotless plugin. Second, I'm pretty sure the CI failure is because Java17RecordTest uses Java record, and in the JDK 11 configuration that doesn't work. You could reasonably exclude that one file from formatting.

MaicolAntali · 2023-11-06T17:02:10Z

Make sense, I reverted the formatting commits and I will move it in a new PR (when this PR will be merged, so I can edit the pom.xml to exclude Java17RecordTest)

eamonnmcmanus · 2023-11-06T18:15:54Z

Make sense, I reverted the formatting commits and I will move it in a new PR (when this PR will be merged, so I can edit the pom.xml to exclude Java17RecordTest)

I think you need to merge that PR first, so that you won't get errors from this one?

…ss-formatting # Conflicts: # pom.xml

MaicolAntali · 2023-11-06T20:45:09Z

All CI passed, but I think is better have a more tidy commits history.
Tomorrow:

I will move edde156 commit in a single PR
I'll create a new PR to apply the spotless plugin.

And I'll close this PR.
I hope that will help to obtain a more tidy and clear commits history

Marcono1234 · 2023-11-06T21:48:18Z

@eamonnmcmanus if possible please wait a bit with merging this (or any related formatting PR). #2531 'broke' some formatting of Markdown files which intentionally used two trailing spaces for hard line breaks, and in theory someone would have to review all the 229 files changed by the last PR (in case you haven't done so already).

I can try to revert the Markdown formatting changes (and possibly any other unintentional changes), but only in the next days.

eamonnmcmanus · 2023-11-06T22:45:09Z

I can try to revert the Markdown formatting changes (and possibly any other unintentional changes), but only in the next days.

I can do that. I will refrain from sharing my thoughts on that particular Markdown syntax, except to say that the alternative syntax with \ seems preferable.

Marcono1234 · 2023-11-06T23:37:00Z

I can do that. I will refrain from sharing my thoughts on that particular Markdown syntax, except to say that the alternative syntax with \ seems preferable.

Thanks! I completely overlooked in the specification that a trailing \ achieves that as well; that is certainly better than the invisible trailing spaces.

Sorry that my previous comment was not that kind. I think it is great though that you both are working on making the formatting of this project consistent!

MaicolAntali · 2023-11-07T16:29:00Z

This PR is now replaced by #2536 and #2537

MaicolAntali added 2 commits November 4, 2023 13:09

Adds the spotless dependency

6ffec39

Configures spotless plugin

182a8d5

eamonnmcmanus reviewed Nov 4, 2023

View reviewed changes

pom.xml Outdated Show resolved Hide resolved

pom.xml Outdated Show resolved Hide resolved

pom.xml Outdated Show resolved Hide resolved

MaicolAntali added 2 commits November 4, 2023 17:50

Removes comments

2c418f0

Replaces tabs with spaces

8eb4f2d

MaicolAntali added 2 commits November 4, 2023 18:21

Updates the comment

c81983c

Introduces temporary formatting issues

61fd5a2

MaicolAntali commented Nov 4, 2023

View reviewed changes

gson/src/main/java/com/google/gson/Gson.java Outdated Show resolved Hide resolved

MaicolAntali commented Nov 4, 2023

View reviewed changes

gson/src/main/java/com/google/gson/Gson.java Outdated Show resolved Hide resolved

Moves the spotless plugin

14edca8

Moves the `spotless` plugin out of `<pluginManagement>`

Marcono1234 reviewed Nov 5, 2023

View reviewed changes

Removes the spotless dependency

d850f28

github-advanced-security bot found potential problems Nov 6, 2023

View reviewed changes

MaicolAntali force-pushed the spotless-formatting branch from 8047b25 to d850f28 Compare November 6, 2023 16:41

MaicolAntali and others added 2 commits November 6, 2023 18:02

Merge branch 'main' into spotless-formatting

743bfd7

Fixed temporary formatting issues

d88e1f1

MaicolAntali marked this pull request as ready for review November 6, 2023 17:12

MaicolAntali marked this pull request as draft November 6, 2023 19:37

MaicolAntali and others added 5 commits November 6, 2023 21:04

Merge branch 'main' into spotless-formatting

bd0ad15

Updates the line separators from CRLF to LF

edde156

Excludes Java17RecordTest

4657ff6

Excludes Java17RecordTest

f40d63e

Merge remote-tracking branch 'origin/spotless-formatting' into spotle…

c504625

…ss-formatting # Conflicts: # pom.xml

Excludes Java17RecordReflectionTest

0655fac

MaicolAntali closed this Nov 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`Spotless` formatting #2524

`Spotless` formatting #2524

MaicolAntali commented Nov 4, 2023

eamonnmcmanus left a comment

MaicolAntali commented Nov 4, 2023

eamonnmcmanus commented Nov 4, 2023

MaicolAntali commented Nov 4, 2023

Marcono1234 Nov 5, 2023

MaicolAntali Nov 6, 2023 •

edited

Marcono1234 Nov 6, 2023 •

edited

MaicolAntali commented Nov 6, 2023

eamonnmcmanus commented Nov 6, 2023

MaicolAntali commented Nov 6, 2023

eamonnmcmanus commented Nov 6, 2023

MaicolAntali commented Nov 6, 2023 •

edited

Marcono1234 commented Nov 6, 2023

eamonnmcmanus commented Nov 6, 2023

Marcono1234 commented Nov 6, 2023

MaicolAntali commented Nov 7, 2023

Spotless formatting #2524

Spotless formatting #2524

Conversation

MaicolAntali commented Nov 4, 2023

Purpose

Description

Checklist

eamonnmcmanus left a comment

Choose a reason for hiding this comment

MaicolAntali commented Nov 4, 2023

eamonnmcmanus commented Nov 4, 2023

MaicolAntali commented Nov 4, 2023

Marcono1234 Nov 5, 2023

Choose a reason for hiding this comment

MaicolAntali Nov 6, 2023 • edited

Choose a reason for hiding this comment

Marcono1234 Nov 6, 2023 • edited

Choose a reason for hiding this comment

MaicolAntali commented Nov 6, 2023

eamonnmcmanus commented Nov 6, 2023

MaicolAntali commented Nov 6, 2023

eamonnmcmanus commented Nov 6, 2023

MaicolAntali commented Nov 6, 2023 • edited

Marcono1234 commented Nov 6, 2023

eamonnmcmanus commented Nov 6, 2023

Marcono1234 commented Nov 6, 2023

MaicolAntali commented Nov 7, 2023

`Spotless` formatting #2524

`Spotless` formatting #2524

MaicolAntali Nov 6, 2023 •

edited

Marcono1234 Nov 6, 2023 •

edited

MaicolAntali commented Nov 6, 2023 •

edited