✨ --log to capture output to log file

Author: ebullient

.gitignore

@@ -66,3 +66,4 @@ native-image-macOS-logs
 /javadoc.*
 /options
 /packages
+ttrpg-convert.out

README.md

@@ -330,6 +330,7 @@ The process is similar for other homebrew, including your own, so long as it is
 - There is a `#cli-support` thread in the `#tabletop-games` channel of the [Obsidian Discord](https://discord.gg/veuWUTm).
 - There is a `TTRPG-convert-help` post in the `obsidian-support` forum of the [Obsidian TTRPG Community Discord](https://discord.gg/Zpmr37Uv).
 - There is a TTRPG-convert tutorial (currently aimed at Windows users, but much of it is helpful no matter your OS) at [Obsidian TTRPG Tutorials](https://obsidianttrpgtutorials.com/Obsidian+TTRPG+Tutorials/Plugin+Tutorials/TTRPG-Convert-CLI/TTRPG-Convert-CLI+5e).
+- If you open an issue for an error, run with the `--debug` and `--log` options, and attach the log file to the issue.
 
 ### Want to help fix it?
 

src/main/java/dev/ebullient/convert/RpgDataConvertCli.java

@@ -93,6 +93,10 @@ public class RpgDataConvertCli implements Callable<Integer>, QuarkusApplication
     @Option(names = { "-v", "--verbose" }, description = "Verbose output", defaultValue = "false", scope = ScopeType.INHERIT)
     boolean verbose;
 
+    @Option(names = { "-l",
+            "--log" }, description = "Capture output in a log file", defaultValue = "false", scope = ScopeType.INHERIT)
+    boolean log;
+
     Datasource game;
 
     @Option(names = { "-g",
@@ -264,7 +268,7 @@ public Integer call() {
 
     private int executionStrategy(ParseResult parseResult) {
         try {
-            tui.init(spec, debug, verbose);
+            tui.init(spec, debug, verbose, log);
             return new CommandLine.RunLast().execute(parseResult);
         } finally {
             tui.close();

src/main/java/dev/ebullient/convert/io/Tui.java

@@ -26,6 +26,7 @@
 import java.util.stream.Stream;
 
 import jakarta.enterprise.context.ApplicationScoped;
+import jakarta.enterprise.event.Observes;
 
 import org.yaml.snakeyaml.DumperOptions;
 import org.yaml.snakeyaml.DumperOptions.FlowStyle;
@@ -52,6 +53,7 @@
 import dev.ebullient.convert.qute.ImageRef;
 import dev.ebullient.convert.qute.QuteBase;
 import dev.ebullient.convert.qute.QuteNote;
+import io.quarkus.runtime.ShutdownEvent;
 import picocli.CommandLine;
 import picocli.CommandLine.Help;
 import picocli.CommandLine.Help.Ansi;
@@ -170,6 +172,7 @@ public static String toAnchorTag(String x) {
     Ansi ansi;
     ColorScheme colors;
 
+    PrintWriter log;
     PrintWriter out;
     PrintWriter err;
 
@@ -193,6 +196,10 @@ public Tui() {
     }
 
     public void init(CommandSpec spec, boolean debug, boolean verbose) {
+        init(spec, debug, verbose, false);
+    }
+
+    public void init(CommandSpec spec, boolean debug, boolean verbose, boolean log) {
         if (spec != null) {
             this.ansi = spec.commandLine().getHelp().ansi();
             this.colors = spec.commandLine().getHelp().colorScheme();
@@ -203,6 +210,18 @@ public void init(CommandSpec spec, boolean debug, boolean verbose) {
 
         this.debug = debug;
         this.verbose = verbose;
+        if (log) {
+            Path p = Path.of("ttrpg-convert.out");
+            try {
+                this.log = new PrintWriter(Files.newOutputStream(p));
+            } catch (IOException e) {
+                errorf(e, "Unable to open log file %s: %s", p.toAbsolutePath(), e.toString());
+            }
+        }
+    }
+
+    void onShutdown(@Observes ShutdownEvent event) {
+        this.close();
     }
 
     public void setOutputPath(Path output) {
@@ -214,8 +233,32 @@ public void setTemplates(Templates templates) {
     }
 
     public void close() {
+        flush();
+        if (this.log != null) {
+            log.close();
+        }
+    }
+
+    public void flush() {
         out.flush();
         err.flush();
+        if (log != null) {
+            log.flush();
+        }
+    }
+
+    private void outLine(Object line) {
+        out.println(line);
+        if (log != null) {
+            log.println(line);
+        }
+    }
+
+    private void errLine(Object line) {
+        err.println(line);
+        if (log != null) {
+            log.println(line);
+        }
     }
 
     public boolean isDebug() {
@@ -230,7 +273,7 @@ public void debugf(String format, Object... params) {
 
     public void debug(String output) {
         if (isDebug()) {
-            out.println(ansi.new Text("@|faint 🔧 " + output + "|@", colors));
+            outLine(ansi.new Text("@|faint 🔧 " + output + "|@", colors));
         }
     }
 
@@ -246,7 +289,7 @@ public void verbosef(String format, Object... params) {
 
     public void verbose(String output) {
         if (isVerbose()) {
-            out.println(ansi.new Text("@|faint 🔹 " + output + "|@", colors));
+            outLine(ansi.new Text("@|faint 🔹 " + output + "|@", colors));
         }
     }
 
@@ -255,29 +298,29 @@ public void warnf(String format, Object... params) {
     }
 
     public void warn(String output) {
-        out.println(ansi.new Text("[🔸 WARN] " + output));
+        outLine(ansi.new Text("[🔸 WARN] " + output));
     }
 
     public void donef(String format, Object... params) {
         done(String.format(format, params));
     }
 
     public void done(String output) {
-        out.println(ansi.new Text("[ ✅  OK] " + output));
+        outLine(ansi.new Text("[ ✅  OK] " + output));
     }
 
     public void printlnf(String format, Object... args) {
         println(String.format(format, args));
     }
 
     public void println(String output) {
-        out.println(ansi.new Text(output, colors));
-        out.flush();
+        outLine(ansi.new Text(output, colors));
+        flush();
     }
 
     public void println(String... output) {
-        Arrays.stream(output).forEach(l -> out.println(ansi.new Text(l, colors)));
-        out.flush();
+        Arrays.stream(output).forEach(l -> outLine(ansi.new Text(l, colors)));
+        flush();
     }
 
     public void errorf(String format, Object... args) {
@@ -293,11 +336,14 @@ public void error(String errorMsg) {
     }
 
     public void error(Throwable ex, String errorMsg) {
-        err.println(colors.errorText("[ 🛑 ERR] " + errorMsg));
+        errLine(colors.errorText("[ 🛑 ERR] " + errorMsg));
         if (ex != null && isDebug()) {
             ex.printStackTrace(err);
+            if (log != null) {
+                ex.printStackTrace(log);
+            }
         }
-        err.flush();
+        flush();
     }
 
     public void throwInvalidArgumentException(String message) {

src/test/java/dev/ebullient/convert/Tools5eDataConvertTest.java

@@ -127,7 +127,7 @@ void testLiveData_5eHomebrew(QuarkusMainLauncher launcher) {
             Path target = testOutput.resolve("homebrew");
             TestUtils.deleteDir(target);
 
-            LaunchResult result = launcher.launch("--debug", "--index",
+            LaunchResult result = launcher.launch("--debug", "--index", "--log",
                     "-c", TestUtils.TEST_RESOURCES.resolve("sources-homebrew.json").toString(),
                     "-o", target.toString(),
                     TestUtils.TEST_RESOURCES.resolve("images-remote.json").toString(),