chore: init logging by leveraging picocli lifecycle

and provide output as field on root command (can easily be retrieved by
steps in case they need it).

Author: simschla

app/src/main/java/com/diffplug/spotless/cli/SpotlessAction.java

@@ -18,10 +18,7 @@
 import org.jetbrains.annotations.NotNull;
 
 import com.diffplug.spotless.cli.execution.FormatterStepsSupplier;
-import com.diffplug.spotless.cli.logging.output.Output;
 
 public interface SpotlessAction extends SpotlessCommand {
-    @NotNull Integer executeSpotlessAction(@NotNull Output output, @NotNull FormatterStepsSupplier formatterSteps);
-
-    @NotNull Output setupLogging();
+    @NotNull Integer executeSpotlessAction(@NotNull FormatterStepsSupplier formatterSteps);
 }

app/src/main/java/com/diffplug/spotless/cli/SpotlessCLI.java

@@ -96,6 +96,8 @@ public class SpotlessCLI implements SpotlessAction, SpotlessCommand, SpotlessAct
     @CommandLine.Spec
     CommandLine.Model.CommandSpec spec; // injected by picocli
 
+    private @NotNull Output output;
+
     @CommandLine.Option(
             names = {"--mode", "-m"},
             defaultValue = "APPLY",
@@ -196,8 +198,20 @@ LoggingConfigurer.CLIOutputLevel toCliOutputLevel() {
             description = "The log file to write the output to.")
     File logFile;
 
-    @Override
-    public @NotNull Output setupLogging() {
+    @CommandLine.Option(
+            names = {"--zzz"},
+            hidden = true,
+            defaultValue = "true",
+            description = "Just a hook to be able to initialize logging.")
+    void setFinal(boolean finalFlag) {
+        // this is a hack to make sure that the logging is initialized before any processing occurs outside of parsing
+        // the command line.
+        // Maybe there is a picocli hook I've missed for this?
+        this.output = setupLogging(spec, loggingLevelOptions, logFile);
+    }
+
+    private static @NotNull Output setupLogging(
+            CommandLine.Model.CommandSpec spec, LoggingLevelOptions loggingLevelOptions, File logFile) {
         CommandLine commandLine = spec.commandLine();
         LoggingConfigurer.CLIOutputLevel outputLevel = loggingLevelOptions != null
                 ? loggingLevelOptions.toCliOutputLevel()
@@ -221,9 +235,12 @@ private static void logMetaStatements() {
         nonSpotlessLogger.debug("Meta: non-spotless loggers on level debug enabled.");
     }
 
+    public @NotNull Output output() {
+        return this.output;
+    }
+
     @Override
-    public @NotNull Integer executeSpotlessAction(
-            @NotNull Output output, @NotNull FormatterStepsSupplier formatterSteps) {
+    public @NotNull Integer executeSpotlessAction(@NotNull FormatterStepsSupplier formatterSteps) {
         Objects.requireNonNull(output);
         Objects.requireNonNull(formatterSteps);
         validateTargets();
@@ -248,7 +265,7 @@ private static void logMetaStatements() {
                     .toList();
             ResultType resultType = stepResults.stream()
                     .map(future -> ThrowingEx.get(future::get))
-                    .map(result -> this.handleResult(output, result))
+                    .map(this::handleResult)
                     .reduce(ResultType.CLEAN, ResultType::combineWith);
             return spotlessMode.translateResultTypeToExitCode(resultType);
         }
@@ -270,7 +287,7 @@ private void validateTargets() {
         }
     }
 
-    private ResultType handleResult(Output output, Result result) {
+    private ResultType handleResult(Result result) {
         if (result.lintState().isClean()) {
             LOGGER.debug("File is clean: {}", result.target().toFile());
             return ResultType.CLEAN;

app/src/main/java/com/diffplug/spotless/cli/execution/SpotlessExecutionStrategy.java

@@ -15,10 +15,8 @@
  */
 package com.diffplug.spotless.cli.execution;
 
-import com.diffplug.spotless.cli.SpotlessAction;
 import com.diffplug.spotless.cli.core.SpotlessActionContext;
 import com.diffplug.spotless.cli.core.SpotlessCommandLineStream;
-import com.diffplug.spotless.cli.logging.output.Output;
 
 import picocli.CommandLine;
 
@@ -35,13 +33,6 @@ public int execute(CommandLine.ParseResult parseResult) throws CommandLine.Execu
     }
 
     private Integer runSpotlessActions(SpotlessCommandLineStream commandLineStream) {
-        // 0. setup logging
-        Output output = commandLineStream
-                .actions()
-                .findFirst()
-                .map(SpotlessAction::setupLogging)
-                .orElseThrow();
-
         // 1. prepare context
         SpotlessActionContext context = provideSpotlessActionContext(commandLineStream);
 
@@ -51,7 +42,7 @@ private Integer runSpotlessActions(SpotlessCommandLineStream commandLineStream)
                 stepsSupplierFactory.createFormatterStepsSupplier(commandLineStream, context);
 
         // 3. run spotless steps
-        return executeSpotlessAction(output, commandLineStream, stepsSupplier);
+        return executeSpotlessAction(commandLineStream, stepsSupplier);
     }
 
     private SpotlessActionContext provideSpotlessActionContext(SpotlessCommandLineStream commandLineStream) {
@@ -63,11 +54,11 @@ private SpotlessActionContext provideSpotlessActionContext(SpotlessCommandLineSt
     }
 
     private Integer executeSpotlessAction(
-            Output output, SpotlessCommandLineStream commandLineStream, FormatterStepsSupplier stepsSupplier) {
+            SpotlessCommandLineStream commandLineStream, FormatterStepsSupplier stepsSupplier) {
         return commandLineStream
                 .actions()
                 .findFirst()
-                .map(spotlessAction -> spotlessAction.executeSpotlessAction(output, stepsSupplier))
+                .map(spotlessAction -> spotlessAction.executeSpotlessAction(stepsSupplier))
                 .orElse(-1);
     }
 }

app/src/test/java/com/diffplug/spotless/cli/core/ChecksumCalculatorTest.java

@@ -29,7 +29,6 @@
 import com.diffplug.spotless.cli.SpotlessAction;
 import com.diffplug.spotless.cli.SpotlessActionContextProvider;
 import com.diffplug.spotless.cli.execution.FormatterStepsSupplier;
-import com.diffplug.spotless.cli.logging.output.Output;
 import com.diffplug.spotless.cli.steps.SpotlessCLIFormatterStep;
 import com.diffplug.spotless.cli.steps.SpotlessFormatterStep;
 
@@ -289,15 +288,9 @@ static class Action implements SpotlessAction {
         Path baseDir;
 
         @Override
-        public @NotNull Integer executeSpotlessAction(
-                @NotNull Output output, @NotNull FormatterStepsSupplier formatterSteps) {
+        public @NotNull Integer executeSpotlessAction(@NotNull FormatterStepsSupplier formatterSteps) {
             return 0;
         }
-
-        @Override
-        public @NotNull Output setupLogging() {
-            return new Output();
-        }
     }
 
     private static SpotlessCommandLineStream commandLine(SpotlessAction action, SpotlessFormatterStep... steps) {