Add check command with JTE output rendering

Introduces the check subcommand which validates source formatting and
Spring checkstyle rules. Output is rendered via JTE templates
(checkSuccess, checkError, checkFormatting, checkCheckstyleDetailed,
checkCombined) with ANSI colour styling. CheckRunner scans files once
and shares the list between the formatter and CheckstyleService.
Includes integration tests for formatting, checkstyle, combined output,
header types, import order, and includes/excludes filtering.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: timothysparg

spring-javaformat-cli/pom.xml

@@ -14,6 +14,7 @@
  <maven.compiler.source>17</maven.compiler.source>
  <maven.compiler.target>17</maven.compiler.target>
  <java.version>17</java.version>
+ <jte.version>3.2.3</jte.version>
 	</properties>
 
 	<dependencyManagement>
@@ -73,6 +74,17 @@
  <artifactId>plexus-utils</artifactId>
  </dependency>
 
+ <dependency>
+ <groupId>gg.jte</groupId>
+ <artifactId>jte-runtime</artifactId>
+ <version>${jte.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>gg.jte</groupId>
+ <artifactId>jte-models</artifactId>
+ <version>${jte.version}</version>
+ </dependency>
+
 <!-- Test -->
  <dependency>
  <groupId>org.springframework.boot</groupId>
@@ -140,6 +152,41 @@
  </annotationProcessorPaths>
  </configuration>
  </plugin>
+ <plugin>
+ <groupId>gg.jte</groupId>
+ <artifactId>jte-maven-plugin</artifactId>
+ <version>${jte.version}</version>
+ <configuration>
+ <sourceDirectory>${project.basedir}/src/main/jte</sourceDirectory>
+ <contentType>Plain</contentType>
+ <extensions>
+ <extension>
+ <className>gg.jte.models.generator.ModelExtension</className>
+ <settings>
+ <interfaceAnnotation>@org.jspecify.annotations.NullMarked</interfaceAnnotation>
+ <implementationAnnotation>@org.jspecify.annotations.NullMarked</implementationAnnotation>
+ <language>Java</language>
+ </settings>
+ </extension>
+ </extensions>
+ </configuration>
+ <executions>
+ <execution>
+ <id>generate</id>
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>generate</goal>
+ </goals>
+ </execution>
+ </executions>
+ <dependencies>
+ <dependency>
+ <groupId>gg.jte</groupId>
+ <artifactId>jte-models</artifactId>
+ <version>${jte.version}</version>
+ </dependency>
+ </dependencies>
+ </plugin>
  <plugin>
  <groupId>org.springframework.experimental</groupId>
  <artifactId>spring-aot-maven-plugin</artifactId>

spring-javaformat-cli/src/main/java/io/spring/javaformat/cli/SpringJavaFormatCommand.java

@@ -21,6 +21,7 @@
 importpicocli.CommandLine.Model.CommandSpec;
 importpicocli.CommandLine.Spec;
 
+importio.spring.javaformat.cli.check.CheckCommand;
 importio.spring.javaformat.cli.format.ApplyCommand;
 
 /**
@@ -30,7 +31,7 @@
  */
 @Component
 @Command(name = "spring-javaformat", mixinStandardHelpOptions = true, versionProvider = CliVersionProvider.class,
-subcommands = { ApplyCommand.class },
+subcommands = { ApplyCommand.class, CheckCommand.class },
 description = "Formats and checks Java source files")
 @PicocliManaged
 classSpringJavaFormatCommandimplementsRunnable {

spring-javaformat-cli/src/main/java/io/spring/javaformat/cli/check/CheckCommand.java

@@ -0,0 +1,137 @@
+/*
+ * Copyright 2017-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+packageio.spring.javaformat.cli.check;
+
+importjava.util.Properties;
+importjava.util.concurrent.Callable;
+
+importorg.springframework.stereotype.Component;
+importpicocli.CommandLine.ArgGroup;
+importpicocli.CommandLine.Command;
+importpicocli.CommandLine.Mixin;
+importpicocli.CommandLine.Model.CommandSpec;
+importpicocli.CommandLine.Option;
+importpicocli.CommandLine.ParameterException;
+importpicocli.CommandLine.Spec;
+
+importio.spring.javaformat.cli.InputOptions;
+
+/**
+ * Check formatting and checkstyle violations.
+ *
+ * @author Tim Sparg
+ */
+@Component
+@Command(name = "check", mixinStandardHelpOptions = true,
+description = "Check the codebase for formatting and checkstyle violations")
+publicclassCheckCommandimplementsCallable<Integer> {
+
+@Spec
+privateCommandSpecspec;
+
+@Mixin
+privateInputOptionsformatOptions;
+
+@Option(names = { "-t", "--header-type" }, defaultValue = "APACHE2",
+description = "Header type (${COMPLETION-CANDIDATES}). Default: ${DEFAULT-VALUE}")
+privateHeaderTypeheaderType;
+
+@Option(names = { "-c", "--header-copyright-pattern" }, defaultValue = "20\\d\\d(-20\\d\\d|-present)?",
+description = "Copyright year regex pattern. Default: ${DEFAULT-VALUE}")
+privateStringheaderCopyrightPattern;
+
+@Option(names = { "-f", "--header-file" }, defaultValue = "",
+description = "Path to a custom header file. Required when --header-type is 'file'.")
+privateStringheaderFile;
+
+@Option(names = { "-r", "--project-root-package" }, defaultValue = "org.springframework",
+description = "Root package used for import ordering. Default: ${DEFAULT-VALUE}")
+privateStringprojectRootPackage;
+
+@Option(names = { "-s", "--avoid-static-import-excludes" }, split = ",", defaultValue = "",
+description = "Repeatable or comma-separated static import patterns to allow.")
+privateString[] avoidStaticImportExcludes;
+
+@ArgGroup
+privateRunModerunMode;
+
+privatefinalCheckRunnercheckRunner;
+
+privatefinalCheckReportRenderercheckReportRenderer;
+
+@SuppressWarnings("NullAway.Init")
+CheckCommand(CheckRunnercheckRunner, CheckReportRenderercheckReportRenderer) {
+this.checkRunner = checkRunner;
+this.checkReportRenderer = checkReportRenderer;
+	}
+
+@Override
+publicIntegercall() {
+CheckRunner.Inputsinputs = createInputs();
+CheckReportreport = this.checkRunner.run(inputs);
+this.checkReportRenderer.render(this.spec.commandLine(), report);
+returnreport.exitCode();
+	}
+
+privateCheckRunner.InputscreateInputs() {
+booleanskipCheckstyle = this.runMode != null && this.runMode.skipCheckstyle;
+if (!skipCheckstyle && this.headerType == HeaderType.FILE && this.headerFile.isEmpty()) {
+thrownewParameterException(this.spec.commandLine(),
+"--header-file is required when --header-type is FILE");
+ }
+returnnewCheckRunner.Inputs(this.formatOptions, buildCheckstyleProperties(),
+this.runMode != null && this.runMode.skipFormat, skipCheckstyle);
+	}
+
+privatePropertiesbuildCheckstyleProperties() {
+Propertiesproperties = newProperties();
+properties.setProperty("headerType", this.headerType.value);
+properties.setProperty("headerCopyrightPattern", this.headerCopyrightPattern);
+if (!this.headerFile.isEmpty()) {
+properties.setProperty("headerFile", this.headerFile);
+ }
+properties.setProperty("projectRootPackage", this.projectRootPackage);
+properties.setProperty("avoidStaticImportExcludes", String.join(",",
+java.util.Arrays.stream(this.avoidStaticImportExcludes).filter((s) -> !s.isEmpty()).toList()));
+returnproperties;
+	}
+
+staticclassRunMode {
+
+@Option(names = { "-S", "--skip-checkstyle" }, defaultValue = "false",
+description = "Skip checkstyle checks, only check source formatting")
+booleanskipCheckstyle;
+
+@Option(names = { "-F", "--skip-format" }, defaultValue = "false",
+description = "Skip source formatting check, only run checkstyle")
+booleanskipFormat;
+
+	}
+
+enumHeaderType {
+
+APACHE2("apache2"), NONE("none"), UNCHECKED("unchecked"), REGEXP("regexp"), FILE("file");
+
+privatefinalStringvalue;
+
+HeaderType(Stringvalue) {
+this.value = value;
+ }
+
+	}
+
+}

spring-javaformat-cli/src/main/java/io/spring/javaformat/cli/check/CheckReport.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2017-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+packageio.spring.javaformat.cli.check;
+
+importjava.io.File;
+importjava.util.List;
+
+importcom.puppycrawl.tools.checkstyle.api.AuditEvent;
+importorg.jspecify.annotations.Nullable;
+
+recordCheckReport(List<File> formattingProblems, List<AuditEvent> checkstyleViolations, booleanskipFormat,
+booleanskipCheckstyle, @NullableStringerrorMessage, booleancheckstyleFailure) {
+
+staticCheckReportfailure(booleanskipFormat, booleanskipCheckstyle, StringerrorMessage, booleancheckstyleFailure) {
+returnnewCheckReport(List.of(), List.of(), skipFormat, skipCheckstyle, errorMessage, checkstyleFailure);
+	}
+
+booleanhasViolations() {
+return !this.formattingProblems.isEmpty() || !this.checkstyleViolations.isEmpty();
+	}
+
+booleanhasError() {
+returnthis.errorMessage != null;
+	}
+
+intexitCode() {
+return (hasError() || hasViolations()) ? 1 : 0;
+	}
+
+booleancombined() {
+return !this.skipFormat && !this.skipCheckstyle;
+	}
+
+}

spring-javaformat-cli/src/main/java/io/spring/javaformat/cli/check/CheckReportRenderer.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2017-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+packageio.spring.javaformat.cli.check;
+
+importjava.util.Objects;
+
+importgg.jte.generated.precompiled.StaticTemplates;
+importgg.jte.generated.precompiled.Templates;
+importgg.jte.output.PrintWriterOutput;
+importorg.springframework.stereotype.Component;
+importpicocli.CommandLine;
+
+@Component
+publicclassCheckReportRenderer {
+
+privatefinalTemplatestemplates = newStaticTemplates();
+
+voidrender(CommandLinecommandLine, CheckReportreport) {
+if (report.hasError()) {
+renderError(commandLine, report);
+ }
+elseif (!report.hasViolations()) {
+renderSuccess(commandLine);
+ }
+elseif (report.combined()) {
+renderCombined(commandLine, report);
+ }
+else {
+renderSeparate(commandLine, report);
+ }
+commandLine.getOut().flush();
+commandLine.getErr().flush();
+	}
+
+privatevoidrenderError(CommandLinecommandLine, CheckReportreport) {
+this.templates.checkError(Objects.requireNonNull(report.errorMessage()))
+ .render(newPrintWriterOutput(commandLine.getErr()));
+	}
+
+privatevoidrenderSuccess(CommandLinecommandLine) {
+this.templates.checkSuccess().render(newPrintWriterOutput(commandLine.getOut()));
+	}
+
+privatevoidrenderCombined(CommandLinecommandLine, CheckReportreport) {
+this.templates.checkCombined(report.formattingProblems(), report.checkstyleViolations())
+ .render(newPrintWriterOutput(commandLine.getErr()));
+	}
+
+privatevoidrenderSeparate(CommandLinecommandLine, CheckReportreport) {
+if (!report.skipFormat()) {
+this.templates.checkFormatting(report.formattingProblems())
+ .render(newPrintWriterOutput(commandLine.getErr()));
+ }
+if (!report.skipCheckstyle()) {
+this.templates.checkCheckstyleDetailed(report.checkstyleViolations())
+ .render(newPrintWriterOutput(commandLine.getErr()));
+ }
+	}
+
+}