Property for skipping formatting in the README doesn't match the property in the code

The README mentions -Dspring-javaformat.apply.skip=true but the code looks for -Dspring-javaformat.format.skip=true.

None of the three (3) skip options seem to work:

-Dspring-javaformat.skip=true
-Dspring-javaformat.apply.skip=true
-Dspring-javaformat.validate.skip=true

All of them fill a purpose.

Looking at https://github.com/spring-io/spring-javaformat/blob/main/spring-javaformat-maven/spring-javaformat-maven-plugin/src/main/java/io/spring/format/maven/ApplyMojo.java#L43 which used spring-javaformat.format.skip but that does not work either with my MRE.

I think you may be misinterpreting Maven's output. When a goal is skipped, Maven will still call it and that fact that it has been called will appear in Maven's output. It is up to the goal to perform no processing when skipped. The apply and validate goals output some debug logging indicating that they have been skipped. For example:

$ mvn validate -X -Dspring-javaformat.validate.skip=true
…
[INFO] --- spring-javaformat-maven-plugin:0.0.38:validate (default) @ test ---
[DEBUG] Configuring mojo io.spring.javaformat:spring-javaformat-maven-plugin:0.0.38:validate from plugin realm ClassRealm[plugin>io.spring.javaformat:spring-javaformat-maven-plugin:0.0.38, parent: jdk.internal.loader.ClassLoaders$AppClassLoader@531d72ca]
[DEBUG] Configuring mojo 'io.spring.javaformat:spring-javaformat-maven-plugin:0.0.38:validate' with basic configurator -->
[DEBUG]   (f) encoding = UTF-8
[DEBUG]   (f) excludes = []
[DEBUG]   (f) includeGeneratedSource = false
[DEBUG]   (f) includes = []
[DEBUG]   (f) project = MavenProject: test:test:0.1-SNAPSHOT @ /Users/awilkinson/Downloads/test-4/pom.xml
[DEBUG]   (f) session = org.apache.maven.execution.MavenSession@6d467c87
[DEBUG]   (f) skip = true
[DEBUG]   (f) sourceDirectories = [/Users/awilkinson/Downloads/test-4/src/main/java]
[DEBUG]   (f) testSourceDirectories = [/Users/awilkinson/Downloads/test-4/src/test/java]
[DEBUG] -- end configuration --
[DEBUG] skipping format validate as per configuration.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.022 s
[INFO] Finished at: 2023-02-23T09:45:51Z
[INFO] ------------------------------------------------------------------------

We should consider logging the skip message at info level. That's what Surefire does for example.

@wilkinsona

@wilkinsona Yes, I understand. But, the skip is not set true correctly in all cases from what I can see. Do you get [DEBUG] (f) skip = true when you try to skip apply?

That is, mvn validate -X -Dspring-javaformat.apply.skip=true

I don't get [DEBUG] (f) skip = true

for

-Dspring-javaformat.skip=true
-Dspring-javaformat.apply.skip=true

only for

-Dspring-javaformat.validate.skip=true

We should consider logging the skip message at info level. That's what Surefire does for example.

Yes, agreed.

As I said in #360 (comment), you need to use -Dspring-javaformat.format.skip=true. You will then see skipping format apply as per configuration logged at debug level.

You'll see both skipping format apply as per configuration and skipping format validate as per configuration logged when using -Dspring-javaformat.skip=true. You won't see [DEBUG] (f) skip = true when setting spring-javaformat.skip as that's showing the value of the parameter to which spring-javaformat.format.skip and spring-javaformat.validate.skip are mapped.

Ok. Got a bit confused there. So, -Dspring-javaformat.format.skip=true will only skip apply?

Yes. spring-javaformat.format.skip skips apply, spring-javaformat.validate.skip skips validation, and spring-javaformat.skip skips both. Other than the mistake with the name of the property to skip apply, this is described in the README:

You can use -Dspring-javaformat.validate.skip=true or -Dspring-javaformat.apply.skip=true command line arguments to temporarily skip the validation or format goals. If you want to skip both, you can use -Dspring-javaformat.skip=true.

@wilkinsona

@wilkinsona Sorry for the confusion and for you having the explain several times. Have a very hectic week and it became now that I rushed things. I totally missed that apply was replaced with format although I did a cut-n-paste from your text.

I would +1 to allow spring-javaformat.apply.skip as it makes sense to be consistent with the naming of skip variables and maven goal.

I messed up the property name in the code.

Fix 'spring-javaformat.apply.skip' property and use info logging

Navigation Menu

Repository navigation

Property for skipping formatting in the README doesn't match the property in the code #365

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Property for skipping formatting in the README doesn't match the property in the code #365

Description

Activity

lfvjimisola commented on Feb 23, 2023

lfvjimisola commented on Feb 23, 2023

wilkinsona commented on Feb 23, 2023

wilkinsona commented on Feb 23, 2023

lfvjimisola commented on Feb 23, 2023

lfvjimisola commented on Feb 23, 2023

wilkinsona commented on Feb 23, 2023

jimisola commented on Feb 23, 2023

wilkinsona commented on Feb 23, 2023

lfvjimisola commented on Feb 23, 2023

philwebb commented on Feb 23, 2023

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions