feat: allow configuration of logging on cli

Author: simschla

README.md

@@ -106,27 +106,30 @@ output =
     /_/
 
 
-Usage: spotless [-hV] [-e=<encoding>] [-l=<lineEnding>] [-m=<spotlessMode>]
-                [-p=N] [-t=<targets>]... [FORMATTING_STEPS]
+Usage: spotless [-hV] [-e=<encoding>] [-l=<lineEnding>] [--log-file=<logFile>]
+                [-m=<spotlessMode>] [-p=N] [-t=<targets>]... [-q | -v [-v]...]
+                [FORMATTING_STEPS]
 Runs spotless
-  -e, --encoding=<encoding>
-                           The encoding of the files to format.
-                             (default: UTF-8)
-  -h, --help               Show this help message and exit.
+  -e, --encoding=<encoding>  The encoding of the files to format.
+                               (default: UTF-8)
+  -h, --help                 Show this help message and exit.
   -l, --line-ending=<lineEnding>
-                           The line ending of the files to format.
-                             One of: GIT_ATTRIBUTES,
-                             GIT_ATTRIBUTES_FAST_ALLSAME, PLATFORM_NATIVE,
-                             WINDOWS, UNIX, MAC_CLASSIC, PRESERVE
-                             (default: UNIX)
-  -m, --mode=<spotlessMode>
-                           The mode to run spotless in.
-                             One of: CHECK, APPLY
-                             (default: APPLY)
-  -p, --parallelity=N      The number of parallel formatter threads to run.
-                             (default: #cores * 0.5)
-  -t, --target=<targets>   The target files to format.
-  -V, --version            Print version information and exit.
+                             The line ending of the files to format.
+                               One of: GIT_ATTRIBUTES,
+                               GIT_ATTRIBUTES_FAST_ALLSAME, PLATFORM_NATIVE,
+                               WINDOWS, UNIX, MAC_CLASSIC, PRESERVE
+                               (default: UNIX)
+      --log-file=<logFile>   The log file to write the output to.
+  -m, --mode=<spotlessMode>  The mode to run spotless in.
+                               One of: CHECK, APPLY
+                               (default: APPLY)
+  -p, --parallelity=N        The number of parallel formatter threads to run.
+                               (default: #cores * 0.5)
+  -q, --quiet                Disable as much output as possible.
+  -t, --target=<targets>     The target files to format.
+  -v                         Enable verbose output. Multiple -v options
+                               increase the verbosity (max 5).
+  -V, --version              Print version information and exit.
 
 Available formatting steps:
   license-header      Runs license header

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

@@ -15,6 +15,7 @@
  */
 package com.diffplug.spotless.cli;
 
+import java.io.File;
 import java.nio.charset.Charset;
 import java.nio.file.Path;
 import java.util.List;
@@ -119,10 +120,55 @@ public void setParallelity(int parallelity) {
         this.parallelity = parallelity;
     }
 
+    @CommandLine.ArgGroup(exclusive = true, multiplicity = "0..1")
+    LoggingLevelOptions loggingLevelOptions;
+
+    class LoggingLevelOptions {
+
+        private boolean[] verbosity;
+
+        @CommandLine.Option(
+                names = {"-v"},
+                description = "Enable verbose output. Multiple -v options increase the verbosity (max 5).",
+                arity = "0")
+        public void setVerbose(boolean[] verbosity) {
+            if (verbosity.length > 5) {
+                throw new CommandLine.ParameterException(
+                        spec.commandLine(), "Error: --verbose can be used at most 5 times");
+            }
+            this.verbosity = verbosity;
+        }
+
+        @CommandLine.Option(
+                names = {"--quiet", "-q"},
+                description = "Disable as much output as possible.",
+                arity = "0")
+        boolean quiet;
+
+        LoggingConfigurer.CLIOutputLevel toCliOutputLevel() {
+            if (quiet) {
+                return LoggingConfigurer.CLIOutputLevel.QUIET;
+            }
+            if (verbosity == null) {
+                return LoggingConfigurer.CLIOutputLevel.DEFAULT;
+            }
+            int verbosityCount = this.verbosity.length;
+            return LoggingConfigurer.CLIOutputLevel.verbosity(verbosityCount);
+        }
+    }
+
+    @CommandLine.Option(
+            names = {"--log-file"},
+            description = "The log file to write the output to.")
+    File logFile;
+
     @Override
     public void setupLogging() {
         LoggingConfigurer.configureLogging(
-                LoggingConfigurer.CLIOutputLevel.VVVVV, null); // TODO add options to set that
+                loggingLevelOptions != null
+                        ? loggingLevelOptions.toCliOutputLevel()
+                        : LoggingConfigurer.CLIOutputLevel.DEFAULT,
+                logFile);
     }
 
     @Override

app/src/main/java/com/diffplug/spotless/cli/logging/output/LoggingConfigurer.java

@@ -94,12 +94,31 @@ private static void configureJdkLogging(@NotNull CLIOutputLevel cliOutputLevel,
     }
 
     public enum CLIOutputLevel {
-        VVVVV, // everything, even debug levels
-        VVVV, // spotless on debug, everything else non- debug levels
-        VVV, // everything spotless, even debug levels
-        VV, // everything spotless, except debug levels
-        V, // only info and above
+        VVVVV(5), // everything, even debug levels
+        VVVV(4), // spotless on debug, everything else non- debug levels
+        VVV(3), // everything spotless, even debug levels
+        VV(2), // everything spotless, except debug levels
+        V(1), // only info and above
         DEFAULT, // only warnings and above
-        QUIET, // only errors and above
+        QUIET; // only errors and above
+
+        private final int verbosity;
+
+        CLIOutputLevel(int verbosity) {
+            this.verbosity = verbosity;
+        }
+
+        CLIOutputLevel() {
+            this(-1);
+        }
+
+        public static CLIOutputLevel verbosity(int verbosity) {
+            for (CLIOutputLevel level : CLIOutputLevel.values()) {
+                if (level.verbosity == verbosity) {
+                    return level;
+                }
+            }
+            throw new IllegalArgumentException("Unknown verbosity " + verbosity);
+        }
     }
 }