feat: add execution ID parameter to failing spotless check log

[dpolivaev]

for improved error messaging, issue #1988

• Introduced a new parameter executionId to capture the execution ID from Maven's configuration.
• Updated error messages to include the execution ID when suggesting commands to fix format violations.
• Enhanced test cases to validate the new behavior of error messages based on the execution ID.

[kwin]

The execution ids of different goals usually differ as well!

[dpolivaev]

This is how we use it:

    <profile>
      <id>palantir-java-format-profile</id>
      <activation>
        <jdk>[11,)</jdk>
      </activation>
      <build>
        <plugins>
          <plugin>
            <groupId>com.diffplug.spotless</groupId>
            <artifactId>spotless-maven-plugin</artifactId>
            <executions>
              <execution>
                <!--
                Run "mvn spotless:check@palantir-java-format" to check the
                formatting outside of the "mvn verify" phase.

                Similar: To format your code, run "mvn spotless:apply@palantir-java-format".

                You need to add the execution id with "@palantir-java-format" to your comand,
                so spotless will find its configuration containing the palantirJavaFormat.
                -->
                <id>palantir-java-format</id>
                <phase>verify</phase>
                <goals>
                  <goal>check</goal>
                </goals>
                <configuration>
                  <skip>${spotless.skip.palantirJavaFormat}</skip>
                  <java>
                    <palantirJavaFormat/>
                  </java>
                </configuration>
              </execution>
            </executions>
          </plugin>
        </plugins>
      </build>
    </profile>

Therefore we do not need different configurations and different execution IDs for the different goals (check and apply). We don't repeat ourselves.

[kwin]

They can be the same but don’t have to. With the default assuming the same there is a high chance something is emitted which does not work. I would leave out the default value for this parameter

[dpolivaev]

Do you think we need an optional separate parameter with a dedicated value? How would you name it?

The whole idea is to output correct command line automatically. Currently it outputs just run 'mvn spotless:apply' and it was the reason why I created the pull request.

[kwin]

I think just changing the output inncase a dedicated execution id is configured is totally sufficient

[dpolivaev]

Maven always adds an execution id even if it is not configured in the pom file.
I used a debugger and implemented a heuristic better separating user specified execution ids from maven generated ones.
Now I assume execution id "default" or starting with "default-" like "default-cli" to be automatically added and do not mention them in the generated output.
Unfortunately, I have not found a direct access to the xml after it was processed by the maven xml parser because the parser does not generate any DOM.

[nedtwigg]

This needs a spotlessApply, but once CI passes this LGTM. Before I merge, I'd like one of our established maven contributors to give it a thumbs-up first. I am not maven-literate-enough to understand the debate above. I'll publish a set of releases once this either gets merged or rejected.

[nedtwigg]

I'm open to merging this, but it needs to pass CI, and it needs signoff from an existing maven contributor.