@thegetty/quire-cli 1.0.0-rc.45 → 1.0.0-rc.47

package/src/lib/epub/engines.js

@@ -1,46 +0,0 @@
-/**
- * EPUB Engine Registry
- *
- * Centralized metadata for EPUB engines. Each engine module re-exports
- * its metadata from here, ensuring single source of truth.
- *
- * The façade imports this registry to:
- * 1. Resolve engine names to implementations
- * 2. Check binary availability before loading heavy modules
- * 3. Provide helpful error messages with install URLs
- */
-import QuireError from '#src/errors/quire-error.js'
-
-/**
- * @typedef {Object} EngineMetadata
- * @property {string} name - Human-readable display name
- * @property {string} module - Module filename (e.g., 'epub.js')
- * @property {string|null} requiresBinary - CLI binary name, or null if built-in
- * @property {Object} [toolInfo] - Error metadata (only for engines requiring binaries)
- * @property {string} [toolInfo.displayName] - Display name for error messages
- * @property {string} [toolInfo.installUrl] - URL to download the tool
- * @property {string} [toolInfo.docsUrl] - Quire docs URL
- * @property {string} [toolInfo.fallback] - Alternative suggestion
- */
-
-/** @type {Record<string, EngineMetadata>} */
-const ENGINES = {
-  epubjs: {
-    name: 'Epub.js',
-    module: 'epub.js',
-    requiresBinary: null, // Built-in Node.js library
-  },
-  pandoc: {
-    name: 'Pandoc',
-    module: 'pandoc.js',
-    requiresBinary: 'pandoc',
-    toolInfo: {
-      displayName: 'Pandoc',
-      installUrl: 'https://pandoc.org/installing.html',
-      docsUrl: `${QuireError.DOCS_BASE}/epub-output/`,
-      fallback: 'Or use the default EPUB engine: quire epub --engine epubjs',
-    },
-  },
-}
-
-export default ENGINES

package/src/lib/epub/index.test.js

@@ -1,518 +0,0 @@
-import esmock from 'esmock'
-import path from 'node:path'
-import sinon from 'sinon'
-import test from 'ava'
-
-/**
- * EPUB Module Integration Tests
- *
- * Tests the EPUB generation façade module behavior with mocked dependencies.
- * Uses esmock to isolate the module from file system and external EPUB tools.
- */
-
-/**
- * Create a cross-platform absolute path for testing
- * @param {...string} segments - Path segments to join
- * @returns {string} Platform-appropriate absolute path
- */
-function testPath(...segments) {
-  const root = process.platform === 'win32' ? 'C:\\' : '/'
-  return path.join(root, ...segments)
-}
-
-test.beforeEach((t) => {
-  t.context.sandbox = sinon.createSandbox()
-})
-
-test.afterEach.always((t) => {
-  t.context.sandbox.restore()
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Library resolution tests
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('generateEpub resolves epubjs library correctly', async (t) => {
-  const { sandbox } = t.context
-
-  const mockEpubLib = sandbox.stub().resolves()
-  const mockDynamicImport = sandbox.stub().resolves({ default: mockEpubLib })
-
-  const mockPaths = {
-    getProjectRoot: () => testPath('project'),
-    getEpubDir: () => '_epub'
-  }
-
-  const mockFs = {
-    existsSync: sandbox.stub().returns(true),
-    mkdirSync: sandbox.stub()
-  }
-
-  const mockReporter = {
-    start: sandbox.stub(),
-    detail: sandbox.stub(),
-    succeed: sandbox.stub(),
-    fail: sandbox.stub()
-  }
-
-  const generateEpub = await esmock('./index.js', {
-    '#helpers/os-utils.js': { dynamicImport: mockDynamicImport },
-    '#lib/project/index.js': mockPaths,
-    'fs-extra': mockFs,
-    '#lib/reporter/index.js': { default: mockReporter }
-  })
-
-  await generateEpub.default({ lib: 'epubjs' })
-
-  t.true(mockDynamicImport.calledOnce)
-  t.true(mockDynamicImport.firstCall.args[0].includes('epub.js'))
-  t.true(mockReporter.start.calledWith(sinon.match(/Epub\.js/)))
-})
-
-test('generateEpub resolves pandoc library correctly', async (t) => {
-  const { sandbox } = t.context
-
-  const mockEpubLib = sandbox.stub().resolves()
-  const mockDynamicImport = sandbox.stub().resolves({ default: mockEpubLib })
-  const mockWhich = sandbox.stub().returns('/usr/local/bin/pandoc')
-
-  const mockPaths = {
-    getProjectRoot: () => testPath('project'),
-    getEpubDir: () => '_epub'
-  }
-
-  const mockFs = {
-    existsSync: sandbox.stub().returns(true),
-    mkdirSync: sandbox.stub()
-  }
-
-  const mockReporter = {
-    start: sandbox.stub(),
-    detail: sandbox.stub(),
-    succeed: sandbox.stub(),
-    fail: sandbox.stub()
-  }
-
-  const generateEpub = await esmock('./index.js', {
-    '#helpers/os-utils.js': { dynamicImport: mockDynamicImport },
-    '#helpers/which.js': { default: mockWhich },
-    '#lib/project/index.js': mockPaths,
-    'fs-extra': mockFs,
-    '#lib/reporter/index.js': { default: mockReporter }
-  })
-
-  await generateEpub.default({ lib: 'pandoc' })
-
-  t.true(mockDynamicImport.firstCall.args[0].includes('pandoc.js'))
-  t.true(mockReporter.start.calledWith(sinon.match(/Pandoc/)))
-})
-
-test('generateEpub normalizes library name variations', async (t) => {
-  const { sandbox } = t.context
-
-  const mockEpubLib = sandbox.stub().resolves()
-  const mockDynamicImport = sandbox.stub().resolves({ default: mockEpubLib })
-  const mockWhich = sandbox.stub().returns('/usr/local/bin/pandoc')
-
-  const mockPaths = {
-    getProjectRoot: () => testPath('project'),
-    getEpubDir: () => '_epub'
-  }
-
-  const mockFs = {
-    existsSync: sandbox.stub().returns(true),
-    mkdirSync: sandbox.stub()
-  }
-
-  const mockReporter = {
-    start: sandbox.stub(),
-    detail: sandbox.stub(),
-    succeed: sandbox.stub(),
-    fail: sandbox.stub()
-  }
-
-  const generateEpub = await esmock('./index.js', {
-    '#helpers/os-utils.js': { dynamicImport: mockDynamicImport },
-    '#helpers/which.js': { default: mockWhich },
-    '#lib/project/index.js': mockPaths,
-    'fs-extra': mockFs,
-    '#lib/reporter/index.js': { default: mockReporter }
-  })
-
-  // Test "epub-js" variant (with hyphen)
-  await generateEpub.default({ lib: 'epub-js' })
-  t.true(mockDynamicImport.firstCall.args[0].includes('epub.js'))
-
-  // Test "PANDOC" variant (uppercase)
-  mockDynamicImport.resetHistory()
-  await generateEpub.default({ lib: 'PANDOC' })
-  t.true(mockDynamicImport.firstCall.args[0].includes('pandoc.js'))
-})
-
-test('generateEpub defaults to epubjs when no library specified', async (t) => {
-  const { sandbox } = t.context
-
-  const mockEpubLib = sandbox.stub().resolves()
-  const mockDynamicImport = sandbox.stub().resolves({ default: mockEpubLib })
-
-  const mockPaths = {
-    getProjectRoot: () => testPath('project'),
-    getEpubDir: () => '_epub'
-  }
-
-  const mockFs = {
-    existsSync: sandbox.stub().returns(true),
-    mkdirSync: sandbox.stub()
-  }
-
-  const mockReporter = {
-    start: sandbox.stub(),
-    detail: sandbox.stub(),
-    succeed: sandbox.stub(),
-    fail: sandbox.stub()
-  }
-
-  const generateEpub = await esmock('./index.js', {
-    '#helpers/os-utils.js': { dynamicImport: mockDynamicImport },
-    '#lib/project/index.js': mockPaths,
-    'fs-extra': mockFs,
-    '#lib/reporter/index.js': { default: mockReporter }
-  })
-
-  await generateEpub.default({})
-
-  t.true(mockDynamicImport.firstCall.args[0].includes('epub.js'))
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Error handling tests
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('generateEpub throws InvalidEpubLibraryError for unrecognized library', async (t) => {
-  const { sandbox } = t.context
-
-  const mockPaths = {
-    getProjectRoot: () => testPath('project'),
-    getEpubDir: () => '_epub'
-  }
-
-  const mockReporter = {
-    start: sandbox.stub(),
-    detail: sandbox.stub(),
-    succeed: sandbox.stub(),
-    fail: sandbox.stub()
-  }
-
-  const generateEpub = await esmock('./index.js', {
-    '#helpers/os-utils.js': { dynamicImport: sandbox.stub() },
-    '#lib/project/index.js': mockPaths,
-    'fs-extra': { existsSync: sandbox.stub(), mkdirSync: sandbox.stub() },
-    '#lib/reporter/index.js': { default: mockReporter }
-  })
-
-  const error = await t.throwsAsync(() => generateEpub.default({ lib: 'unknown-library' }))
-
-  t.is(error.code, 'INVALID_EPUB_LIBRARY')
-  t.true(error.message.includes('unknown-library'))
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Output path tests
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('generateEpub uses default output path based on library name', async (t) => {
-  const { sandbox } = t.context
-
-  const mockEpubLib = sandbox.stub().resolves()
-  const mockDynamicImport = sandbox.stub().resolves({ default: mockEpubLib })
-
-  const mockPaths = {
-    getProjectRoot: () => testPath('project'),
-    getEpubDir: () => '_epub'
-  }
-
-  const mockFs = {
-    existsSync: sandbox.stub().returns(true),
-    mkdirSync: sandbox.stub()
-  }
-
-  const mockReporter = {
-    start: sandbox.stub(),
-    detail: sandbox.stub(),
-    succeed: sandbox.stub(),
-    fail: sandbox.stub()
-  }
-
-  const generateEpub = await esmock('./index.js', {
-    '#helpers/os-utils.js': { dynamicImport: mockDynamicImport },
-    '#lib/project/index.js': mockPaths,
-    'fs-extra': mockFs,
-    '#lib/reporter/index.js': { default: mockReporter }
-  })
-
-  const output = await generateEpub.default({ lib: 'epubjs' })
-
-  t.is(output, path.join(testPath('project'), 'epubjs.epub'))
-})
-
-test('generateEpub uses custom output path when provided', async (t) => {
-  const { sandbox } = t.context
-
-  const mockEpubLib = sandbox.stub().resolves()
-  const mockDynamicImport = sandbox.stub().resolves({ default: mockEpubLib })
-
-  const mockPaths = {
-    getProjectRoot: () => testPath('project'),
-    getEpubDir: () => '_epub'
-  }
-
-  const mockFs = {
-    existsSync: sandbox.stub().returns(true),
-    mkdirSync: sandbox.stub()
-  }
-
-  const mockReporter = {
-    start: sandbox.stub(),
-    detail: sandbox.stub(),
-    succeed: sandbox.stub(),
-    fail: sandbox.stub()
-  }
-
-  const generateEpub = await esmock('./index.js', {
-    '#helpers/os-utils.js': { dynamicImport: mockDynamicImport },
-    '#lib/project/index.js': mockPaths,
-    'fs-extra': mockFs,
-    '#lib/reporter/index.js': { default: mockReporter }
-  })
-
-  const output = await generateEpub.default({ lib: 'epubjs', output: 'my-book.epub' })
-
-  t.is(output, path.join(testPath('project'), 'my-book.epub'))
-})
-
-test('generateEpub resolves relative output path against project root', async (t) => {
-  const { sandbox } = t.context
-
-  const mockEpubLib = sandbox.stub().resolves()
-  const mockDynamicImport = sandbox.stub().resolves({ default: mockEpubLib })
-
-  const mockPaths = {
-    getProjectRoot: () => testPath('project'),
-    getEpubDir: () => '_epub'
-  }
-
-  const mockFs = {
-    existsSync: sandbox.stub().returns(true),
-    mkdirSync: sandbox.stub()
-  }
-
-  const mockReporter = {
-    start: sandbox.stub(),
-    detail: sandbox.stub(),
-    succeed: sandbox.stub(),
-    fail: sandbox.stub()
-  }
-
-  const generateEpub = await esmock('./index.js', {
-    '#helpers/os-utils.js': { dynamicImport: mockDynamicImport },
-    '#lib/project/index.js': mockPaths,
-    'fs-extra': mockFs,
-    '#lib/reporter/index.js': { default: mockReporter }
-  })
-
-  const output = await generateEpub.default({ lib: 'epubjs', output: '_downloads/book' })
-
-  t.is(output, path.join(testPath('project'), '_downloads', 'book.epub'))
-})
-
-test('generateEpub uses absolute output path directly', async (t) => {
-  const { sandbox } = t.context
-
-  const mockEpubLib = sandbox.stub().resolves()
-  const mockDynamicImport = sandbox.stub().resolves({ default: mockEpubLib })
-
-  const mockPaths = {
-    getProjectRoot: () => testPath('project'),
-    getEpubDir: () => '_epub'
-  }
-
-  const mockFs = {
-    existsSync: sandbox.stub().returns(true),
-    mkdirSync: sandbox.stub()
-  }
-
-  const mockReporter = {
-    start: sandbox.stub(),
-    detail: sandbox.stub(),
-    succeed: sandbox.stub(),
-    fail: sandbox.stub()
-  }
-
-  const generateEpub = await esmock('./index.js', {
-    '#helpers/os-utils.js': { dynamicImport: mockDynamicImport },
-    '#lib/project/index.js': mockPaths,
-    'fs-extra': mockFs,
-    '#lib/reporter/index.js': { default: mockReporter }
-  })
-
-  const customPath = testPath('custom', 'path', 'book.epub')
-  const output = await generateEpub.default({ lib: 'epubjs', output: customPath })
-
-  t.is(output, customPath)
-})
-
-test('generateEpub adds .epub extension if missing', async (t) => {
-  const { sandbox } = t.context
-
-  const mockEpubLib = sandbox.stub().resolves()
-  const mockDynamicImport = sandbox.stub().resolves({ default: mockEpubLib })
-
-  const mockPaths = {
-    getProjectRoot: () => testPath('project'),
-    getEpubDir: () => '_epub'
-  }
-
-  const mockFs = {
-    existsSync: sandbox.stub().returns(true),
-    mkdirSync: sandbox.stub()
-  }
-
-  const mockReporter = {
-    start: sandbox.stub(),
-    detail: sandbox.stub(),
-    succeed: sandbox.stub(),
-    fail: sandbox.stub()
-  }
-
-  const generateEpub = await esmock('./index.js', {
-    '#helpers/os-utils.js': { dynamicImport: mockDynamicImport },
-    '#lib/project/index.js': mockPaths,
-    'fs-extra': mockFs,
-    '#lib/reporter/index.js': { default: mockReporter }
-  })
-
-  const output = await generateEpub.default({ lib: 'epubjs', output: 'my-book' })
-
-  t.is(output, path.join(testPath('project'), 'my-book.epub'))
-})
-
-test('generateEpub creates output directory if missing', async (t) => {
-  const { sandbox } = t.context
-
-  const mockEpubLib = sandbox.stub().resolves()
-  const mockDynamicImport = sandbox.stub().resolves({ default: mockEpubLib })
-
-  const mockPaths = {
-    getProjectRoot: () => testPath('project'),
-    getEpubDir: () => '_epub'
-  }
-
-  const mockFs = {
-    existsSync: sandbox.stub().returns(false),
-    mkdirSync: sandbox.stub()
-  }
-
-  const mockReporter = {
-    start: sandbox.stub(),
-    detail: sandbox.stub(),
-    succeed: sandbox.stub(),
-    fail: sandbox.stub()
-  }
-
-  const generateEpub = await esmock('./index.js', {
-    '#helpers/os-utils.js': { dynamicImport: mockDynamicImport },
-    '#lib/project/index.js': mockPaths,
-    'fs-extra': mockFs,
-    '#lib/reporter/index.js': { default: mockReporter }
-  })
-
-  await generateEpub.default({ lib: 'epubjs', output: '_downloads/book.epub' })
-
-  t.true(mockFs.mkdirSync.calledOnce)
-  t.is(mockFs.mkdirSync.firstCall.args[0], path.join(testPath('project'), '_downloads'))
-  t.deepEqual(mockFs.mkdirSync.firstCall.args[1], { recursive: true })
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// EPUB library invocation tests
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('generateEpub passes correct arguments to EPUB library', async (t) => {
-  const { sandbox } = t.context
-
-  const mockEpubLib = sandbox.stub().resolves()
-  const mockDynamicImport = sandbox.stub().resolves({ default: mockEpubLib })
-
-  const mockPaths = {
-    getProjectRoot: () => testPath('project'),
-    getEpubDir: () => '_epub'
-  }
-
-  const mockFs = {
-    existsSync: sandbox.stub().returns(true),
-    mkdirSync: sandbox.stub()
-  }
-
-  const mockReporter = {
-    start: sandbox.stub(),
-    detail: sandbox.stub(),
-    succeed: sandbox.stub(),
-    fail: sandbox.stub()
-  }
-
-  const generateEpub = await esmock('./index.js', {
-    '#helpers/os-utils.js': { dynamicImport: mockDynamicImport },
-    '#lib/project/index.js': mockPaths,
-    'fs-extra': mockFs,
-    '#lib/reporter/index.js': { default: mockReporter }
-  })
-
-  await generateEpub.default({ lib: 'epubjs', debug: true })
-
-  t.true(mockEpubLib.calledOnce)
-  const [input, output, options] = mockEpubLib.firstCall.args
-  t.is(input, path.join(testPath('project'), '_epub'))
-  t.is(output, path.join(testPath('project'), 'epubjs.epub'))
-  t.true(options.debug)
-})
-
-test('generateEpub passes options through to EPUB library', async (t) => {
-  const { sandbox } = t.context
-
-  const mockEpubLib = sandbox.stub().resolves()
-  const mockDynamicImport = sandbox.stub().resolves({ default: mockEpubLib })
-
-  const mockPaths = {
-    getProjectRoot: () => testPath('project'),
-    getEpubDir: () => '_epub'
-  }
-
-  const mockFs = {
-    existsSync: sandbox.stub().returns(true),
-    mkdirSync: sandbox.stub()
-  }
-
-  const mockReporter = {
-    start: sandbox.stub(),
-    detail: sandbox.stub(),
-    succeed: sandbox.stub(),
-    fail: sandbox.stub()
-  }
-
-  const generateEpub = await esmock('./index.js', {
-    '#helpers/os-utils.js': { dynamicImport: mockDynamicImport },
-    '#lib/project/index.js': mockPaths,
-    'fs-extra': mockFs,
-    '#lib/reporter/index.js': { default: mockReporter }
-  })
-
-  await generateEpub.default({
-    lib: 'epubjs',
-    debug: true,
-    customOption: 'value'
-  })
-
-  const [, , options] = mockEpubLib.firstCall.args
-  t.true(options.debug)
-  t.is(options.customOption, 'value')
-})

package/src/lib/epub/pandoc.test.js

@@ -1,122 +0,0 @@
-import esmock from 'esmock'
-import path from 'node:path'
-import sinon from 'sinon'
-import test from 'ava'
-
-/**
- * Pandoc EPUB Engine Integration Tests
- *
- * Tests error handling and logging paths that are difficult to trigger in E2E tests.
- * The happy path is covered by E2E tests with real Pandoc installation.
- */
-
-/**
- * Create a cross-platform absolute path for testing
- * @param {...string} segments - Path segments to join
- * @returns {string} Platform-appropriate absolute path
- */
-function testPath(...segments) {
-  const root = process.platform === 'win32' ? 'C:\\' : '/'
-  return path.join(root, ...segments)
-}
-
-test.beforeEach((t) => {
-  t.context.sandbox = sinon.createSandbox()
-
-  // Mock fs-extra
-  t.context.mockFs = {
-    readdirSync: t.context.sandbox.stub().returns(['chapter1.xhtml', 'chapter2.xhtml']),
-    lstatSync: t.context.sandbox.stub().returns({ isFile: () => true })
-  }
-})
-
-test.afterEach.always((t) => {
-  t.context.sandbox.restore()
-})
-
-test('pandoc logs stderr via debug when present', async (t) => {
-  const { sandbox, mockFs } = t.context
-
-  const mockExeca = sandbox.stub().resolves({ stderr: 'warning: deprecated option used' })
-  const mockDebug = sandbox.stub()
-  const mockCreateDebug = sandbox.stub().returns(mockDebug)
-
-  const pandoc = await esmock('./pandoc.js', {
-    execa: { execa: mockExeca },
-    'fs-extra': mockFs,
-    '#debug': { default: mockCreateDebug }
-  })
-
-  await pandoc.default(testPath('input'), testPath('output.epub'), {})
-
-  t.true(mockDebug.calledWith('pandoc stderr: %s', 'warning: deprecated option used'))
-})
-
-test('pandoc does not log stderr when empty', async (t) => {
-  const { sandbox, mockFs } = t.context
-
-  const mockExeca = sandbox.stub().resolves({ stderr: '' })
-  const mockDebug = sandbox.stub()
-  const mockCreateDebug = sandbox.stub().returns(mockDebug)
-
-  const pandoc = await esmock('./pandoc.js', {
-    execa: { execa: mockExeca },
-    'fs-extra': mockFs,
-    '#debug': { default: mockCreateDebug }
-  })
-
-  await pandoc.default(testPath('input'), testPath('output.epub'), {})
-
-  t.false(mockDebug.calledWith(sinon.match('pandoc stderr')))
-})
-
-test('pandoc throws EpubGenerationError when execa fails', async (t) => {
-  const { sandbox, mockFs } = t.context
-
-  const execaError = new Error('Pandoc failed')
-  execaError.stderr = 'error: unknown input format'
-
-  const mockExeca = sandbox.stub().rejects(execaError)
-
-  const pandoc = await esmock('./pandoc.js', {
-    execa: { execa: mockExeca },
-    'fs-extra': mockFs
-  })
-
-  const error = await t.throwsAsync(() =>
-    pandoc.default(testPath('input'), testPath('output.epub'), {})
-  )
-
-  t.is(error.code, 'EPUB_FAILED')
-  // EpubGenerationError formats message as: "EPUB generation failed: <details>"
-  // where <details> includes tool name, operation, and stderr/message
-  t.true(error.message.includes('EPUB generation failed'))
-  t.true(error.message.includes('Pandoc'))
-  t.true(error.message.includes('unknown input format'))
-})
-
-test('pandoc filters only XHTML files from input directory', async (t) => {
-  const { sandbox } = t.context
-
-  const mockExeca = sandbox.stub().resolves({ stderr: '' })
-
-  // Mock readdirSync to return mixed files
-  const mockFs = {
-    readdirSync: sandbox.stub().returns(['chapter1.xhtml', 'image.png', 'chapter2.xhtml', 'style.css']),
-    lstatSync: sandbox.stub().returns({ isFile: () => true })
-  }
-
-  const pandoc = await esmock('./pandoc.js', {
-    execa: { execa: mockExeca },
-    'fs-extra': mockFs
-  })
-
-  await pandoc.default(testPath('input'), testPath('output.epub'), {})
-
-  // Verify only XHTML files were passed to pandoc
-  const [, args] = mockExeca.firstCall.args
-  const inputFiles = args.filter(arg => arg.endsWith('.xhtml'))
-  t.is(inputFiles.length, 2)
-  t.true(inputFiles[0].endsWith('chapter1.xhtml'))
-  t.true(inputFiles[1].endsWith('chapter2.xhtml'))
-})

package/src/lib/epub/schema.js

@@ -1,21 +0,0 @@
-/**
- * EPUB engine schema definition
- *
- * This module has NO imports to avoid circular dependencies.
- * It serves as the single source of truth for EPUB engine options.
- */
-
-/**
- * Supported EPUB engines
- * @type {string[]}
- */
-export const ENGINES = ['epubjs', 'pandoc']
-
-/**
- * Schema definition for epubEngine config property
- */
-export const schema = {
-  type: 'string',
-  enum: ENGINES,
-  description: 'Default EPUB engine to use (epubjs, pandoc)'
-}