fix: allow using -version when checking a file

rdeltour · rdeltour · commit 26fd614c61dd · 2024-12-28T18:22:57.000+01:00
- Allow using the version option when checking a file. The CLI will display the version info and the carry on checking the file. - The "EPUBCheck completed" message, along with the short stats on messages (fatals/errors/warnings/infos) is no longer displayed when the CLI only displays informational output (help message or version). Fixes #1533
diff --git a/src/main/java/com/adobe/epubcheck/tool/EpubChecker.java b/src/main/java/com/adobe/epubcheck/tool/EpubChecker.java
@@ -92,7 +92,8 @@ public class EpubChecker
   File listChecksOut;
   File customMessageFile;
   boolean listChecks = false;
-  boolean displayHelpOrVersion = false;
+  boolean displayHelp = false;
+  boolean displayVersion = false;
   boolean useCustomMessageFile = false;
   boolean failOnWarnings = false;
   private Messages messages = Messages.getInstance();
@@ -132,17 +133,17 @@ public int run(String[] args)
     {
       if (processArguments(args))
       {
+        if (displayHelp || (displayVersion && path == null))
+        {
+          return 0;
+        }
         report = createReport();
         report.initialize();
         if (listChecks)
         {
           dumpMessageDictionary(report);
           return 0;
         }
-        if (displayHelpOrVersion)
-        {
-          return 0;
-        }
         if (useCustomMessageFile)
         {
           report.setCustomMessageFile(customMessageFile.getAbsolutePath());
@@ -159,7 +160,9 @@ public int run(String[] args)
       returnValue = 1;
     } finally
     {
-      printEpubCheckCompleted(report);
+      if (report != null) {
+        printEpubCheckCompleted(report);
+      }
     }
     return returnValue;  
   }
@@ -743,11 +746,11 @@ else if (!fileName.startsWith("-"))
           case "?":
           case "help":
               displayHelp(); // display help message
-              displayHelpOrVersion = true;
-            break;
+              displayHelp = true;
+              break;
           case "version":
             displayVersion();
-            displayHelpOrVersion = true;
+            displayVersion = true;
             break;
           default:
               System.err.println(String.format(messages.get("unrecognized_argument"), args[i]));
@@ -796,7 +799,7 @@ else if (!fileName.startsWith("-"))
 
     if (path == null)
     {
-      if (listChecks || displayHelpOrVersion)
+      if (listChecks || displayHelp || displayVersion)
       {
         return true;
       }
diff --git a/src/test/resources/cli/cli.feature b/src/test/resources/cli/cli.feature
@@ -75,10 +75,7 @@ Feature: EPUBCheck Command Line
 				--version                = displays the EPUBCheck version
 				
 				-h, -? or --help         = displays this help message
-				
-				Messages: 0 fatals / 0 errors / 0 warnings / 0 infos
-				
-				EPUBCheck completed
+
 
 				```
 
@@ -104,12 +101,26 @@ Feature: EPUBCheck Command Line
 		Example: Option `-version` is used to display the version
 			When running `epubcheck -version`
 			Then the return code is 0
-			Then stdout starts with "EPUBCheck v5."
+			Then stdout is
+				```
+				EPUBCheck v{{VERSION}}
+
+				```
 
 		Example: Option `--version` is used to display the version
 			When running `epubcheck --version`
 			Then the return code is 0
-			Then stdout starts with "EPUBCheck v5."
+			Then stdout is
+				```
+				EPUBCheck v{{VERSION}}
+
+				```
+
+		Example: Option `--version` is used when checking file
+			When running `epubcheck --version {{valid.epub}}`
+			Then the return code is 0
+			Then stdout starts with "EPUBCheck v"
+			And stdout contains "No errors or warnings detected."
 
 
 
