MVN: Spotless google-java-format

[Korbik]

[ghubstan]

I'm commenting here just to say I'm following matrix and the biscuit-java PRs, waiting for your team to say when I can work on the API changes -- to consistently use camelCase for all method and variable names.

Also, this PR looks good to me. (A minimal configuration to start with is best.) I've run the plugin's apply task on the code base many times, and it never broke an existing test. But as you all know, running apply and trying to merge its changes will probably result in a lot of file conflicts when attempting to merge existing, open PRs, before the code base is frozen.

[ghubstan]

I assumed your checkstyle.xml was a custom file, but it looks like you downloaded the google_checks.xml file, and renamed and commited it as google_checks.xml.

Did you get it from here?

If so, if you rename it to google_checks.xml, nobody will assume it is a custom config file.

[ghubstan]

Regarding the checkstyle plugin configuration in the pom.xml file's <reporting> section...

Is it your intention to run the checkstyle task via the mvn site task? This may be ambiguous; you can replace the maven site configuration (delete it), and add a plugin configuration below your com.diffplug.spotless plugin's configuration, like the example below:

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-checkstyle-plugin</artifactId>
                <version>${maven-checkstyle-plugin.version}</version>
                <configuration>
                    <configLocation>google_checks.xml</configLocation>
                    <consoleOutput>true</consoleOutput>
                    <includeTestSourceDirectory>true</includeTestSourceDirectory>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>check</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

Instead of running mvn site to generate the checkstyle report, you would run task mvn checkstyle:checkstyle. This would generate the html report in target/reports/checkstyle.html.

[ghubstan]

My two previous comments do not point out errors; they are subjective opinions about file naming and configuration of different tasks that do the same thing, i.e,. mvn site vs mvn checkstyle:checkstyle.

But it looks like my assumption about you using an unmodified google_checkstyle.xml config might be wrong because you say in PR 116: Mix of sun_checks and Google Format. If so, never mind what I said about changing the name of checkstyle.xml to google_checks.xml.

And I am not qualified to comment on the Signer related commits in this PR.

So, as per Can anyone tell me what is ACK and utACK means?, I say utACK (untested ACK), because I tested the new plugin tasks, but not the Signer changes.

[Korbik]

Just to clarify few things. The checkstyle.xml is indeed the google_checks.xml in the version 10.21.3.

It is mostly for the just in case of customisation and if plugins use the checkstyle.xml file to validate the code.

The mix between sun_checks and google_checks are because of misconfiguration of the plugin at the beginning of the task. It is still a good practice from my point of view but it can still be lot of work. Google Format is less strict.

I only use mvn checkstyle:checkstyle.