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

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

@@ -1,106 +0,0 @@
-import test from 'ava'
-import chalk from 'chalk'
-import {
-  getKeyDescription,
-  formatSettings,
-} from './format.js'
-
-// =============================================================================
-// getKeyDescription
-// =============================================================================
-
-test('getKeyDescription returns description for known key', (t) => {
-  const desc = getKeyDescription('logLevel')
-  t.is(typeof desc, 'string')
-  t.true(desc.length > 0)
-})
-
-test('getKeyDescription returns undefined for unknown key', (t) => {
-  t.is(getKeyDescription('unknownKey'), undefined)
-})
-
-// =============================================================================
-// formatSettings (plain, useColor=false)
-// =============================================================================
-
-test('formatSettings includes header with config path', (t) => {
-  const output = formatSettings({}, { configPath: '/mock/path' })
-  t.true(output.includes('quire-cli configuration /mock/path'))
-})
-
-test('formatSettings includes header without config path', (t) => {
-  const output = formatSettings({})
-  t.true(output.includes('quire-cli configuration'))
-})
-
-test('formatSettings includes key-value pairs', (t) => {
-  const store = { logLevel: 'info', logShowLevel: false }
-  const output = formatSettings(store)
-  t.true(output.includes('logLevel: "info"'))
-  t.true(output.includes('logShowLevel: false'))
-})
-
-test('formatSettings includes schema descriptions', (t) => {
-  const store = { logLevel: 'info' }
-  const output = formatSettings(store)
-  const desc = getKeyDescription('logLevel')
-  t.true(output.includes(desc))
-})
-
-test('formatSettings hides __internal__ keys by default', (t) => {
-  const store = { logLevel: 'info', __internal__secret: 'hidden' }
-  const output = formatSettings(store)
-  t.false(output.includes('__internal__secret'))
-})
-
-test('formatSettings shows __internal__ keys with showInternal', (t) => {
-  const store = { logLevel: 'info', __internal__secret: 'hidden' }
-  const output = formatSettings(store, { showInternal: true })
-  t.true(output.includes('__internal__secret'))
-  t.true(output.includes('"hidden"'))
-})
-
-test('formatSettings includes help hint', (t) => {
-  const output = formatSettings({})
-  t.true(output.includes('Use "quire settings set <key> <value>" to change a setting'))
-})
-
-// =============================================================================
-// formatSettings (useColor=true)
-// =============================================================================
-
-test('formatSettings with useColor applies bold to header', (t) => {
-  const output = formatSettings({}, { useColor: true })
-  t.true(output.includes(chalk.bold('quire-cli configuration')))
-})
-
-test('formatSettings with useColor applies bold to header with path', (t) => {
-  const output = formatSettings({}, { useColor: true, configPath: '/mock/path' })
-  t.true(output.includes(chalk.bold('quire-cli configuration /mock/path')))
-})
-
-test('formatSettings with useColor applies cyan to key names', (t) => {
-  const store = { logLevel: 'info' }
-  const output = formatSettings(store, { useColor: true })
-  t.true(output.includes(chalk.cyan('logLevel')))
-})
-
-test('formatSettings with useColor applies dim to descriptions', (t) => {
-  const store = { logLevel: 'info' }
-  const output = formatSettings(store, { useColor: true })
-  const desc = getKeyDescription('logLevel')
-  t.true(output.includes(chalk.dim(desc)))
-})
-
-test('formatSettings with useColor applies dim to help hint', (t) => {
-  const output = formatSettings({}, { useColor: true })
-  t.true(output.includes(chalk.dim('Use "quire settings set <key> <value>" to change a setting')))
-})
-
-test('formatSettings without useColor does not apply ANSI codes', (t) => {
-  const store = { logLevel: 'info' }
-  const output = formatSettings(store)
-  // Plain output should not contain ANSI escape sequences
-  // eslint-disable-next-line no-control-regex
-  t.false(/\u001b\[/.test(output))
-})

package/src/lib/conf/helpers.js

@@ -1,91 +0,0 @@
-/**
- * Pure helper functions for Quire configuration
- *
- * Provides schema-aware validation and coercion
- * without side effects or dependencies on the Conf instance.
- *
- * Nota bene: these functions import only schema and defaults (pure data),
- * avoiding circular dependencies with the logger module.
- *
- * @see ./format.js for display formatting functions
- */
-import schema from './schema.js'
-import defaults from './defaults.js'
-
-/**
- * Check whether a key is a valid configuration key
- *
- * @param {string} key - Configuration key to check
- * @returns {boolean} True if the key exists in the schema
- */
-export function isValidKey(key) {
-  return Object.hasOwn(schema, key)
-}
-
-/**
- * Get all valid configuration keys
- *
- * @returns {string[]} Sorted array of valid configuration keys
- */
-export function getValidKeys() {
-  return Object.keys(schema).sort()
-}
-
-/**
- * Coerce a CLI string value to the appropriate type based on schema
- *
- * @param {string} key - Configuration key
- * @param {string} value - String value from CLI input
- * @returns {*} Coerced value matching the schema type
- */
-export function coerceValue(key, value) {
-  const keySchema = schema[key]
-  if (!keySchema) return value
-
-  switch (keySchema.type) {
-    case 'boolean':
-      if (value === 'true' || value === '1') return true
-      if (value === 'false' || value === '0') return false
-      return value
-    case 'number': {
-      const num = Number(value)
-      return isNaN(num) ? value : num
-    }
-    default:
-      return value
-  }
-}
-
-/**
- * Format a validation error with helpful information from the schema
- *
- * @param {string} key - Configuration key
- * @param {*} value - The invalid value
- * @returns {string} Formatted multiline error message
- */
-export function formatValidationError(key, value) {
-  const keySchema = schema[key]
-  const lines = [`Invalid value for '${key}': ${JSON.stringify(value)}`]
-
-  if (keySchema) {
-    if (keySchema.enum) {
-      lines.push(`Valid values: ${keySchema.enum.join(', ')}`)
-    }
-    if (keySchema.description) {
-      lines.push(`Description: ${keySchema.description}`)
-    }
-  }
-
-  return lines.join('\n')
-}
-
-/**
- * Get the default value for a configuration key
- *
- * @param {string} key - Configuration key
- * @returns {*} Default value, or undefined if key has no default
- */
-export function getDefault(key) {
-  return defaults[key]
-}
-

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

@@ -1,136 +0,0 @@
-import test from 'ava'
-import {
-  isValidKey,
-  getValidKeys,
-  coerceValue,
-  formatValidationError,
-  getDefault,
-} from './helpers.js'
-
-// =============================================================================
-// isValidKey
-// =============================================================================
-
-test('isValidKey returns true for a known schema key', (t) => {
-  t.true(isValidKey('logLevel'))
-})
-
-test('isValidKey returns true for all schema keys', (t) => {
-  const keys = getValidKeys()
-  for (const key of keys) {
-    t.true(isValidKey(key), `${key} should be valid`)
-  }
-})
-
-test('isValidKey returns false for an unknown key', (t) => {
-  t.false(isValidKey('nonExistentKey'))
-})
-
-test('isValidKey returns false for __internal__ prefixed keys', (t) => {
-  t.false(isValidKey('__internal__secretKey'))
-})
-
-// =============================================================================
-// getValidKeys
-// =============================================================================
-
-test('getValidKeys returns an array', (t) => {
-  const keys = getValidKeys()
-  t.true(Array.isArray(keys))
-  t.true(keys.length > 0)
-})
-
-test('getValidKeys returns sorted keys', (t) => {
-  const keys = getValidKeys()
-  const sorted = [...keys].sort()
-  t.deepEqual(keys, sorted)
-})
-
-test('getValidKeys includes expected keys', (t) => {
-  const keys = getValidKeys()
-  t.true(keys.includes('logLevel'))
-  t.true(keys.includes('quireVersion'))
-  t.true(keys.includes('projectTemplate'))
-})
-
-// =============================================================================
-// coerceValue
-// =============================================================================
-
-test('coerceValue coerces "true" to boolean true', (t) => {
-  t.is(coerceValue('logShowLevel', 'true'), true)
-})
-
-test('coerceValue coerces "false" to boolean false', (t) => {
-  t.is(coerceValue('logShowLevel', 'false'), false)
-})
-
-test('coerceValue coerces "1" to boolean true for boolean schema', (t) => {
-  t.is(coerceValue('logShowLevel', '1'), true)
-})
-
-test('coerceValue coerces "0" to boolean false for boolean schema', (t) => {
-  t.is(coerceValue('logShowLevel', '0'), false)
-})
-
-test('coerceValue passes through non-boolean string for boolean schema', (t) => {
-  t.is(coerceValue('logShowLevel', 'maybe'), 'maybe')
-})
-
-test('coerceValue passes through string values for string schema', (t) => {
-  t.is(coerceValue('logLevel', 'debug'), 'debug')
-})
-
-test('coerceValue passes through value for unknown key', (t) => {
-  t.is(coerceValue('unknownKey', 'someValue'), 'someValue')
-})
-
-// =============================================================================
-// formatValidationError
-// =============================================================================
-
-test('formatValidationError includes invalid value', (t) => {
-  const error = formatValidationError('logLevel', 'invalid')
-  t.true(error.includes("Invalid value for 'logLevel'"))
-  t.true(error.includes('"invalid"'))
-})
-
-test('formatValidationError includes valid enum values', (t) => {
-  const error = formatValidationError('logLevel', 'invalid')
-  t.true(error.includes('Valid values:'))
-  t.true(error.includes('info'))
-  t.true(error.includes('debug'))
-})
-
-test('formatValidationError includes description', (t) => {
-  const error = formatValidationError('logLevel', 'invalid')
-  t.true(error.includes('Description:'))
-})
-
-test('formatValidationError handles key without enum', (t) => {
-  const error = formatValidationError('logPrefix', 123)
-  t.true(error.includes("Invalid value for 'logPrefix'"))
-  t.false(error.includes('Valid values:'))
-})
-
-test('formatValidationError handles unknown key', (t) => {
-  const error = formatValidationError('unknownKey', 'value')
-  t.true(error.includes("Invalid value for 'unknownKey'"))
-})
-
-// =============================================================================
-// getDefault
-// =============================================================================
-
-test('getDefault returns default value for known key', (t) => {
-  t.is(getDefault('logLevel'), 'info')
-})
-
-test('getDefault returns default for boolean key', (t) => {
-  t.is(getDefault('logShowLevel'), false)
-})
-
-test('getDefault returns undefined for unknown key', (t) => {
-  t.is(getDefault('unknownKey'), undefined)
-})
-

package/src/lib/conf/index.js

@@ -1,22 +0,0 @@
-/**
- * Quire configuration module
- *
- * Exports the singleton Conf instance as the default export
- * and named helper functions for schema-aware operations.
- *
- * @example
- * import config from '#lib/conf/index.js'
- * import { isValidKey, coerceValue } from '#lib/conf/index.js'
- */
-export { default as default } from './config.js'
-export {
-  isValidKey,
-  getValidKeys,
-  coerceValue,
-  formatValidationError,
-  getDefault,
-} from './helpers.js'
-export {
-  getKeyDescription,
-  formatSettings,
-} from './format.js'

package/src/lib/constants.js

@@ -1,28 +0,0 @@
-/**
- * Shared CLI constants
- *
- * Centralized constants used across the CLI to avoid duplication
- * and ensure consistency.
- *
- * @module lib/constants
- */
-
-/**
- * Base URL for Quire documentation (without trailing slash)
- *
- * Use with URL constructor for path joining:
- * @example
- * new URL('install-uninstall/', DOCS_BASE_URL).href
- * // => 'https://quire.getty.edu/docs-v1/install-uninstall/'
- */
-export const DOCS_BASE_URL = 'https://quire.getty.edu/docs-v1'
-
-/**
- * Package name for quire-11ty
- */
-export const QUIRE_11TY_PACKAGE = '@thegetty/quire-11ty'
-
-/**
- * Minimum required Node.js major version
- */
-export const REQUIRED_NODE_VERSION = 22