Skip to content

PDF command options, error handling, and testing #1158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
mphstudios wants to merge 19 commits into
base: feature/lib-reporter
Choose a base branch
from
Open

PDF command options, error handling, and testing #1158

mphstudios wants to merge 19 commits into from
+1,988 −237

Conversation

@mphstudios
Copy link
Member

@mphstudios mphstudios commented Jan 21, 2026 •
edited
Loading

See the updated lib/pdf documentation in this pull-request

Added

  • PDF engines (Paged.js, PrinceXML) output debug statements when --debug flag is used
  • Adds a quire pdf command option to specify the output path

Usage

# Use project config default location
quire pdf

# Custom absolute path (overrides project config)
quire pdf --output /path/to/my-publication.pdf

# Custom relative path (resolved from project root, overrides project config)
quire pdf --output downloads/book.pdf

# Combined with other options
quire pdf --build --engine prince --output final-print.pdf

Changed

  • Lib PDF throws custom PdfGenerationError errors
  • Use lib/reporter to provide user feedback during the PDF generation progress

Now when running quire pdf, users see:

⠋ Generating PDF using Paged.js... (3s)
  Input: /project/_site/pdf.html      ← displayed only in verbose mode
  Output: /project/_site/_downloads/publication.pdf

Using --verbose stages during processing are displayed to the user:

⠋ Rendering PDF... (12s)
⠋ Generating page map... (15s)
⠋ Writing PDF files... (18s)
✔ PDF saved to /project/_site/_downloads/publication.pdf

on failure:

✖ PDF generation failed

@mphstudios mphstudios marked this pull request as ready for review January 21, 2026 18:53
@mphstudios mphstudios changed the title Feature: pdf command output option Feature: PDF command option for output path Jan 21, 2026
@mphstudios mphstudios marked this pull request as draft January 21, 2026 19:07
@mphstudios mphstudios requested review from fchasen and removed request for fchasen January 21, 2026 20:31
@mphstudios mphstudios marked this pull request as ready for review January 21, 2026 22:50
@mphstudios mphstudios changed the title Feature: PDF command option for output path Feature: PDF command options, error handling, and testing Jan 21, 2026
@mphstudios mphstudios changed the title Feature: PDF command options, error handling, and testing PDF command options, error handling, and testing Jan 21, 2026
@mphstudios mphstudios force-pushed the feature/pdf-output-option branch 2 times, most recently from 9a0ae52 to 5d04407 Compare January 22, 2026 22:03
Base automatically changed from refactor/cli-output-modes to feature/lib-reporter January 23, 2026 01:14
@mphstudios mphstudios force-pushed the feature/lib-reporter branch from 2db734f to f7a805d Compare January 23, 2026 03:02
@mphstudios mphstudios force-pushed the feature/pdf-output-option branch from 5d04407 to b17621f Compare January 23, 2026 03:16
@mphstudios mphstudios force-pushed the feature/lib-reporter branch 2 times, most recently from 52e304e to 480d484 Compare January 23, 2026 23:46
@mphstudios
Add pdf command option to specify the output path
d55626c
@mphstudios
Refactor lib/pdf error handling, use error classes
723da95
@mphstudios
Refactor PDF generation to use progress reporter
f4acdb5
@mphstudios
Allow pdf --output option to override default path
9d34e69
@mphstudios
Update lib/pdf documentation
ec3fbd9
@mphstudios
Clarify ownership of the reporter lifecycle
7cfbf1e 
Commands configure reporter, the reporter lifecycle (start/succeed/fail)
is handled by the façade, not by the command; the owner of the lifecycle
starts the reporter. This separation of roles ensures that once the
reporter lifecycle is started it is not reset downstream and that users
do not receive redundant reporter messages.
@mphstudios
Update which helper to use ToolNotFoundError
5490387
@mphstudios
Add metadata module for lib/pdf engines
5c7a773
@mphstudios
Refactor lib/pdf to handle ToolNotFound errors
cfbca4a
@mphstudios
Reconcile inconsistent progress messages
e7d5a9a
@mphstudios
Show warning when cancelled by the user
e8a9cfb
@mphstudios
Send PrinceXML stderr to debug logger
9f3f61c
@mphstudios
Add unit tests for the pdf/split.js module
6d77abe
@mphstudios
Add test for paged.js and prince error conditions
d404983 
Update lib/pdf documentation with sections that cover the architecture,
test strategy, error handling, and process exit.
@mphstudios
Fix path test to be cross-platform compatible
a4330ca
@mphstudios mphstudios force-pushed the feature/pdf-output-option branch from b17621f to 18ea507 Compare January 24, 2026 00:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mphstudios