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

package/src/lib/conf/build-status.js

@@ -1,103 +0,0 @@
-/**
- * Per-project build status persistence
- *
- * Records command outcomes (ok/failed) for build, pdf, and epub commands
- * so that `quire doctor` can distinguish "never ran" from "ran and failed"
- * when no output files exist on disk.
- *
- * Status is stored in the global CLI config under the `projects` key,
- * keyed by a SHA-256 hash of the project's absolute path to avoid
- * dot-notation traversal issues.
- *
- * @module lib/conf/build-status
- */
-import { createHash } from 'node:crypto'
-import config from '#lib/conf/config.js'
-import createDebug from '#debug'
-
-const debug = createDebug('lib:conf:build-status')
-
-/**
- * Commands whose status is tracked
- * @type {readonly string[]}
- */
-export const TRACKED_COMMANDS = Object.freeze(['build', 'pdf', 'epub'])
-
-/**
- * Derive a fixed-length, dot-safe config key from a project path
- *
- * @param {string} projectPath - Absolute path to the project directory
- * @returns {string} First 12 hex characters of the SHA-256 hash
- */
-export function projectKey(projectPath) {
-  return createHash('sha256').update(projectPath).digest('hex').slice(0, 12)
-}
-
-/**
- * Record the outcome of a command for a project
- *
- * @param {string} projectPath - Absolute path to the project directory
- * @param {string} command - Command name ('build', 'pdf', or 'epub')
- * @param {'ok'|'failed'} status - Outcome of the command
- */
-export function recordStatus(projectPath, command, status) {
-  if (!TRACKED_COMMANDS.includes(command)) {
-    debug('ignoring untracked command: %s', command)
-    return
-  }
-
-  const key = projectKey(projectPath)
-  const projects = config.get('projects') || {}
-
-  const entry = projects[key] || { projectPath }
-  entry.projectPath = projectPath
-  entry.buildStatus = {
-    ...entry.buildStatus,
-    [command]: {
-      status,
-      timestamp: Date.now(),
-    },
-  }
-  projects[key] = entry
-
-  config.set('projects', projects)
-  debug('recorded %s=%s for %s (key=%s)', command, status, projectPath, key)
-}
-
-/**
- * Retrieve the stored status for a command in a project
- *
- * @param {string} projectPath - Absolute path to the project directory
- * @param {string} command - Command name ('build', 'pdf', or 'epub')
- * @returns {{ status: 'ok'|'failed', timestamp: number } | undefined}
- */
-export function getStatus(projectPath, command) {
-  const key = projectKey(projectPath)
-  const projects = config.get('projects') || {}
-  const entry = projects[key]
-
-  if (!entry || !entry.buildStatus) {
-    debug('no status entry for key=%s', key)
-    return undefined
-  }
-
-  return entry.buildStatus[command]
-}
-
-/**
- * Clear all stored status for a project
- *
- * @param {string} projectPath - Absolute path to the project directory
- */
-export function clearStatus(projectPath) {
-  const key = projectKey(projectPath)
-  const projects = config.get('projects') || {}
-  const entry = projects[key]
-
-  if (entry && entry.buildStatus) {
-    delete entry.buildStatus
-    projects[key] = entry
-    config.set('projects', projects)
-    debug('cleared build status for %s (key=%s)', projectPath, key)
-  }
-}

package/src/lib/conf/build-status.test.js

@@ -1,247 +0,0 @@
-import esmock from 'esmock'
-import sinon from 'sinon'
-import test from 'ava'
-
-/**
- * Build Status Module Tests
- *
- * Tests the per-project build status persistence API.
- * Mocks the config module with a simple in-memory store.
- */
-
-test.beforeEach(async (t) => {
-  const sandbox = sinon.createSandbox()
-
-  // In-memory store that mimics config.get/set for 'projects'
-  const store = {}
-  const configMock = {
-    default: {
-      get: sandbox.stub().callsFake((key) => store[key]),
-      set: sandbox.stub().callsFake((key, value) => { store[key] = value }),
-    },
-  }
-
-  const mod = await esmock('./build-status.js', {
-    '#lib/conf/config.js': configMock,
-  })
-
-  t.context = { sandbox, store, configMock, ...mod }
-})
-
-test.afterEach.always((t) => {
-  t.context.sandbox.restore()
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// projectKey
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('projectKey returns a 12-character hex string', (t) => {
-  const { projectKey } = t.context
-  const key = projectKey('/Users/test/my-project')
-  t.is(key.length, 12)
-  t.regex(key, /^[0-9a-f]{12}$/)
-})
-
-test('projectKey returns the same key for the same path', (t) => {
-  const { projectKey } = t.context
-  const key1 = projectKey('/Users/test/my-project')
-  const key2 = projectKey('/Users/test/my-project')
-  t.is(key1, key2)
-})
-
-test('projectKey returns different keys for different paths', (t) => {
-  const { projectKey } = t.context
-  const key1 = projectKey('/Users/test/project-a')
-  const key2 = projectKey('/Users/test/project-b')
-  t.not(key1, key2)
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// recordStatus
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('recordStatus writes status with timestamp to config', (t) => {
-  const { recordStatus, projectKey, configMock } = t.context
-  const projectPath = '/Users/test/my-project'
-
-  recordStatus(projectPath, 'build', 'ok')
-
-  t.true(configMock.default.set.calledOnce)
-  const [setKey, setValue] = configMock.default.set.firstCall.args
-  t.is(setKey, 'projects')
-
-  const key = projectKey(projectPath)
-  const entry = setValue[key]
-  t.is(entry.projectPath, projectPath)
-  t.is(entry.buildStatus.build.status, 'ok')
-  t.is(typeof entry.buildStatus.build.timestamp, 'number')
-})
-
-test('recordStatus records failed status', (t) => {
-  const { recordStatus, projectKey, configMock } = t.context
-  const projectPath = '/Users/test/my-project'
-
-  recordStatus(projectPath, 'pdf', 'failed')
-
-  const [, setValue] = configMock.default.set.firstCall.args
-  const key = projectKey(projectPath)
-  t.is(setValue[key].buildStatus.pdf.status, 'failed')
-})
-
-test('recordStatus silently ignores untracked commands', (t) => {
-  const { recordStatus, configMock } = t.context
-
-  recordStatus('/Users/test/my-project', 'preview', 'ok')
-
-  t.false(configMock.default.set.called)
-})
-
-test('recordStatus preserves existing command entries', (t) => {
-  const { recordStatus, projectKey, store } = t.context
-  const projectPath = '/Users/test/my-project'
-  const key = projectKey(projectPath)
-
-  // Pre-populate with a build entry
-  store.projects = {
-    [key]: {
-      projectPath,
-      buildStatus: {
-        build: { status: 'ok', timestamp: 1000 },
-      },
-    },
-  }
-
-  recordStatus(projectPath, 'pdf', 'failed')
-
-  const entry = store.projects[key]
-  t.is(entry.buildStatus.build.status, 'ok')
-  t.is(entry.buildStatus.build.timestamp, 1000)
-  t.is(entry.buildStatus.pdf.status, 'failed')
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// getStatus
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('getStatus returns stored status entry', (t) => {
-  const { getStatus, projectKey, store } = t.context
-  const projectPath = '/Users/test/my-project'
-  const key = projectKey(projectPath)
-
-  store.projects = {
-    [key]: {
-      projectPath,
-      buildStatus: {
-        build: { status: 'ok', timestamp: 1000 },
-      },
-    },
-  }
-
-  const result = getStatus(projectPath, 'build')
-  t.deepEqual(result, { status: 'ok', timestamp: 1000 })
-})
-
-test('getStatus returns undefined for unknown project', (t) => {
-  const { getStatus } = t.context
-
-  const result = getStatus('/Users/test/unknown-project', 'build')
-  t.is(result, undefined)
-})
-
-test('getStatus returns undefined for unrecorded command', (t) => {
-  const { getStatus, projectKey, store } = t.context
-  const projectPath = '/Users/test/my-project'
-  const key = projectKey(projectPath)
-
-  store.projects = {
-    [key]: {
-      projectPath,
-      buildStatus: {
-        build: { status: 'ok', timestamp: 1000 },
-      },
-    },
-  }
-
-  const result = getStatus(projectPath, 'epub')
-  t.is(result, undefined)
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// clearStatus
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('clearStatus removes project entry', (t) => {
-  const { clearStatus, projectKey, store, configMock } = t.context
-  const projectPath = '/Users/test/my-project'
-  const key = projectKey(projectPath)
-
-  store.projects = {
-    [key]: {
-      projectPath,
-      buildStatus: {
-        build: { status: 'ok', timestamp: 1000 },
-      },
-    },
-  }
-
-  clearStatus(projectPath)
-
-  const [, setValue] = configMock.default.set.firstCall.args
-  t.truthy(setValue[key], 'project entry should still exist')
-  t.is(setValue[key].projectPath, projectPath, 'projectPath should be preserved')
-  t.is(setValue[key].buildStatus, undefined, 'buildStatus should be removed')
-})
-
-test('clearStatus is a no-op for unknown project', (t) => {
-  const { clearStatus, configMock, store } = t.context
-
-  store.projects = {}
-  clearStatus('/Users/test/unknown-project')
-
-  t.false(configMock.default.set.called)
-})
-
-test('clearStatus is a no-op when project has no buildStatus', (t) => {
-  const { clearStatus, projectKey, configMock, store } = t.context
-  const projectPath = '/Users/test/my-project'
-  const key = projectKey(projectPath)
-
-  store.projects = {
-    [key]: { projectPath },
-  }
-
-  clearStatus(projectPath)
-
-  t.false(configMock.default.set.called)
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Multiple projects
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('multiple projects are tracked independently', (t) => {
-  const { recordStatus, getStatus } = t.context
-  const projectA = '/Users/test/project-a'
-  const projectB = '/Users/test/project-b'
-
-  recordStatus(projectA, 'build', 'ok')
-  recordStatus(projectB, 'build', 'failed')
-
-  t.is(getStatus(projectA, 'build').status, 'ok')
-  t.is(getStatus(projectB, 'build').status, 'failed')
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// TRACKED_COMMANDS
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('TRACKED_COMMANDS contains build, pdf, and epub', (t) => {
-  const { TRACKED_COMMANDS } = t.context
-  t.deepEqual([...TRACKED_COMMANDS], ['build', 'pdf', 'epub'])
-})
-
-test('TRACKED_COMMANDS is frozen', (t) => {
-  const { TRACKED_COMMANDS } = t.context
-  t.true(Object.isFrozen(TRACKED_COMMANDS))
-})

package/src/lib/conf/config.test.js

@@ -1,281 +0,0 @@
-import esmock from 'esmock'
-import sinon from 'sinon'
-import test from 'ava'
-
-/**
- * Configuration Module Integration Tests
- *
- * Tests the Quire CLI configuration module behavior with mocked dependencies.
- * Uses esmock to isolate the module from the actual Conf library and filesystem.
- */
-
-test.beforeEach((t) => {
-  t.context.sandbox = sinon.createSandbox()
-})
-
-test.afterEach.always((t) => {
-  t.context.sandbox.restore()
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Configuration instantiation tests
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('config is created with correct project name and version', async (t) => {
-  const { sandbox } = t.context
-
-  let capturedOptions = null
-  const MockConf = sandbox.stub().callsFake(function (options) {
-    capturedOptions = options
-    return {
-      get: sandbox.stub(),
-      set: sandbox.stub()
-    }
-  })
-
-  await esmock('./config.js', {
-    conf: { default: MockConf },
-    '#src/packageConfig.js': { name: '@thegetty/quire-cli', version: '1.0.0' }
-  })
-
-  t.true(MockConf.calledOnce)
-  t.is(capturedOptions.projectName, '@thegetty/quire-cli')
-  t.is(capturedOptions.projectVersion, '1.0.0')
-  t.is(capturedOptions.projectSuffix, '')
-})
-
-test('config is created with correct options', async (t) => {
-  const { sandbox } = t.context
-
-  let capturedOptions = null
-  const MockConf = sandbox.stub().callsFake(function (options) {
-    capturedOptions = options
-    return {
-      get: sandbox.stub(),
-      set: sandbox.stub()
-    }
-  })
-
-  await esmock('./config.js', {
-    conf: { default: MockConf },
-    '#src/packageConfig.js': { name: 'test', version: '1.0.0' }
-  })
-
-  t.true(capturedOptions.clearInvalidConfig)
-  t.true(capturedOptions.watch)
-  t.is(typeof capturedOptions.beforeEachMigration, 'function')
-})
-
-test('config passes defaults to Conf constructor', async (t) => {
-  const { sandbox } = t.context
-
-  let capturedOptions = null
-  const MockConf = sandbox.stub().callsFake(function (options) {
-    capturedOptions = options
-    return {
-      get: sandbox.stub(),
-      set: sandbox.stub()
-    }
-  })
-
-  const mockDefaults = {
-    logLevel: 'debug',
-    quireVersion: '2.0.0'
-  }
-
-  await esmock('./config.js', {
-    conf: { default: MockConf },
-    './defaults.js': { default: mockDefaults },
-    '#src/packageConfig.js': { name: 'test', version: '1.0.0' }
-  })
-
-  t.deepEqual(capturedOptions.defaults, mockDefaults)
-})
-
-test('config passes schema to Conf constructor', async (t) => {
-  const { sandbox } = t.context
-
-  let capturedOptions = null
-  const MockConf = sandbox.stub().callsFake(function (options) {
-    capturedOptions = options
-    return {
-      get: sandbox.stub(),
-      set: sandbox.stub()
-    }
-  })
-
-  const mockSchema = {
-    logLevel: { type: 'string' },
-    quireVersion: { type: 'string' }
-  }
-
-  await esmock('./config.js', {
-    conf: { default: MockConf },
-    './schema.js': { default: mockSchema },
-    '#src/packageConfig.js': { name: 'test', version: '1.0.0' }
-  })
-
-  t.deepEqual(capturedOptions.schema, mockSchema)
-})
-
-test('config passes migrations to Conf constructor', async (t) => {
-  const { sandbox } = t.context
-
-  let capturedOptions = null
-  const MockConf = sandbox.stub().callsFake(function (options) {
-    capturedOptions = options
-    return {
-      get: sandbox.stub(),
-      set: sandbox.stub()
-    }
-  })
-
-  const mockMigrations = {
-    '1.0.0': () => {},
-    '2.0.0': () => {}
-  }
-
-  await esmock('./config.js', {
-    conf: { default: MockConf },
-    './migrations.js': { default: mockMigrations },
-    '#src/packageConfig.js': { name: 'test', version: '1.0.0' }
-  })
-
-  t.deepEqual(capturedOptions.migrations, mockMigrations)
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Migration callback tests
-// ─────────────────────────────────────────────────────────────────────────────
-
-test.serial('beforeEachMigration logs migration info', async (t) => {
-  const { sandbox } = t.context
-
-  let capturedOptions = null
-  const MockConf = sandbox.stub().callsFake(function (options) {
-    capturedOptions = options
-    return {
-      get: sandbox.stub(),
-      set: sandbox.stub()
-    }
-  })
-
-  const consoleInfoStub = sandbox.stub(console, 'info')
-
-  await esmock('./config.js', {
-    conf: { default: MockConf },
-    '#src/packageConfig.js': { name: 'test', version: '1.0.0' }
-  })
-
-  // Call the beforeEachMigration callback
-  const mockStore = { get: sandbox.stub(), set: sandbox.stub() }
-  const mockContext = { fromVersion: '0.9.0', toVersion: '1.0.0' }
-  capturedOptions.beforeEachMigration(mockStore, mockContext)
-
-  t.true(consoleInfoStub.calledOnce)
-  t.true(consoleInfoStub.firstCall.args[0].includes('0.9.0'))
-  t.true(consoleInfoStub.firstCall.args[0].includes('1.0.0'))
-  t.true(consoleInfoStub.firstCall.args[0].includes('Migrating'))
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Module export tests
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('config module exports Conf instance as default', async (t) => {
-  const { sandbox } = t.context
-
-  const mockInstance = {
-    get: sandbox.stub().returns('value'),
-    set: sandbox.stub(),
-    has: sandbox.stub().returns(true),
-    delete: sandbox.stub()
-  }
-
-  const MockConf = sandbox.stub().returns(mockInstance)
-
-  const config = await esmock('./config.js', {
-    conf: { default: MockConf },
-    '#src/packageConfig.js': { name: 'test', version: '1.0.0' }
-  })
-
-  t.is(config.default, mockInstance)
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Default values tests
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('defaults module exports expected configuration keys', async (t) => {
-  const defaults = await import('./defaults.js')
-
-  t.true('logLevel' in defaults.default)
-  t.true('projectTemplate' in defaults.default)
-  t.true('quire11tyPath' in defaults.default)
-  t.true('quireVersion' in defaults.default)
-  t.true('updateChannel' in defaults.default)
-  t.true('updateInterval' in defaults.default)
-  t.true('versionFile' in defaults.default)
-})
-
-test('defaults module has reasonable default values', async (t) => {
-  const defaults = await import('./defaults.js')
-
-  t.is(defaults.default.logLevel, 'info')
-  t.is(defaults.default.quireVersion, 'latest')
-  t.is(defaults.default.versionFile, '.quire')
-  t.true(defaults.default.projectTemplate.includes('github.com'))
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Schema tests
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('schema module defines types for all default keys', async (t) => {
-  const schema = await import('./schema.js')
-  const defaults = await import('./defaults.js')
-
-  const schemaKeys = Object.keys(schema.default)
-  const defaultKeys = Object.keys(defaults.default)
-
-  // All default keys should have schema definitions
-  for (const key of defaultKeys) {
-    t.true(schemaKeys.includes(key), `Schema should define ${key}`)
-  }
-})
-
-test('schema module defines valid types for all properties', async (t) => {
-  const schema = await import('./schema.js')
-
-  const validTypes = ['string', 'boolean', 'number', 'object', 'array']
-  for (const [key, value] of Object.entries(schema.default)) {
-    t.true(validTypes.includes(value.type), `${key} should have a valid type`)
-  }
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Migrations tests
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('migrations module exports migration functions', async (t) => {
-  const migrations = await import('./migrations.js')
-
-  t.is(typeof migrations.default, 'object')
-  t.true('1.0.0' in migrations.default)
-})
-
-test('migrations 1.0.0 sets updateChannel', async (t) => {
-  const { sandbox } = t.context
-
-  const migrations = await import('./migrations.js')
-
-  const mockStore = {
-    get: sandbox.stub(),
-    set: sandbox.stub()
-  }
-
-  migrations.default['1.0.0'](mockStore)
-
-  t.true(mockStore.set.calledOnce)
-  t.true(mockStore.set.calledWith('updateChannel', 'latest'))
-})

package/src/lib/conf/format.js

@@ -1,60 +0,0 @@
-/**
- * Display formatting functions for Quire configuration
- *
- * Provides human-readable formatting with optional chalk styling.
- * Separated from helpers.js to isolate the chalk dependency
- * from the pure validation/coercion functions.
- *
- * @see ./helpers.js for schema-aware validation and coercion
- */
-import chalk from 'chalk'
-import schema from './schema.js'
-
-/**
- * Get the description for a configuration key from the schema
- *
- * @param {string} key - Configuration key
- * @returns {string|undefined} Description string, or undefined if not found
- */
-export function getKeyDescription(key) {
-  return schema[key]?.description
-}
-
-/**
- * Format all settings as a human-readable string
- *
- * @param {Object} store - Configuration store (key-value pairs)
- * @param {Object} [options]
- * @param {string} [options.configPath] - Path to the config file (shown in header)
- * @param {boolean} [options.showInternal=false] - Include __internal__ keys
- * @param {boolean} [options.useColor=false] - Apply chalk styling to output
- * @returns {string} Formatted multiline settings display
- */
-export function formatSettings(store, { configPath, showInternal = false, useColor = false } = {}) {
-  const style = useColor
-    ? { bold: chalk.bold, cyan: chalk.cyan, dim: chalk.dim }
-    : { bold: (s) => s, cyan: (s) => s, dim: (s) => s }
-
-  const lines = []
-
-  if (configPath) {
-    lines.push(style.bold(`quire-cli configuration ${configPath}`))
-  } else {
-    lines.push(style.bold('quire-cli configuration'))
-  }
-  lines.push('')
-
-  for (const [key, value] of Object.entries(store)) {
-    if ((key.startsWith('__internal__') || key === 'projects') && !showInternal) continue
-    const description = getKeyDescription(key)
-    lines.push(`  ${style.cyan(key)}: ${JSON.stringify(value)}`)
-    if (description) {
-      lines.push(`    ${style.dim(description)}`)
-    }
-  }
-
-  lines.push('')
-  lines.push(style.dim('Use "quire settings set <key> <value>" to change a setting'))
-
-  return lines.join('\n')
-}