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

package/src/commands/validate.spec.js

@@ -1,90 +0,0 @@
-import { Command, Option } from 'commander'
-import program from '#src/main.js'
-import test from 'ava'
-
-/**
- * Command Contract/Interface Tests
- *
- * Verifies the command's public API and Commander.js integration.
- * @see docs/testing-commands.md
- */
-
-test.before((t) => {
-  // Get the registered command (from program.commands) once and share across all tests
-  t.context.command = program.commands.find((cmd) => cmd.name() === 'validate')
-})
-
-test('command is registered in CLI program', (t) => {
-  const { command } = t.context
-
-  t.truthy(command, 'command "validate" should be registered in program')
-  t.true(command instanceof Command, 'registered command should be Commander.js Command instance')
-})
-
-test('registered command has correct metadata', (t) => {
-  const { command } = t.context
-
-  t.is(command.name(), 'validate')
-  t.truthy(command.description())
-  t.is(typeof command._actionHandler, 'function', 'command should have action handler')
-})
-
-test('registered command has no arguments', (t) => {
-  const { command } = t.context
-  const registeredArguments = command.registeredArguments
-
-  t.is(registeredArguments.length, 0, 'validate command should have no arguments')
-})
-
-test('registered command has correct options', (t) => {
-  const { command } = t.context
-
-  // Get all options
-  const jsonOption = command.options.find((opt) => opt.long === '--json')
-  const quietOption = command.options.find((opt) => opt.long === '--quiet')
-  const verboseOption = command.options.find((opt) => opt.long === '--verbose')
-  const debugOption = command.options.find((opt) => opt.long === '--debug')
-
-  // Verify all options exist
-  t.truthy(jsonOption, '--json option should exist')
-  t.truthy(quietOption, '--quiet option should exist')
-  t.truthy(verboseOption, '--verbose option should exist')
-  t.truthy(debugOption, '--debug option should exist')
-
-  // Verify they are Option instances
-  t.true(jsonOption instanceof Option, '--json should be Option instance')
-  t.true(quietOption instanceof Option, '--quiet should be Option instance')
-  t.true(verboseOption instanceof Option, '--verbose should be Option instance')
-  t.true(debugOption instanceof Option, '--debug should be Option instance')
-
-  // Verify option properties
-  t.is(jsonOption.long, '--json')
-  t.truthy(jsonOption.description)
-  t.false(jsonOption.required, '--json should not require a value')
-
-  t.is(quietOption.long, '--quiet')
-  t.is(quietOption.short, '-q')
-  t.truthy(quietOption.description)
-  t.false(quietOption.required, '--quiet should not require a value')
-
-  t.is(verboseOption.long, '--verbose')
-  t.is(verboseOption.short, '-v')
-  t.truthy(verboseOption.description)
-  t.false(verboseOption.required, '--verbose should not require a value')
-
-  t.is(debugOption.long, '--debug')
-  t.truthy(debugOption.description)
-  t.false(debugOption.required, '--debug should not require a value')
-})
-
-test('command options are accessible via public API', (t) => {
-  const { command } = t.context
-
-  // Test that options can be accessed the way Commander.js does
-  const optionNames = command.options.map((opt) => opt.long)
-
-  t.true(optionNames.includes('--json'))
-  t.true(optionNames.includes('--quiet'))
-  t.true(optionNames.includes('--verbose'))
-  t.true(optionNames.includes('--debug'))
-})

package/src/commands/validate.test.js

@@ -1,378 +0,0 @@
-import test from 'ava'
-import { Volume, createFsFromVolume } from 'memfs'
-import sinon from 'sinon'
-import esmock from 'esmock'
-import { ValidationError } from '#src/errors/index.js'
-
-test.beforeEach((t) => {
-  // Create sinon sandbox for mocking
-  t.context.sandbox = sinon.createSandbox()
-
-  // Create in-memory file system
-  t.context.vol = new Volume()
-  t.context.fs = createFsFromVolume(t.context.vol)
-
-  // Setup mock directory structure
-  t.context.vol.fromJSON({
-    '/project/content/_data/config.yaml': 'title: Quire Test Project\nidentifier:\n  isbn: "978-0-12345-678-9"',
-    '/project/content/_data/publication.yaml': 'title: Test Publication',
-    '/project/package.json': JSON.stringify({ name: 'test-project' })
-  })
-
-  t.context.projectRoot = '/project'
-
-  // Stub console methods to suppress output during tests
-  // Create mock logger (no global console stubbing needed!)
-  t.context.mockLogger = {
-    info: t.context.sandbox.stub(),
-    error: t.context.sandbox.stub(),
-    debug: t.context.sandbox.stub(),
-    log: t.context.sandbox.stub(),
-    warn: t.context.sandbox.stub()
-  }
-  // mockLogger already created above
-  // mockLogger already created above
-})
-
-test.afterEach.always((t) => {
-  // Restore all mocks
-  t.context.sandbox.restore()
-
-  // Clear in-memory file system
-  t.context.vol.reset()
-})
-
-test('validate command should find and validate YAML files', async (t) => {
-  const { sandbox, fs, mockLogger } = t.context
-
-  // Mock yamlValidation function
-  const mockYamlValidation = sandbox.stub()
-
-  // Mock testcwd helper
-  const mockTestcwd = sandbox.stub()
-
-  // Use esmock to replace imports
-  const ValidateCommand = await esmock('./validate.js', {
-    '../validators/validate-yaml.js': {
-      default: mockYamlValidation
-    },
-    '#lib/project/index.js': {
-      default: { getProjectRoot: () => '/project' }
-    },
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/logger/index.js': {
-      logger: mockLogger
-    },
-    'fs-extra': fs
-  })
-
-  const command = new ValidateCommand()
-  command.name = sandbox.stub().returns('validate')
-
-  // Run action
-  command.action({}, command)
-
-  // Should validate both YAML files
-  t.true(mockYamlValidation.callCount >= 2, 'should validate multiple YAML files')
-})
-
-test('validate command should handle validation errors', async (t) => {
-  const { sandbox, fs, mockLogger } = t.context
-
-  // Mock yamlValidation function to throw error
-  const validationError = new Error('Invalid YAML')
-  validationError.reason = 'Invalid YAML: missing required field'
-  const mockYamlValidation = sandbox.stub().throws(validationError)
-
-  // Mock testcwd helper
-  const mockTestcwd = sandbox.stub()
-
-  // Use esmock to replace imports
-  const ValidateCommand = await esmock('./validate.js', {
-    '../validators/validate-yaml.js': {
-      default: mockYamlValidation
-    },
-    '#lib/project/index.js': {
-      default: { getProjectRoot: () => '/project' }
-    },
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/logger/index.js': {
-      logger: mockLogger
-    },
-    'fs-extra': fs
-  })
-
-  const command = new ValidateCommand()
-  command.name = sandbox.stub().returns('validate')
-  command.logger = mockLogger
-
-  // Run action - should throw ValidationError when there are validation errors
-  const error = t.throws(() => command.action({}, command), { instanceOf: ValidationError })
-
-  t.is(error.code, 'VALIDATION_FAILED', 'error should have correct code')
-  t.is(error.exitCode, 4, 'error should have validation exit code')
-  t.true(mockYamlValidation.called, 'validation should be attempted')
-  t.true(mockLogger.error.called, 'errors should be logged')
-})
-
-test('validate command should call testcwd in preAction', async (t) => {
-  const { sandbox, fs, mockLogger } = t.context
-
-  // Mock yamlValidation function
-  const mockYamlValidation = sandbox.stub()
-
-  // Mock testcwd helper
-  const mockTestcwd = sandbox.stub()
-
-  // Use esmock to replace imports
-  const ValidateCommand = await esmock('./validate.js', {
-    '../validators/validate-yaml.js': {
-      default: mockYamlValidation
-    },
-    '#lib/project/index.js': {
-      default: { getProjectRoot: () => '/project' }
-    },
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/logger/index.js': {
-      logger: mockLogger
-    },
-    'fs-extra': fs
-  })
-
-  const command = new ValidateCommand()
-  command.name = sandbox.stub().returns('validate')
-
-  // Run preAction
-  command.preAction({}, command)
-
-  t.true(mockTestcwd.called, 'testcwd should be called in preAction')
-})
-
-test('validate command should filter YAML files correctly', async (t) => {
-  const { sandbox, fs, vol, mockLogger } = t.context
-
-  // Add non-YAML files
-  vol.fromJSON({
-    '/project/content/_data/data.json': '{"key": "value"}',
-    '/project/content/_data/README.md': '# README',
-    '/project/content/_data/script.js': 'console.log("test")'
-  })
-
-  // Mock yamlValidation function
-  const mockYamlValidation = sandbox.stub()
-
-  // Mock testcwd helper
-  const mockTestcwd = sandbox.stub()
-
-  // Use esmock to replace imports
-  const ValidateCommand = await esmock('./validate.js', {
-    '../validators/validate-yaml.js': {
-      default: mockYamlValidation
-    },
-    '#lib/project/index.js': {
-      default: { getProjectRoot: () => '/project' }
-    },
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/logger/index.js': {
-      logger: mockLogger
-    },
-    'fs-extra': fs
-  })
-
-  const command = new ValidateCommand()
-  command.name = sandbox.stub().returns('validate')
-
-  // Run action
-  command.action({}, command)
-
-  // Should only validate YAML files (config.yaml and publication.yaml from beforeEach)
-  t.is(mockYamlValidation.callCount, 2, 'should only validate YAML files')
-})
-
-test('validate command should pass debug option through', async (t) => {
-  const { sandbox, fs, mockLogger } = t.context
-
-  // Mock yamlValidation function
-  const mockYamlValidation = sandbox.stub()
-
-  // Mock testcwd helper
-  const mockTestcwd = sandbox.stub()
-
-  // Use esmock to replace imports
-  const ValidateCommand = await esmock('./validate.js', {
-    '../validators/validate-yaml.js': {
-      default: mockYamlValidation
-    },
-    '#lib/project/index.js': {
-      default: { getProjectRoot: () => '/project' }
-    },
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/logger/index.js': {
-      logger: mockLogger
-    },
-    'fs-extra': fs
-  })
-
-  const command = new ValidateCommand()
-  command.name = sandbox.stub().returns('validate')
-
-  // Run action with debug option
-  command.action({ debug: true }, command)
-
-  t.true(mockYamlValidation.called, 'validation should run')
-  // Debug output should be logged (verified through console.debug stub)
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// JSON output tests
-// ─────────────────────────────────────────────────────────────────────────────
-
-test.serial('validate --json should output valid JSON when all files pass', async (t) => {
-  const { sandbox, fs, mockLogger } = t.context
-  const consoleLogStub = sandbox.stub(console, 'log')
-
-  const mockYamlValidation = sandbox.stub()
-  const mockTestcwd = sandbox.stub()
-
-  const ValidateCommand = await esmock('./validate.js', {
-    '../validators/validate-yaml.js': {
-      default: mockYamlValidation
-    },
-    '#lib/project/index.js': {
-      default: { getProjectRoot: () => '/project' }
-    },
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/logger/index.js': {
-      logger: mockLogger
-    },
-    'fs-extra': fs
-  })
-
-  const command = new ValidateCommand()
-  command.name = sandbox.stub().returns('validate')
-
-  command.action({ json: true }, command)
-
-  // Should output via console.log, not logger.info
-  t.true(consoleLogStub.calledOnce, 'console.log should be called once')
-  t.false(mockLogger.info.called, 'logger.info should not be called in JSON mode')
-
-  const output = JSON.parse(consoleLogStub.firstCall.args[0])
-
-  // Verify JSON structure
-  t.truthy(output.summary, 'JSON should have summary section')
-  t.truthy(output.files, 'JSON should have files section')
-  t.is(output.summary.files, 2, 'should report 2 YAML files')
-  t.is(output.summary.passed, 2, 'both files should pass')
-  t.is(output.summary.failed, 0, 'no files should fail')
-
-  // Verify each file result
-  t.true(output.files.every((f) => f.status === 'passed'), 'all files should have passed status')
-})
-
-test.serial('validate --json should output valid JSON with errors and throw', async (t) => {
-  const { sandbox, fs, mockLogger } = t.context
-  const consoleLogStub = sandbox.stub(console, 'log')
-
-  const validationError = new Error('Invalid YAML')
-  validationError.reason = 'Invalid YAML: missing required field'
-  const mockYamlValidation = sandbox.stub().throws(validationError)
-  const mockTestcwd = sandbox.stub()
-
-  const ValidateCommand = await esmock('./validate.js', {
-    '../validators/validate-yaml.js': {
-      default: mockYamlValidation
-    },
-    '#lib/project/index.js': {
-      default: { getProjectRoot: () => '/project' }
-    },
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/logger/index.js': {
-      logger: mockLogger
-    },
-    'fs-extra': fs
-  })
-
-  const command = new ValidateCommand()
-  command.name = sandbox.stub().returns('validate')
-  command.logger = mockLogger
-
-  // Should still throw ValidationError for exit code
-  const error = t.throws(() => command.action({ json: true }, command), { instanceOf: ValidationError })
-  t.is(error.code, 'VALIDATION_FAILED')
-
-  // Should output JSON before throwing
-  t.true(consoleLogStub.calledOnce, 'console.log should be called once')
-
-  const output = JSON.parse(consoleLogStub.firstCall.args[0])
-
-  t.is(output.summary.files, 2)
-  t.is(output.summary.failed, 2, 'both files should fail')
-  t.is(output.summary.passed, 0)
-
-  // Verify error details in file results
-  t.true(output.files.every((f) => f.status === 'failed'), 'all files should have failed status')
-  t.true(output.files.every((f) => f.error), 'all failed files should have error details')
-
-  // logger.error should NOT be called in JSON mode
-  t.false(mockLogger.error.called, 'logger.error should not be called in JSON mode')
-})
-
-test.serial('validate --json should output mixed results', async (t) => {
-  const { sandbox, fs, mockLogger } = t.context
-  const consoleLogStub = sandbox.stub(console, 'log')
-
-  // First file passes, second file fails
-  const validationError = new Error('Invalid YAML')
-  validationError.reason = 'duplicated mapping key at line 5'
-  const mockYamlValidation = sandbox.stub()
-  mockYamlValidation.onFirstCall().returns(undefined)
-  mockYamlValidation.onSecondCall().throws(validationError)
-  const mockTestcwd = sandbox.stub()
-
-  const ValidateCommand = await esmock('./validate.js', {
-    '../validators/validate-yaml.js': {
-      default: mockYamlValidation
-    },
-    '#lib/project/index.js': {
-      default: { getProjectRoot: () => '/project' }
-    },
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/logger/index.js': {
-      logger: mockLogger
-    },
-    'fs-extra': fs
-  })
-
-  const command = new ValidateCommand()
-  command.name = sandbox.stub().returns('validate')
-  command.logger = mockLogger
-
-  // Should throw because there are errors
-  t.throws(() => command.action({ json: true }, command), { instanceOf: ValidationError })
-
-  const output = JSON.parse(consoleLogStub.firstCall.args[0])
-
-  t.is(output.summary.files, 2)
-  t.is(output.summary.passed, 1)
-  t.is(output.summary.failed, 1)
-  t.is(output.files[0].status, 'passed')
-  t.is(output.files[1].status, 'failed')
-  t.is(output.files[1].error, 'duplicated mapping key at line 5')
-})

package/src/commands/workflows.js

@@ -1,70 +0,0 @@
-import Command from '#src/Command.js'
-import { DOCS_BASE } from '#helpers/docs-url.js'
-
-/**
- * Quire CLI `workflows` Command
- *
- * Displays common workflow documentation.
- * Hidden from main help but accessible via `quire help workflows` or `quire workflows`.
- *
- * TODO: Refactor to an extensible `quire help <topic>` system that can load
- * help topics from a topics/ directory or markdown files. This would support:
- * - quire help workflows
- * - quire help debugging
- * - quire help publishing
- * - quire help configuration
- *
- * @class      WorkflowsCommand
- * @extends    {Command}
- */
-export default class WorkflowsCommand extends Command {
-  static definition = {
-    name: 'workflows',
-    description: 'Display common workflow documentation',
-    summary: 'show common workflows',
-    hidden: true,
-    docsLink: 'quire-commands/',
-    helpText: `
-Common Workflows:
-
-  Starting a New Project:
-    quire new my-book && cd my-book && quire preview
-
-  Building for Web:
-    quire build                  Generate HTML site files
-    quire clean && quire build   Clean build (recommended for production)
-
-  Generating PDF:
-    quire pdf --build            Build first, then generate PDF
-    quire pdf --build --open     Generate and open PDF
-    quire pdf --engine prince    Use PrinceXML instead of Paged.js
-
-  Generating EPUB:
-    quire epub --build           Build first, then generate EPUB
-    quire epub --build --open    Generate and open EPUB
-
-  Full Publication Build:
-    quire clean && quire build && quire pdf && quire epub
-
-  Troubleshooting:
-    quire validate               Check YAML files for errors
-    quire info                   Show version information
-    quire build --verbose        Build with debug output
-
-See full documentation: ${DOCS_BASE}
-`,
-    version: '1.0.0',
-    options: [],
-  }
-
-  constructor() {
-    super(WorkflowsCommand.definition)
-  }
-
-  async action(options, command) {
-    this.debug('called with options %O', options)
-    // The help text is automatically displayed via Commander's help system
-    // If called directly (quire workflows), display help
-    command.help()
-  }
-}

package/src/errors/build/build-failed-error.js

@@ -1,19 +0,0 @@
-import QuireError from '../quire-error.js'
-import { docsUrl } from '#helpers/docs-url.js'
-
-/**
- * Error thrown when the publication build fails
- */
-export default class BuildFailedError extends QuireError {
-  constructor(details) {
-    super(
-      `Publication build failed${details ? `: ${details}` : ''}`,
-      {
-        code: 'BUILD_FAILED',
-        exitCode: 3,
-        suggestion: "Run 'quire build --debug' for detailed error information",
-        docsUrl: docsUrl('troubleshooting')
-      }
-    )
-  }
-}

package/src/errors/build/config-field-missing-error.js

@@ -1,20 +0,0 @@
-import QuireError from '../quire-error.js'
-import { docsUrl } from '#helpers/docs-url.js'
-
-/**
- * Error thrown when a required field is missing from a configuration file
- */
-export default class ConfigFieldMissingError extends QuireError {
-  constructor(fieldName, configFile) {
-    super(
-      `Missing required field '${fieldName}' in ${configFile}`,
-      {
-        code: 'CONFIG_FIELD_MISSING',
-        exitCode: 3,
-        filePath: `content/_data/${configFile}`,
-        suggestion: `Add '${fieldName}' to your ${configFile}`,
-        docsUrl: docsUrl('publication-configuration')
-      }
-    )
-  }
-}

package/src/errors/build/config-file-not-found-error.js

@@ -1,20 +0,0 @@
-import QuireError from '../quire-error.js'
-import { docsUrl } from '#helpers/docs-url.js'
-
-/**
- * Error thrown when a required configuration file is not found
- */
-export default class ConfigFileNotFoundError extends QuireError {
-  constructor(configFile) {
-    super(
-      `Required configuration file '${configFile}' not found`,
-      {
-        code: 'CONFIG_FILE_NOT_FOUND',
-        exitCode: 3,
-        filePath: `content/_data/${configFile}`,
-        suggestion: `Create ${configFile} in your content/_data/ folder`,
-        docsUrl: docsUrl('publication-configuration')
-      }
-    )
-  }
-}

package/src/errors/build/index.js

@@ -1,11 +0,0 @@
-/**
- * Build-related errors (exit code: 3)
- *
- * Errors related to publication build process including
- * Eleventy build failures and configuration issues.
- *
- * @module errors/build
- */
-export { default as BuildFailedError } from './build-failed-error.js'
-export { default as ConfigFieldMissingError } from './config-field-missing-error.js'
-export { default as ConfigFileNotFoundError } from './config-file-not-found-error.js'

package/src/errors/help/help-topic-not-found-error.js

@@ -1,30 +0,0 @@
-import InvalidInputError from '../input/invalid-input-error.js'
-import { docsUrl } from '#helpers/docs-url.js'
-import { suggestSimilar, formatSuggestion } from '#helpers/suggest-similar.js'
-
-/**
- * Error thrown when a requested help topic does not exist
- *
- * @param {string} topic - The unrecognized topic name
- * @param {string[]} validTopics - Array of available topic names
- */
-export default class HelpTopicNotFoundError extends InvalidInputError {
-  constructor(topic, validTopics = []) {
-    const suggestion = formatSuggestion(suggestSimilar(topic, validTopics))
-      || 'Run "quire help --list" to see available topics'
-
-    super(
-      `Unknown help topic: ${topic}`,
-      {
-        code: 'HELP_TOPIC_NOT_FOUND',
-        exitCode: 2,
-        inputValue: topic,
-        inputName: 'topic',
-        suggestion,
-        docsUrl: docsUrl('quire-commands/'),
-        showDebugHint: false
-      }
-    )
-    this.topic = topic
-  }
-}

package/src/errors/help/index.js

@@ -1,8 +0,0 @@
-/**
- * Help errors (exit code: 2)
- *
- * Errors related to the help system and topic lookup.
- *
- * @module errors/help
- */
-export { default as HelpTopicNotFoundError } from './help-topic-not-found-error.js'