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

package/src/lib/doctor/formatters/human.test.js

@@ -1,463 +0,0 @@
-/**
- * Tests for human-readable formatter
- */
-import test from 'ava'
-import { formatHuman } from './human.js'
-
-const mockSections = [
-  {
-    section: 'Environment',
-    results: [
-      { id: 'os', name: 'Operating system', ok: true, message: 'macOS 14' },
-      { id: 'node', name: 'Node.js', ok: false, level: 'error', message: 'v18', remediation: 'Upgrade Node.js', docsUrl: 'https://example.com' },
-    ],
-  },
-  {
-    section: 'Project',
-    results: [
-      { id: 'deps', name: 'Dependencies', ok: false, level: 'warn', message: 'Outdated' },
-      { id: 'build', name: 'Build', ok: true, level: 'na', message: 'No build yet' },
-    ],
-  },
-]
-
-test('formatHuman returns lines array', (t) => {
-  const { lines } = formatHuman(mockSections)
-  t.true(Array.isArray(lines))
-  t.true(lines.length > 0)
-})
-
-test('formatHuman lines have text and level properties', (t) => {
-  const { lines } = formatHuman(mockSections)
-  for (const line of lines) {
-    t.true(typeof line.text === 'string')
-    t.true(['info', 'warn', 'error'].includes(line.level))
-  }
-})
-
-test('formatHuman includes header with label', (t) => {
-  const { lines } = formatHuman(mockSections, { label: 'environment checks' })
-  const header = lines[0]
-  t.true(header.text.includes('Running environment checks'))
-})
-
-test('formatHuman header includes errors filter description', (t) => {
-  const { lines } = formatHuman(mockSections, { errors: true })
-  const header = lines.find((l) => l.text.includes('Running'))
-  t.truthy(header)
-  t.true(header.text.includes('(errors only)'))
-})
-
-test('formatHuman header includes warnings filter description', (t) => {
-  const { lines } = formatHuman(mockSections, { warnings: true })
-  const header = lines.find((l) => l.text.includes('Running'))
-  t.truthy(header)
-  t.true(header.text.includes('(warnings only)'))
-})
-
-test('formatHuman header includes combined filter description', (t) => {
-  const { lines } = formatHuman(mockSections, { errors: true, warnings: true })
-  const header = lines.find((l) => l.text.includes('Running'))
-  t.truthy(header)
-  t.true(header.text.includes('(warnings and errors only)'))
-})
-
-test('formatHuman header has no filter suffix without filters', (t) => {
-  const { lines } = formatHuman(mockSections)
-  const header = lines[0]
-  t.false(header.text.includes('only'))
-})
-
-test('formatHuman includes section names as headings', (t) => {
-  const { lines } = formatHuman(mockSections)
-  const envLine = lines.find((l) => l.text.includes('Environment') && !l.text.includes('Running'))
-  const projectLine = lines.find((l) => l.text.includes('Project'))
-  t.truthy(envLine)
-  t.truthy(projectLine)
-  // Section headings should be info level
-  t.is(envLine.level, 'info')
-  t.is(projectLine.level, 'info')
-})
-
-test('formatHuman includes check names and messages', (t) => {
-  const { lines } = formatHuman(mockSections)
-  const osLine = lines.find((l) => l.text.includes('Operating system'))
-  t.truthy(osLine)
-  t.true(osLine.text.includes('macOS 14'))
-})
-
-test('formatHuman returns summary with error count and N/A count', (t) => {
-  const { summary } = formatHuman(mockSections)
-  t.truthy(summary)
-  t.true(summary.text.includes('1 check failed'))
-  t.true(summary.text.includes('(1 not applicable)'))
-  t.is(summary.level, 'error')
-})
-
-test('formatHuman returns exitCode 1 when checks fail', (t) => {
-  const { exitCode } = formatHuman(mockSections)
-  t.is(exitCode, 1)
-})
-
-test('formatHuman returns exitCode 0 when all pass', (t) => {
-  const healthySections = [
-    { section: 'Env', results: [{ id: 'os', name: 'OS', ok: true }] },
-  ]
-  const { exitCode } = formatHuman(healthySections)
-  t.is(exitCode, 0)
-})
-
-test('formatHuman includes remediation for failed checks', (t) => {
-  const { lines } = formatHuman(mockSections)
-  const remediationLine = lines.find((l) => l.text.includes('How to fix'))
-  t.truthy(remediationLine)
-})
-
-test('formatHuman includes docsUrl for failed checks', (t) => {
-  const { lines } = formatHuman(mockSections)
-  const docsLine = lines.find((l) => l.text.includes('Documentation:'))
-  t.truthy(docsLine)
-  t.true(docsLine.text.includes('https://example.com'))
-})
-
-test('formatHuman with errors filter shows only failed', (t) => {
-  const { lines, isEmpty } = formatHuman(mockSections, { errors: true })
-  t.false(isEmpty)
-  // Should not include passed or warning checks
-  const osLine = lines.find((l) => l.text.includes('Operating system'))
-  t.falsy(osLine)
-  const nodeLine = lines.find((l) => l.text.includes('Node.js'))
-  t.truthy(nodeLine)
-})
-
-test('formatHuman with warnings filter shows only warnings', (t) => {
-  const { lines, isEmpty } = formatHuman(mockSections, { warnings: true })
-  t.false(isEmpty)
-  const depsLine = lines.find((l) => l.text.includes('Dependencies'))
-  t.truthy(depsLine)
-})
-
-test('formatHuman with both errors and warnings shows failed and warnings', (t) => {
-  const { lines, isEmpty } = formatHuman(mockSections, { errors: true, warnings: true })
-  t.false(isEmpty)
-  // Should include failed check
-  const nodeLine = lines.find((l) => l.text.includes('Node.js'))
-  t.truthy(nodeLine)
-  // Should include warning check
-  const depsLine = lines.find((l) => l.text.includes('Dependencies'))
-  t.truthy(depsLine)
-  // Should not include passed checks
-  const osLine = lines.find((l) => l.text.includes('Operating system'))
-  t.falsy(osLine)
-})
-
-test('formatHuman summary reflects unfiltered counts when --errors filter is active', (t) => {
-  // mockSections has 1 error and 1 warning — --errors shows only the error
-  const { summary, exitCode } = formatHuman(mockSections, { errors: true })
-  t.truthy(summary)
-  t.true(summary.text.includes('1 check failed'))
-  t.is(exitCode, 1)
-})
-
-test('formatHuman summary reflects unfiltered counts when --warnings filter is active', (t) => {
-  // mockSections has 1 error and 1 warning — --warnings shows only the warning,
-  // but summary should still report the error
-  const { summary, exitCode } = formatHuman(mockSections, { warnings: true })
-  t.truthy(summary)
-  t.true(summary.text.includes('1 check failed'))
-  t.is(summary.level, 'error')
-  t.is(exitCode, 1)
-})
-
-test('formatHuman returns isEmpty true when filter excludes all', (t) => {
-  const healthySections = [
-    { section: 'Env', results: [{ id: 'os', name: 'OS', ok: true }] },
-  ]
-  const { isEmpty, lines } = formatHuman(healthySections, { errors: true })
-  t.true(isEmpty)
-  t.true(lines[0].text.includes('No failed checks'))
-})
-
-test('formatHuman returns isEmpty with combined message when both filters exclude all', (t) => {
-  const healthySections = [
-    { section: 'Env', results: [{ id: 'os', name: 'OS', ok: true }] },
-  ]
-  const { isEmpty, lines } = formatHuman(healthySections, { errors: true, warnings: true })
-  t.true(isEmpty)
-  t.true(lines[0].text.includes('No failed checks or warnings'))
-})
-
-test('formatHuman isEmpty summary still reflects unfiltered status', (t) => {
-  // --warnings filter on sections with only an error → isEmpty, but summary shows the error
-  const errorSections = [
-    {
-      section: 'Outputs',
-      results: [
-        { id: 'pdf', name: 'PDF', ok: false, message: 'Last PDF build failed' },
-      ],
-    },
-  ]
-  const { isEmpty, summary, exitCode } = formatHuman(errorSections, { warnings: true })
-  t.true(isEmpty)
-  t.truthy(summary)
-  t.true(summary.text.includes('1 check failed'))
-  t.is(summary.level, 'error')
-  t.is(exitCode, 1)
-})
-
-test('formatHuman returns key in default mode', (t) => {
-  const { key } = formatHuman(mockSections, {})
-  t.truthy(key)
-  t.true(key.text.includes('Key:'))
-  t.true(key.text.includes('passed'))
-  t.true(key.text.includes('failed'))
-})
-
-test('formatHuman returns key without verbose', (t) => {
-  const { key } = formatHuman(mockSections, { verbose: false })
-  t.truthy(key)
-  t.true(key.text.includes('Key:'))
-})
-
-test('formatHuman hides key when --errors filter is active', (t) => {
-  const { key } = formatHuman(mockSections, { errors: true })
-  t.is(key, null)
-})
-
-test('formatHuman hides key when --warnings filter is active', (t) => {
-  const { key } = formatHuman(mockSections, { warnings: true })
-  t.is(key, null)
-})
-
-test('formatHuman includes details in verbose mode', (t) => {
-  const sectionsWithDetails = [
-    {
-      section: 'Env',
-      results: [
-        { id: 'os', name: 'OS', ok: true, message: 'macOS', details: '/usr/bin/sw_vers' },
-      ],
-    },
-  ]
-  const { lines } = formatHuman(sectionsWithDetails, { verbose: true })
-  const detailsLine = lines.find((l) => l.text.includes('/usr/bin/sw_vers'))
-  t.truthy(detailsLine)
-})
-
-test('formatHuman excludes details without verbose', (t) => {
-  const sectionsWithDetails = [
-    {
-      section: 'Env',
-      results: [
-        { id: 'os', name: 'OS', ok: true, message: 'macOS', details: '/usr/bin/sw_vers' },
-      ],
-    },
-  ]
-  const { lines } = formatHuman(sectionsWithDetails, { verbose: false })
-  const detailsLine = lines.find((l) => l.text.includes('/usr/bin/sw_vers'))
-  t.falsy(detailsLine)
-})
-
-test('formatHuman assigns correct log levels to lines', (t) => {
-  const { lines } = formatHuman(mockSections)
-  // Failed check should have error level
-  const nodeLine = lines.find((l) => l.text.includes('Node.js'))
-  t.is(nodeLine.level, 'error')
-  // Warning check should have warn level
-  const depsLine = lines.find((l) => l.text.includes('Dependencies'))
-  t.is(depsLine.level, 'warn')
-  // Passed check should have info level
-  const osLine = lines.find((l) => l.text.includes('Operating system'))
-  t.is(osLine.level, 'info')
-})
-
-test('formatHuman handles timeout status', (t) => {
-  const sectionsWithTimeout = [
-    {
-      section: 'Env',
-      results: [
-        { id: 'npm', name: 'npm', ok: false, level: 'timeout', message: 'Timed out' },
-      ],
-    },
-  ]
-  const { lines, summary } = formatHuman(sectionsWithTimeout)
-  const npmLine = lines.find((l) => l.text.includes('npm'))
-  t.truthy(npmLine)
-  t.is(npmLine.level, 'warn')
-  t.true(summary.text.includes('1 timed out'))
-})
-
-test('formatHuman summary shows warnings without errors', (t) => {
-  const warningSections = [
-    {
-      section: 'Project',
-      results: [
-        { id: 'deps', name: 'Dependencies', ok: false, level: 'warn', message: 'Outdated' },
-      ],
-    },
-  ]
-  const { summary, exitCode } = formatHuman(warningSections)
-  t.true(summary.text.includes('All checks passed with 1 warning'))
-  t.is(summary.level, 'warn')
-  t.is(exitCode, 0)
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// N/A count in summary
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('formatHuman summary includes N/A count when all checks pass', (t) => {
-  const sections = [
-    {
-      section: 'Outputs',
-      results: [
-        { id: 'build', name: 'Build', ok: true, message: 'Up to date' },
-        { id: 'pdf', name: 'PDF', ok: true, level: 'na', message: 'No PDF output' },
-        { id: 'epub', name: 'EPUB', ok: true, level: 'na', message: 'No EPUB output' },
-      ],
-    },
-  ]
-  const { summary } = formatHuman(sections)
-  t.true(summary.text.includes('All checks passed!'))
-  t.true(summary.text.includes('(2 not applicable)'))
-})
-
-test('formatHuman summary includes N/A count with warnings', (t) => {
-  const sections = [
-    {
-      section: 'Outputs',
-      results: [
-        { id: 'build', name: 'Build', ok: false, level: 'warn', message: 'Stale' },
-        { id: 'pdf', name: 'PDF', ok: true, level: 'na', message: 'No PDF output' },
-      ],
-    },
-  ]
-  const { summary } = formatHuman(sections)
-  t.true(summary.text.includes('All checks passed with 1 warning'))
-  t.true(summary.text.includes('(1 not applicable)'))
-})
-
-test('formatHuman summary omits N/A count when none exist', (t) => {
-  const sections = [
-    {
-      section: 'Env',
-      results: [
-        { id: 'os', name: 'OS', ok: true, message: 'macOS' },
-      ],
-    },
-  ]
-  const { summary } = formatHuman(sections)
-  t.true(summary.text.includes('All checks passed!'))
-  t.false(summary.text.includes('not applicable'))
-})
-
-test('formatHuman summary includes singular N/A count', (t) => {
-  const sections = [
-    {
-      section: 'Outputs',
-      results: [
-        { id: 'build', name: 'Build', ok: true, message: 'Up to date' },
-        { id: 'pdf', name: 'PDF', ok: true, level: 'na', message: 'No PDF output' },
-      ],
-    },
-  ]
-  const { summary } = formatHuman(sections)
-  t.true(summary.text.includes('(1 not applicable)'))
-})
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Terminal width-aware wrapping
-// ─────────────────────────────────────────────────────────────────────────────
-
-test('formatHuman wraps long remediation text to fit terminal width', (t) => {
-  const longRemediation = 'Install Node.js version 22 or later using your preferred package manager such as nvm, Homebrew, or download directly from the official Node.js website at nodejs.org'
-  const sections = [
-    {
-      section: 'Environment',
-      results: [
-        { id: 'node', name: 'Node.js', ok: false, level: 'error', message: 'v18', remediation: longRemediation },
-      ],
-    },
-  ]
-  // Force narrow terminal (40 columns)
-  const { lines } = formatHuman(sections, { columns: 40 })
-  const checkLine = lines.find((l) => l.text.includes('How to fix'))
-  t.truthy(checkLine)
-
-  // The remediation text should be wrapped — each line should not exceed 40 chars
-  // (remediation is indented 4 spaces, so content width is 36)
-  const remediationLines = checkLine.text.split('\n').filter((l) => l.trim() && !l.includes('How to fix') && !l.includes('Node.js'))
-  for (const line of remediationLines) {
-    t.true(line.length <= 42, `line exceeds terminal width: "${line}" (${line.length} chars)`)
-  }
-})
-
-test('formatHuman wraps verbose details to fit terminal width', (t) => {
-  const longDetails = '/very/long/path/to/some/deeply/nested/directory/structure/that/exceeds/the/terminal/width/when/displayed/in/verbose/mode'
-  const sections = [
-    {
-      section: 'Environment',
-      results: [
-        { id: 'node', name: 'Node.js', ok: true, message: 'v22', details: longDetails },
-      ],
-    },
-  ]
-  // Force narrow terminal (50 columns)
-  const { lines } = formatHuman(sections, { verbose: true, columns: 50 })
-  const checkLine = lines.find((l) => l.text.includes(longDetails.substring(0, 20)))
-  t.truthy(checkLine)
-
-  // Details are indented 6 spaces, so content width is 44
-  const detailLines = checkLine.text.split('\n').filter((l) => l.includes('/'))
-  for (const line of detailLines) {
-    t.true(line.length <= 52, `detail line exceeds terminal width: "${line}" (${line.length} chars)`)
-  }
-})
-
-test('formatHuman preserves remediation newlines when wrapping', (t) => {
-  const multiLineRemediation = 'Install Node.js 22 or later:\n    • Run: nvm install 22\n    • Or: brew install node@22'
-  const sections = [
-    {
-      section: 'Environment',
-      results: [
-        { id: 'node', name: 'Node.js', ok: false, level: 'error', message: 'v18', remediation: multiLineRemediation },
-      ],
-    },
-  ]
-  const { lines } = formatHuman(sections, { columns: 80 })
-  const checkLine = lines.find((l) => l.text.includes('How to fix'))
-  t.truthy(checkLine)
-  // All three original lines should appear in the output
-  t.true(checkLine.text.includes('Install Node.js'))
-  t.true(checkLine.text.includes('nvm install'))
-  t.true(checkLine.text.includes('brew install'))
-})
-
-test('formatHuman applies default width when columns not specified', (t) => {
-  const sections = [
-    {
-      section: 'Environment',
-      results: [
-        { id: 'node', name: 'Node.js', ok: false, level: 'error', message: 'v18', remediation: 'Upgrade' },
-      ],
-    },
-  ]
-  // Should not throw — uses getTerminalWidth() fallback
-  const { lines } = formatHuman(sections)
-  t.truthy(lines)
-})
-
-test('formatHuman enforces minimum content width of 20 for very narrow terminals', (t) => {
-  const sections = [
-    {
-      section: 'Environment',
-      results: [
-        { id: 'node', name: 'Node.js', ok: false, level: 'error', message: 'v18', remediation: 'Install Node.js version 22 or later' },
-      ],
-    },
-  ]
-  // Extremely narrow terminal (10 columns) — should still produce output
-  const { lines } = formatHuman(sections, { columns: 10 })
-  const checkLine = lines.find((l) => l.text.includes('How to fix'))
-  t.truthy(checkLine)
-  t.true(checkLine.text.includes('Install'))
-})

package/src/lib/doctor/formatters/index.js

@@ -1,8 +0,0 @@
-/**
- * Doctor output formatters
- *
- * @module lib/doctor/formatters
- */
-export { countResults, filterResults, getStatus, STATUS_ICONS } from './shared.js'
-export { formatHuman } from './human.js'
-export { formatJson } from './json.js'

package/src/lib/doctor/formatters/json.js

@@ -1,78 +0,0 @@
-/**
- * JSON formatter for doctor check results
- *
- * Formats check results as machine-readable JSON for programmatic consumption.
- *
- * @module lib/doctor/formatters/json
- */
-import { getStatus, countResults, filterResults } from './shared.js'
-
-/**
- * Format check results as JSON
- *
- * @param {Array} sections - Check results organized by section
- * @param {Object} [options] - Formatting options
- * @param {boolean} [options.errors] - Only include failed checks
- * @param {boolean} [options.warnings] - Only include warning checks
- * @param {boolean} [options.verbose] - Include additional details
- * @returns {{json: string, exitCode: number}} Formatted JSON string and exit code
- *
- * @example
- * const { json, exitCode } = formatJson(sections, { verbose: true })
- * console.log(json)
- * process.exit(exitCode)
- */
-export function formatJson(sections, options = {}) {
-  const filteredSections = filterResults(sections, options)
-  const counts = countResults(sections)
-  const allChecks = []
-
-  for (const { section, results } of filteredSections) {
-    for (const result of results) {
-      const status = getStatus(result)
-
-      // Build check object
-      const check = {
-        id: result.id,
-        name: result.name,
-        section,
-        status,
-        message: result.message || null,
-      }
-
-      // Include verbose details if requested
-      if (options.verbose && result.details) {
-        check.details = result.details
-      }
-
-      // Include remediation for failed/warning/timeout checks
-      if (!result.ok && result.remediation) {
-        check.remediation = result.remediation
-      }
-
-      if (!result.ok && result.docsUrl) {
-        check.docsUrl = result.docsUrl
-      }
-
-      allChecks.push(check)
-    }
-  }
-
-  // Indicate active filters so consumers know results is a subset
-  const activeFilters = []
-  if (options.errors) activeFilters.push('errors')
-  if (options.warnings) activeFilters.push('warnings')
-
-  const output = {
-    summary: counts,
-    ...(activeFilters.length > 0 && { filter: activeFilters }),
-    results: allChecks,
-  }
-
-  return {
-    json: JSON.stringify(output, null, 2),
-    exitCode: counts.failed > 0 ? 1 : 0,
-  }
-}
-
-export default formatJson