EPUB checker option "--version" issue #1533

Activity

1. rdeltour commented on Aug 31, 2023

   

   rdeltour

   on Aug 31, 2023

   Member

   More actions

   The EPUB validation has failed while using the option "--version" in the command line argument and getting the default message in the log file if there are any errors or warnings in the source EPUB file. The previous version 5.0.1 correctly indicated the error/warning with version details.

   This is likely due to the change made in #1526. The --version option now prints the version and exits the command, which I believe is the common behavior for command line tools.

   Do you need to print the EPUBCheck version number and the check messages at the same time?
2. rdeltour

   self-assigned this

   on Aug 31, 2023
3. rdeltour

   added

   status: waiting for feedbackThe development team needs feedback from the issue’s creatorThe development team needs feedback from the issue’s creator

   priority: lowTo be processed when time allowsTo be processed when time allows

   type: regressionSomething that brokeSomething that broke

   on Aug 31, 2023
4. Bala6644 commented on Sep 1, 2023

   

   Bala6644

   on Sep 1, 2023

   Author

   More actions

   Hi @rdeltour ,
   Thanks for your kind support.

   Yes, I need to print the EPUBCheck version number and the check messages at the same time.
5. TobiasWantzen commented on Jan 11, 2024

   

   TobiasWantzen

   on Jan 11, 2024

   Last edited by TobiasWantzen

   More actions

   @rdeltour
   I'm in need of outputting the version info with the check messages either, but would propose to introduce a new CLI option for this, maybe "-i"/"--info", which will simply add the version info to the "normal" output, e.g.:

   java -jar /epubcheck.jar -i xyz.epub
   

   will then output:

   EPUBCheck v5.1.0 abgeschlossen
   Verwendung der EPUB 3.3 Prüfungen
   ERROR(RSC-005): xyz.epub/OEBPS/content.opf(3,56): Validierungsfehler: package dcterms:modified meta element must occur exactly once
   
   EPUBCheck mit Fehlern abgeschlossen
   Meldungen: 0 Schwerwiegende Fehler / 1 Fehler / 0 Warnungen / 0 Informationen
   

   
   To "--version":

   java -jar /epubcheck.jar --version
   

   now outputs this:

   EPUBCheck v5.1.0
   Meldungen: 0 Schwerwiegende Fehler / 0 Fehler / 0 Warnungen / 0 Informationen
   
   EPUBCheck abgeschlossen
   

   This is very misleading. Please reduce the output to the version info only and then exit:

   EPUBCheck v5.1.0
   

   Misleading, because in my workflow, which runs for a decade now, "--version" was always part of the CLI command to test my epubs, so it took me some time to realize that there were errors in the epub I was checking, even though epubcheck says there were none.
6. TobiasWantzen commented on Jan 11, 2024

   

   TobiasWantzen

   on Jan 11, 2024

   Last edited by TobiasWantzen

   More actions

   @rdeltour
   I made some testing and

   java -jar /epubcheck.jar --help
   

   outputs the trailing check informations either:

   [...]
   Meldungen: 0 Schwerwiegende Fehler / 0 Fehler / 0 Warnungen / 0 Informationen
   
   EPUBCheck abgeschlossen
   

   This should be fixed!

   For a workaround until this is fixed:

   java -jar /epubcheck.jar --version -q
   java -jar /epubcheck.jar --help -q
   

   suppresses the misleading check informations at the end.
7. rdeltour

   added this to the Next maintenance release milestone on Dec 27, 2024
8. rdeltour

   added

   status: acceptedReady to be further processedReady to be further processed

   status: in progressThe issue is being implemented by the development teamThe issue is being implemented by the development team

   and removed

   status: waiting for feedbackThe development team needs feedback from the issue’s creatorThe development team needs feedback from the issue’s creator

   status: acceptedReady to be further processedReady to be further processed

   on Dec 27, 2024
9. rdeltour

   added a commit that references this issue on Dec 28, 2024

   fix: allow using `-version` when checking a file

   ...

   This issue will close once commit 26fd614 is merged into the 'main' branch.

   26fd614
10. rdeltour

    added

    status: has PRThe issue is being processed in a pull requestThe issue is being processed in a pull request

    and removed

    status: in progressThe issue is being implemented by the development teamThe issue is being implemented by the development team

    priority: lowTo be processed when time allowsTo be processed when time allows

    on Dec 28, 2024
11. rdeltour

    closed this as completedin 26fd614on Dec 29, 2024