@thegetty/quire-cli 1.0.0-rc.37 → 1.0.0-rc.39

package/src/commands/epub.js

@@ -5,6 +5,7 @@ import eleventy from '#lib/11ty/index.js'
 import fs from 'fs-extra'
 import generateEpub, { ENGINES } from '#lib/epub/index.js'
 import open from 'open'
+import { recordStatus } from '#lib/conf/build-status.js'
 import reporter from '#lib/reporter/index.js'
 import testcwd from '#helpers/test-cwd.js'
 import { MissingBuildOutputError } from '#src/errors/index.js'
@@ -84,9 +85,15 @@ Examples:
     // Pass engine as lib (matching lib/pdf interface)
     // Reporter lifecycle is owned by the façade (lib/epub/index.js)
     const epubOptions = { ...options, lib: options.engine }
-    const output = await generateEpub(epubOptions)
 
-    if (fs.existsSync(output) && options.open) open(output)
+    try {
+      const output = await generateEpub(epubOptions)
+      recordStatus(paths.getProjectRoot(), 'epub', 'ok')
+      if (fs.existsSync(output) && options.open) open(output)
+    } catch (error) {
+      recordStatus(paths.getProjectRoot(), 'epub', 'failed')
+      throw error
+    }
   }
 
   preAction(thisCommand, actionCommand) {

package/src/commands/help.js

@@ -0,0 +1,60 @@
+import Command from '#src/Command.js'
+import { outputWithPaging } from '#helpers/pager.js'
+import { getTopicContent, getTopicList } from '#lib/help/index.js'
+
+/**
+ * Quire CLI `help` Command
+ *
+ * Display help for a specific topic or list available topics.
+ * Complements Commander's built-in help with extended documentation.
+ *
+ * @example
+ * quire help                 # List available topics
+ * quire help workflows       # Show workflows topic
+ * quire help --list          # List available topics
+ *
+ * @class      HelpCommand
+ * @extends    {Command}
+ */
+export default class HelpCommand extends Command {
+  static definition = {
+    name: 'help',
+    aliases: ['h'],
+    description: 'Display help for a topic or list available topics',
+    summary: 'show help for a topic',
+    docsLink: 'quire-commands/',
+    helpText: `
+Examples:
+  quire help                 List available help topics
+  quire help workflows       Show common workflow examples
+  quire help pdf             Show PDF generation guide
+  quire help --list          List all available topics
+`,
+    version: '1.0.0',
+    args: [
+      ['[topic]', 'help topic to display']
+    ],
+    options: [
+      ['--list', 'list all available topics'],
+    ],
+  }
+
+  constructor() {
+    super(HelpCommand.definition)
+  }
+
+  async action(topic, options, command) {
+    this.debug('called with topic=%s options=%O', topic, options)
+
+    // List topics if no topic specified or --list flag
+    if (!topic || options.list) {
+      const list = await getTopicList()
+      process.stdout.write(list + '\n')
+      return
+    }
+
+    // Display requested topic with paging (throws HelpTopicNotFoundError if missing)
+    const content = await getTopicContent(topic)
+    await outputWithPaging(content)
+  }
+}

package/src/commands/help.test.js

@@ -0,0 +1,132 @@
+import esmock from 'esmock'
+import sinon from 'sinon'
+import test from 'ava'
+
+/**
+ * Help Command Integration Tests
+ *
+ * Tests the help command behavior with mocked dependencies.
+ */
+
+test.serial('help command outputs topic list when called without arguments', async (t) => {
+  const sandbox = sinon.createSandbox()
+  const stdoutWrite = sandbox.stub(process.stdout, 'write')
+
+  try {
+    const mockList = 'Available help topics:\n  debugging  Troubleshooting help'
+
+    const HelpCommand = await esmock('./help.js', {
+      '#lib/help/index.js': {
+        getTopicList: sandbox.stub().resolves(mockList),
+        getTopicContent: sandbox.stub()
+      },
+      '#helpers/pager.js': {
+        outputWithPaging: sandbox.stub()
+      }
+    })
+
+    const command = new HelpCommand.default()
+    await command.action(undefined, {}, {})
+
+    t.true(stdoutWrite.calledOnce)
+    t.true(stdoutWrite.calledWith(mockList + '\n'))
+  } finally {
+    sandbox.restore()
+  }
+})
+
+test.serial('help command outputs topic list when --list flag is provided', async (t) => {
+  const sandbox = sinon.createSandbox()
+  const stdoutWrite = sandbox.stub(process.stdout, 'write')
+
+  try {
+    const mockList = 'Available help topics:\n  pdf  PDF generation'
+
+    const HelpCommand = await esmock('./help.js', {
+      '#lib/help/index.js': {
+        getTopicList: sandbox.stub().resolves(mockList),
+        getTopicContent: sandbox.stub()
+      },
+      '#helpers/pager.js': {
+        outputWithPaging: sandbox.stub()
+      }
+    })
+
+    const command = new HelpCommand.default()
+    await command.action('ignored', { list: true }, {})
+
+    t.true(stdoutWrite.calledOnce)
+    t.true(stdoutWrite.calledWith(mockList + '\n'))
+  } finally {
+    sandbox.restore()
+  }
+})
+
+test('help command outputs topic content with paging when topic is specified', async (t) => {
+  const sandbox = sinon.createSandbox()
+
+  try {
+    const mockRendered = 'Rendered workflows content'
+    const mockOutputWithPaging = sandbox.stub().resolves()
+
+    const HelpCommand = await esmock('./help.js', {
+      '#lib/help/index.js': {
+        getTopicList: sandbox.stub(),
+        getTopicContent: sandbox.stub().resolves(mockRendered)
+      },
+      '#helpers/pager.js': {
+        outputWithPaging: mockOutputWithPaging
+      }
+    })
+
+    const command = new HelpCommand.default()
+    await command.action('workflows', {}, {})
+
+    t.true(mockOutputWithPaging.calledOnce)
+    t.true(mockOutputWithPaging.calledWith(mockRendered))
+  } finally {
+    sandbox.restore()
+  }
+})
+
+test('help command propagates HelpTopicNotFoundError from getTopicContent', async (t) => {
+  const sandbox = sinon.createSandbox()
+
+  try {
+    const { default: HelpTopicNotFoundError } = await import('#src/errors/help/help-topic-not-found-error.js')
+
+    const HelpCommand = await esmock('./help.js', {
+      '#lib/help/index.js': {
+        getTopicList: sandbox.stub(),
+        getTopicContent: sandbox.stub().rejects(new HelpTopicNotFoundError('nonexistent'))
+      },
+      '#helpers/pager.js': {
+        outputWithPaging: sandbox.stub()
+      }
+    })
+
+    const command = new HelpCommand.default()
+
+    const error = await t.throwsAsync(
+      () => command.action('nonexistent', {}, {}),
+      { name: 'HelpTopicNotFoundError' }
+    )
+
+    t.is(error.code, 'HELP_TOPIC_NOT_FOUND')
+    t.is(error.exitCode, 2)
+    t.is(error.topic, 'nonexistent')
+  } finally {
+    sandbox.restore()
+  }
+})
+
+test('help command has correct definition', async (t) => {
+  const HelpCommand = await import('./help.js')
+  const command = new HelpCommand.default()
+
+  t.is(command.name, 'help')
+  t.deepEqual(command.aliases, ['h'])
+  t.truthy(command.description)
+  t.truthy(command.args)
+  t.truthy(command.options)
+})

package/src/commands/info.js

@@ -1,34 +1,52 @@
 import Command from '#src/Command.js'
-import npm from '#lib/npm/index.js'
-import { execa } from 'execa'
+import { withOutputModes } from '#lib/commander/index.js'
+import { binPath } from '#src/packageConfig.js'
 import fs from 'node:fs'
-import os from 'node:os'
 import path from 'node:path'
 import testcwd from '#helpers/test-cwd.js'
 
 /**
  * Quire CLI `info` Command
  *
- * Runs the Eleventy `info` command to list the quire-cli, quire-11ty, node, and npm versions.
+ * Display version information for the current Quire project.
+ * Shows the versions of quire-cli and quire-11ty that the project was
+ * created with, plus the starter template version.
+ *
+ * With --debug, also shows the full filesystem path to the quire-cli
+ * executable.
+ *
+ * For system environment information (OS, Node.js, npm, Git),
+ * use the `quire doctor` command instead.
  *
  * @class      InfoCommand
  * @extends    {Command}
  */
 export default class InfoCommand extends Command {
-  static definition = {
+  static definition = withOutputModes({
     name: 'info',
-    description: 'List Quire cli, quire-11ty, and node versions',
-    summary: 'show version information',
+    description: 'Display version information for the current project',
+    summary: 'show project version information',
     docsLink: 'quire-commands/#get-help',
     helpText: `
+Shows the versions used when this project was created:
+  • quire-cli version that created the project
+  • quire-11ty version installed in the project
+  • starter template version (if available)
+
+For system environment checks (OS, Node.js, npm, Git),
+use 'quire doctor' instead.
+
 Example:
-  quire info --debug    Include node, npm, and OS versions
+  quire info           Show project versions
+  quire info --debug   Include installation paths
+  quire info --json    Output version information as JSON
+  quire doctor         Check environment and project health
 `,
     version: '1.0.0',
     options: [
-      ['--debug', 'include os versions in output']
+      ['--json', 'output version information as JSON'],
     ],
-  }
+  })
 
   constructor() {
     super(InfoCommand.definition)
@@ -43,79 +61,69 @@ Example:
 
     try {
       const versionFileData = fs.readFileSync(versionFileName, { encoding: 'utf8' })
-
-      versionInfo = JSON.parse(versionFileData)      
+      versionInfo = JSON.parse(versionFileData)
     } catch (error) {
       this.logger.warn(
         `This project was generated with the quire-cli prior to version 1.0.0.rc-8. Updating the version file to the new format, though this project's version file will not contain specific starter version information.`
       )
-
       fs.writeFileSync(versionFileName, JSON.stringify(versionInfo))
     }
 
     const { name: projectDirectory } = path.parse(process.cwd())
 
-    const versions = [
-      {
-        title: `[${projectDirectory}]`,
-        items: [
-          {
-            name: 'quire-cli',
-            get: () => versionInfo.cli,
-          },
-          {
-            name: 'quire-11ty',
-            get: () => {
-              const { version } = JSON.parse(fs.readFileSync('./package.json'))
-              return version
-            },
-          },
-          {
-            name: 'starter',
-            get: () => versionInfo.starter,
-          },
-        ],
-      },
-      {
-        title: '[System]',
-        items: [
-          {
-            name: 'quire-cli',
-            get: async () => {
-              const { stdout } = await execa('quire', ['--version'])
-              return stdout
-            },
-          },
-          {
-            debug: true,
-            name: 'node',
-            get: () => process.version,
-          },
-          {
-            debug: true,
-            name: 'npm',
-            get: async () => await npm.version(),
-          },
-          {
-            debug: true,
-            name: 'os',
-            get: () => `${os.type()} ${os.release()}`,
-          },
-        ],
-      },
+    // Read quire-11ty version from project's package.json
+    let quire11tyVersion = 'unknown'
+    try {
+      const packageJson = JSON.parse(fs.readFileSync('./package.json', 'utf8'))
+      quire11tyVersion = packageJson.version
+    } catch {
+      this.debug('Could not read package.json')
+    }
+
+    if (options.json) {
+      const result = {
+        project: {
+          directory: projectDirectory,
+          cli: versionInfo.cli,
+          quire11ty: quire11tyVersion,
+          starter: versionInfo.starter || null,
+        },
+      }
+      console.log(JSON.stringify(result, null, 2))
+      return
+    }
+
+    const lines = [
+      `Project: ${projectDirectory}`,
+      '',
+      `  quire-cli    ${versionInfo.cli || 'unknown'}`,
+      `  quire-11ty   ${quire11tyVersion}`,
     ]
 
-    /**
-     * Filter the command output based on `debug` settings
-     */
-    for (const { items, title } of versions) {
-      const versionList = await Promise.all(
-        items
-          .filter(({ debug }) => !debug || (options.debug && debug))
-          .map(async ({ name, get }) => `${name} ${await get()}`)
-      )
-      this.logger.info(`${title}\n ${versionList.join('\n ')}`)
+    if (versionInfo.starter) {
+      lines.push(`  starter      ${versionInfo.starter}`)
+    }
+
+    if (options.debug) {
+      lines.push('')
+      lines.push(this.resolveCliPath())
     }
+
+    lines.push('')
+    lines.push('Tip: Run \'quire doctor\' for system environment checks')
+
+    this.logger.info(lines.join('\n'))
+  }
+
+  /**
+   * Resolve the full filesystem path to the quire CLI executable
+   * @returns {string} Formatted path line
+   */
+  resolveCliPath() {
+    const resolved = binPath()
+    return resolved
+      ? `  quire-cli    ${resolved}`
+      : '  quire-cli    not found in PATH'
   }
 
   preAction(thisCommand, actionCommand) {

package/src/commands/info.spec.js

@@ -40,15 +40,22 @@ test('registered command has correct options', (t) => {
   const { command } = t.context
 
   // Get all options
+  const jsonOption = command.options.find((opt) => opt.long === '--json')
   const debugOption = command.options.find((opt) => opt.long === '--debug')
 
   // Verify all options exist
+  t.truthy(jsonOption, '--json 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(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(debugOption.long, '--debug')
   t.truthy(debugOption.description)
   t.false(debugOption.required, '--debug should not require a value')
@@ -60,5 +67,6 @@ test('command options are accessible via public API', (t) => {
   // 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('--debug'))
 })