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

package/src/lib/conf/defaults.js

@@ -5,56 +5,10 @@
  * @see https://github.com/sindresorhus/conf#defaults
  */
 export default {
-  /**
-   * Enable debug output by default (DEBUG=quire:* namespace logging).
-   * Can be overridden per-command with --debug or --no-debug.
-   */
-  debug: false,
-  /**
-   * Default EPUB engine for quire epub command.
-   */
-  epubEngine: 'epubjs',
   /**
    * Logging level for the Quire CLI output.
    */
   logLevel: 'info',
-  /**
-   * Prefix text for log output messages.
-   */
-  logPrefix: 'quire',
-  /**
-   * Style of the log prefix.
-   * - 'bracket': [quire] message
-   * - 'emoji': 📖 message
-   * - 'plain': quire: message
-   * - 'none': message (no prefix)
-   */
-  logPrefixStyle: 'bracket',
-  /**
-   * Whether to show log level labels (INFO, WARN, ERROR).
-   * Defaults to false for cleaner user output.
-   */
-  logShowLevel: false,
-  /**
-   * Whether to use colored output in terminal.
-   */
-  logUseColor: true,
-  /**
-   * Whether to color message text by log level (e.g., red for errors).
-   * Requires logUseColor to be enabled.
-   */
-  logColorMessages: true,
-  /**
-   * Default PDF engine for quire pdf command.
-   */
-  pdfEngine: 'pagedjs',
-  /**
-   * Disable spinner animation and line overwriting.
-   * When enabled, progress output uses static text instead of animated spinners,
-   * and each stage prints on a new line rather than overwriting the current line.
-   * Can be overridden per-command with --reduced-motion.
-   */
-  reducedMotion: false,
   /**
    * Project starter template to use when creating new projects.
    */
@@ -63,15 +17,6 @@ export default {
    * Relative path to quire-11ty installed in the project directory.
    */
   quire11tyPath: '.',
-  /**
-   * How stale an output must be before `quire doctor` warns.
-   * - 'ZERO': any time difference (0 minutes)
-   * - 'SHORT': 5 minutes
-   * - 'HOURLY': 60 minutes (default)
-   * - 'DAILY': 12 hours
-   * - 'NEVER': disable stale output warnings
-   */
-  staleThreshold: 'HOURLY',
   /**
    * Version of quire-11ty to install when creating new projects.
    */
@@ -85,18 +30,8 @@ export default {
    * and to quire-11ty version for a prject.
    */
   updateInterval: 'DAILY',
-  /**
-   * Enable verbose output by default (detailed progress with paths, timing).
-   * Can be overridden per-command with --verbose or --no-verbose.
-   */
-  verbose: false,
   /**
    * File name for the quire-11ty version file.
    */
   versionFile: '.quire',
-  /**
-   * Per-project data (internal).
-   * Keyed by SHA-256 hash of the project's absolute path.
-   */
-  projects: {},
 }

package/src/lib/conf/schema.js

@@ -2,123 +2,29 @@
  * Quire configuration schema
  * @see https://github.com/sindresorhus/conf#schema
  *
- * Nota bene: default values here are overwritten by values in defaults.js
+ * Nota bene: schema default values will are overwritten by `defaults.js` values
  * @see https://github.com/sindresorhus/conf#defaults
  */
-import { schema as epubEngineSchema } from '#lib/epub/schema.js'
-import { schema as pdfEngineSchema } from '#lib/pdf/schema.js'
-
 export default {
-  debug: {
-    type: 'boolean',
-    description: 'Enable debug output by default (equivalent to --debug flag)'
-  },
-  epubEngine: epubEngineSchema,
-  pdfEngine: pdfEngineSchema,
   logLevel: {
-    type: 'string',
-    enum: ['trace', 'debug', 'info', 'warn', 'error', 'silent'],
-    description: 'Minimum log level to display (trace, debug, info, warn, error, silent)'
-  },
-  logPrefix: {
-    type: 'string',
-    description: 'Prefix text shown before log messages'
-  },
-  logPrefixStyle: {
-    type: 'string',
-    enum: ['bracket', 'emoji', 'plain', 'none'],
-    description: 'Style for displaying the log prefix (bracket: [quire], emoji: 📖, plain: quire:, none: no prefix)'
-  },
-  logShowLevel: {
-    type: 'boolean',
-    description: 'Show log level label (INFO, WARN, etc.) in output'
-  },
-  logUseColor: {
-    type: 'boolean',
-    description: 'Use colored output for log messages'
-  },
-  logColorMessages: {
-    type: 'boolean',
-    description: 'Color message text by log level (e.g., red for errors). Requires logUseColor'
-  },
-  reducedMotion: {
-    type: 'boolean',
-    description: 'Disable spinner animation and line overwriting (for screen readers and reduced-motion preferences)'
+    type: 'string'
   },
   projectTemplate: {
-    type: 'string',
-    format: 'uri',
-    description: 'URL of the default project template for quire new'
+    type: 'string'
   },
   quire11tyPath: {
-    type: 'string',
-    description: 'Path to the quire-11ty package (use "." for local development)'
-  },
-  staleThreshold: {
-    type: 'string',
-    enum: ['ZERO', 'SHORT', 'HOURLY', 'DAILY', 'NEVER'],
-    description: 'How stale an output must be before doctor warns (ZERO=0m, SHORT=5m, HOURLY=60m, DAILY=12h, NEVER=disabled)'
+    type: 'string'
   },
   quireVersion: {
-    type: 'string',
-    description: 'Version of quire-11ty to use ("latest" or specific version)'
+    type: 'string'
   },
   updateChannel: {
-    type: 'string',
-    enum: ['stable', 'rc', 'beta', 'alpha'],
-    description: 'Release channel for updates (stable, rc, beta, alpha)'
+    type: 'string'
   },
   updateInterval: {
-    type: 'string',
-    enum: ['DAILY', 'WEEKLY', 'MONTHLY', 'NEVER'],
-    description: 'How often to check for updates (DAILY, WEEKLY, MONTHLY, NEVER)'
-  },
-  verbose: {
-    type: 'boolean',
-    description: 'Enable verbose output by default (equivalent to --verbose flag)'
+    type: 'string'
   },
   versionFile: {
-    type: 'string',
-    description: 'Filename used to identify Quire projects'
-  },
-  projects: {
-    type: 'object',
-    description: 'Per-project data keyed by hashed project path (internal)',
-    additionalProperties: {
-      type: 'object',
-      properties: {
-        projectPath: { type: 'string' },
-        buildStatus: {
-          type: 'object',
-          properties: {
-            build: {
-              type: 'object',
-              properties: {
-                status: { type: 'string', enum: ['ok', 'failed'] },
-                timestamp: { type: 'number' },
-              },
-              required: ['status', 'timestamp'],
-            },
-            pdf: {
-              type: 'object',
-              properties: {
-                status: { type: 'string', enum: ['ok', 'failed'] },
-                timestamp: { type: 'number' },
-              },
-              required: ['status', 'timestamp'],
-            },
-            epub: {
-              type: 'object',
-              properties: {
-                status: { type: 'string', enum: ['ok', 'failed'] },
-                timestamp: { type: 'number' },
-              },
-              required: ['status', 'timestamp'],
-            },
-          },
-        },
-      },
-      required: ['projectPath'],
-    },
-  },
+    type: 'string'
+  }
 }

package/src/lib/epub/README.md

@@ -1,138 +1,7 @@
 ## CLI lib/EPUB Module
 
-This module provides an abstraction for EPUB e-book generation across Epub.js and Pandoc. The exported function accepts a `lib` option and dynamically loads the corresponding engine façade.
-
-### Architecture
-
-```
-┌───────────────────────────────────────────────────────────┐
-│                lib/epub/index.js (Façade)                 │
-│  • Resolve engine (epubjs/pandoc)                         │
-│  • Check engine availability (fail-fast)                  │
-│  • Resolve output path (CLI > default)                    │
-│  • Own reporter lifecycle (start/succeed/fail)            │
-│  • Dynamic import of engine implementation                │
-└───────────────────────────┬───────────────────────────────┘
-                            │
-              ┌─────────────┴─────────────────┐
-              │     lib/epub/engines.js       │
-              │  • Central engine registry    │
-              │  • Metadata (name, binary,    │
-              │    toolInfo for errors)       │
-              └─────────────┬─────────────────┘
-                            │
-           ┌────────────────┴────────────────────┐
-           │                                     │
-┌──────────▼───────────┐             ┌───────────▼────────────┐
-│  lib/epub/epub.js    │             │  lib/epub/pandoc.js    │
-│  • Epub.js wrapper   │             │  • Pandoc CLI wrapper  │
-│  • Load manifest     │             │  • Filter XHTML files  │
-│  • Generate EPUB     │             │  • Invoke pandoc       │
-│  • Write file        │             │  • Write file          │
-└──────────────────────┘             └────────────────────────┘
-```
-
-### Usage
-
-```javascript
-import generateEpub from '#lib/epub/index.js'
-
-// Generate EPUB with Epub.js (default)
-const output = await generateEpub({
-  lib: 'epubjs',
-  output: 'my-book.epub',
-  reporter,
-})
-
-// Generate EPUB with Pandoc
-const output = await generateEpub({
-  lib: 'pandoc',
-  output: 'my-book.epub',
-  reporter,
-})
-```
-
-### Options
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `lib` | string | `'epubjs'` | Engine to use: `'epubjs'` or `'pandoc'` |
-| `output` | string | `'{lib}.epub'` | Output file path |
-| `reporter` | object | required | Reporter instance for progress messages |
-| `debug` | boolean | `false` | Enable debug output |
-
-### Output Path Resolution
-
-The output path is resolved in priority order:
-1. CLI `--output` option value
-2. Default: `{lib}.epub` (e.g., `epubjs.epub` or `pandoc.epub`)
-
-Relative paths are resolved against the project root. The `.epub` extension is auto-added if missing.
+This module implements a façade for EPUB e-book file format generation libries. The module exports a single method that accepts a `lib` option and delegates to a façade for the specified EPUB library.
 
 ### Epub.js Façade
 
-Wraps the [`epubjs-cli`](https://github.com/futurepress/epubjs-cli) package for EPUB generation.
-
-**How it works:**
-1. Loads `manifest.json` from the build output directory
-2. Uses `ManifestToEpub` to generate the EPUB content
-3. Writes the generated file to the output path
-
-See the [Epub.js documentation](https://github.com/futurepress/epub.js) for more details.
-
-### Pandoc Façade
-
-Wraps the [Pandoc](https://pandoc.org/) command-line tool for EPUB generation.
-
-**How it works:**
-1. Filters XHTML files from the build output
-2. Invokes `pandoc` with appropriate options
-3. Writes the generated EPUB to the output path
-
-**Requirements:** Pandoc must be installed and available in PATH.
-
-See the [Pandoc documentation](https://pandoc.org/MANUAL.html#creating-epubs-with-pandoc) for EPUB-specific options.
-
-### Engine Availability Check
-
-The façade performs a fail-fast check before starting the reporter:
-
-```javascript
-// Runs BEFORE reporter.start()
-checkEngineAvailable(engine)  // Throws ToolNotFoundError if binary missing
-```
-
-- **Epub.js:** No binary check needed (pure JavaScript)
-- **Pandoc:** Checks for `pandoc` in PATH
-
-If the engine is unavailable, a `ToolNotFoundError` is thrown with:
-- Install URL for the missing tool
-- Fallback suggestion (use default engine)
-- Link to documentation
-
-### Error Handling
-
-The module uses typed errors for consistent error handling:
-
-| Error | When Thrown |
-|-------|-------------|
-| `InvalidEpubLibraryError` | Unknown engine name provided |
-| `EpubGenerationError` | Generation fails (with tool/operation context) |
-| `ToolNotFoundError` | Required binary not found in PATH |
-
-### Test Strategy
-
-| Component | Test Type | Coverage |
-|-----------|-----------|----------|
-| `commands/epub.js` | spec + integration | CLI interface, option handling |
-| `lib/epub/index.js` | integration | Façade logic, path resolution, engine dispatch |
-| `lib/epub/epub.js` | E2E | Happy path via full generation |
-| `lib/epub/pandoc.js` | E2E | Happy path via full generation |
-
-The engine implementations (`epub.js`, `pandoc.js`) are thin wrappers with limited logic, so E2E tests provide sufficient coverage. Error path tests would have lower ROI compared to the PDF module's `split.js`.
-
-### Related Documentation
-
-- [EPUB Command](../../commands/epub.js) - CLI command implementation
-- [Reporter Pattern](../reporter/README.md) - Progress reporting ownership
-- [Error Classes](../../errors/output/) - Typed error definitions
+See the [`Epub.js` documentation](https://github.com/futurepress/epub.js).

package/src/lib/epub/epub.js

@@ -1,52 +1,27 @@
 import { ManifestToEpub } from 'epubjs-cli'
 import fs from 'fs-extra'
 import { pathToFileURL } from 'node:url'
-import { EpubGenerationError } from '#src/errors/index.js'
-import createDebug from '#debug'
-import ENGINES from './engines.js'
-
-const debug = createDebug('lib:epub:epubjs')
-
-/** Re-export engine metadata from central registry */
-export const metadata = ENGINES.epubjs
 
 /**
  * A façade module for the EPUB.js library
  * @see https://github.com/futurepress/epubjs-cli
- *
- * @param {string} input - Path to the input directory containing manifest.json
- * @param {string} output - Path where the EPUB should be written
- * @param {Object} [options={}] - Generation options
- * @returns {Promise<void>}
  */
 export default async (input, output, options = {}) => {
-  debug('input: %s', input)
-  debug('output: %s', output)
+  try {
+    console.info(`[CLI:lib/epub/epubjs] Generating ePub from ${input}`)
 
-  const url = pathToFileURL(`${input}/manifest.json`).toString()
+    const url = pathToFileURL(`${input}/manifest.json`).toString()
 
-  let epub
-  try {
-    epub = await new ManifestToEpub(url)
-  } catch (error) {
-    throw new EpubGenerationError('Epub.js', 'manifest loading', error.message)
-  }
+    const epub = await new ManifestToEpub(url)
+      .catch((error) => console.error(error))
 
-  let file
-  try {
-    file = await epub.save()
-  } catch (error) {
-    throw new EpubGenerationError('Epub.js', 'file generation', error.message)
-  }
+    const file = await epub.save()
+      .catch((error) => console.error(error))
 
-  if (file && output) {
-    debug('writing EPUB to %s', output)
-    try {
-      await fs.writeFile(output, file)
-    } catch (error) {
-      throw new EpubGenerationError('Epub.js', 'file write', error.message)
+    if (file && output) {
+      fs.writeFile(output, file, (error) => { if (error) throw error })
     }
+  } catch (ERR_FILE_NOT_FOUND) {
+    console.error(`[CLI:lib/epub/epubjs] file not found ${input}`)
   }
-
-  debug('complete')
 }

package/src/lib/epub/index.js

@@ -1,130 +1,40 @@
 import { dynamicImport } from '#helpers/os-utils.js'
-import which from '#helpers/which.js'
 import { fileURLToPath } from 'node:url'
 import path from 'node:path'
-import fs from 'fs-extra'
-import paths from '#lib/project/index.js'
-import reporter from '#lib/reporter/index.js'
-import { InvalidEpubLibraryError } from '#src/errors/index.js'
-import createDebug from '#debug'
-import ENGINE_METADATA from './engines.js'
-import { ENGINES } from './schema.js'
-
-export { ENGINES }
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
 
-const debug = createDebug('lib:epub')
-
 /**
- * Resolve the EPUB library implementation
- *
- * @param {string} name - Library name to resolve
- * @returns {Object} Resolved engine with absolute module path
- * @throws {InvalidEpubLibraryError} When library name is not recognized
+ * A façade delegation module for EPUB libraries
  */
-function resolveLibrary(name) {
+export default async (name = 'epubjs', options = {}) => {
+  const lib = { name, options, path }
+
   const normalizedName = name.replace(/[-_.\s]/g, '').toLowerCase()
 
   switch (normalizedName) {
-    case 'epubjs':
-    case 'epub':
-      return { ...ENGINE_METADATA.epubjs, path: path.join(__dirname, ENGINE_METADATA.epubjs.module) }
-    case 'pandoc':
-      return { ...ENGINE_METADATA.pandoc, path: path.join(__dirname, ENGINE_METADATA.pandoc.module) }
+    case 'epubjs': {
+      lib.name = 'Epub.js'
+      lib.options = {}
+      lib.path = path.join(__dirname, 'epub.js')
+      break
+    }
+    case 'pandoc': {
+      lib.name = 'Pandoc'
+      lib.options = {}
+      lib.path = path.join(__dirname, 'pandoc.js')
+      break
+    }
     default:
-      throw new InvalidEpubLibraryError(name)
-  }
-}
-
-/**
- * Check if the required binary for an engine is available
- *
- * @param {Object} engine - Engine definition from ENGINES
- * @throws {ToolNotFoundError} When required binary is not in PATH
- */
-function checkEngineAvailable(engine) {
-  if (!engine.requiresBinary) {
-    return // No binary required (e.g., epubjs uses Node.js)
+      console.error(`[CLI:lib/pdf] Unrecognized EPUB library '${name}'`)
+      return
   }
 
-  const result = which(engine.requiresBinary, engine.toolInfo)
-  debug('found %s at %s', engine.requiresBinary, result)
-}
-
-/**
- * Construct the default output path for the EPUB
- */
-function getOutputPath(projectRoot, libName) {
-  return path.join(projectRoot, `${libName}.epub`)
-}
-
-/**
- * Resolve a custom output path, handling relative paths and ensuring .epub extension
- *
- * @param {string} customOutput - User-provided output path
- * @param {string} projectRoot - Project root directory
- * @returns {string} Resolved absolute path with .epub extension
- */
-function resolveOutputPath(customOutput, projectRoot) {
-  // Resolve relative paths against project root
-  const resolved = path.isAbsolute(customOutput)
-    ? customOutput
-    : path.join(projectRoot, customOutput)
-
-  // Ensure .epub extension
-  return resolved.endsWith('.epub') ? resolved : `${resolved}.epub`
-}
-
-/**
- * Generate an EPUB from the built publication
- *
- * @param {Object} options - Generation options
- * @param {string} [options.lib='epubjs'] - EPUB library to use ('epubjs' or 'pandoc')
- * @param {string} [options.output] - Custom output path (relative to project root or absolute)
- * @param {boolean} [options.debug] - Enable debug output
- * @returns {Promise<string>} Absolute path to the generated EPUB file
- */
-export default async function generateEpub(options = {}) {
-  const libName = options.lib || 'epubjs'
-  const lib = resolveLibrary(libName)
-
-  debug('resolved library: %s → %s', libName, lib.name)
-
-  // Check engine availability BEFORE starting reporter (fail fast with clean error)
-  checkEngineAvailable(lib)
-
-  const projectRoot = paths.getProjectRoot()
-  const inputDir = path.join(projectRoot, paths.getEpubDir())
-
-  // Resolve output path from user option or default to {libName}.epub
-  const epubPath = options.output
-    ? resolveOutputPath(options.output, projectRoot)
-    : getOutputPath(projectRoot, libName)
-
-  // Ensure parent directory exists (epub generators use fs.writeFile directly)
-  const epubDir = path.dirname(epubPath)
-  if (!fs.existsSync(epubDir)) {
-    fs.mkdirSync(epubDir, { recursive: true })
-  }
-
-  debug('input: %s', inputDir)
-  debug('output: %s', epubPath)
-
   const { default: epubLib } = await dynamicImport(lib.path)
 
-  reporter.start(`Generating EPUB using ${lib.name}...`, { showElapsed: true })
-  reporter.detail(`Input: ${inputDir}`)
-  reporter.detail(`Output: ${epubPath}`)
-
-  try {
-    await epubLib(inputDir, epubPath, options)
-    reporter.succeed(`EPUB saved to ${epubPath}`)
-  } catch (error) {
-    reporter.fail(`EPUB generation failed`)
-    throw error
+  return async (input, output) => {
+    console.info(`[CLI:lib/epub] generating EPUB using ${lib.name}`)
+    return await epubLib(input, output, lib.options)
   }
-
-  return epubPath
 }

package/src/lib/epub/pandoc.js

@@ -1,14 +1,8 @@
 import { execa } from 'execa'
 import fs from 'fs-extra'
 import path from 'node:path'
-import { EpubGenerationError } from '#src/errors/index.js'
-import createDebug from '#debug'
-import ENGINES from './engines.js'
-
-const debug = createDebug('lib:epub:pandoc')
-
-/** Re-export engine metadata from central registry */
-export const metadata = ENGINES.pandoc
+import paths, { projectRoot } from '#lib/11ty/paths.js'
+import which from '#helpers/which.js'
 
 /**
  * Filter directory entries for XHTML files
@@ -25,18 +19,9 @@ const xhtmlFiles = (dirent) => {
 /**
  * A façade module for interacting with Pandoc CLI.
  * @see https://pandoc.org/MANUAL.html#general-options
- *
- * Pandoc availability is checked by the parent façade (lib/epub/index.js)
- * before this module is loaded, so we can assume pandoc is in PATH.
- *
- * @param {string} input - Path to the input directory containing XHTML files
- * @param {string} output - Path where the EPUB should be written
- * @param {Object} [options={}] - Generation options
- * @returns {Promise<void>}
  */
 export default async (input, output, options = {}) => {
-  debug('input: %s', input)
-  debug('output: %s', output)
+  which('pandoc')
 
   const inputs = fs.readdirSync(input)
     .map((entry) => path.join(input, entry))
@@ -53,19 +38,5 @@ export default async (input, output, options = {}) => {
     `--standalone`,
   ]
 
-  debug('cmd options: %O', cmdOptions)
-  debug('inputs: %d XHTML files', inputs.length)
-
-  try {
-    const { stderr } = await execa('pandoc', [...cmdOptions, ...inputs])
-    // Pandoc may emit warnings to stderr even on success
-    if (stderr) {
-      debug('pandoc stderr: %s', stderr)
-    }
-  } catch (error) {
-    const details = error.stderr || error.message
-    throw new EpubGenerationError(`Pandoc EPUB generation failed: ${details}`)
-  }
-
-  debug('complete')
+  await execa('pandoc', [...cmdOptions, ...inputs])
 }