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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-rc.36",
+  "version": "1.0.0-rc.37",
   "author": "Getty Digital",
   "license": "SEE LICENSE IN https://github.com/thegetty/quire/blob/main/LICENSE",
   "bugs": {

package/src/commands/build.js

@@ -49,20 +49,12 @@ Note: Run before "quire pdf" or "quire epub" commands.
     // Configure reporter for this command
     reporter.configure({ quiet: options.quiet, verbose: options.verbose })
 
-    reporter.start('Building site...', { showElapsed: true })
-
-    try {
-      if (options['11ty'] === 'api') {
-        this.debug('running eleventy using lib/11ty api')
-        await api.build(options)
-      } else {
-        this.debug('running eleventy using lib/11ty cli')
-        await cli.build(options)
-      }
-      reporter.succeed('Build complete')
-    } catch (error) {
-      reporter.fail('Build failed')
-      throw error
+    if (options['11ty'] === 'api') {
+      this.debug('running eleventy using lib/11ty api')
+      await api.build(options)
+    } else {
+      this.debug('running eleventy using lib/11ty cli')
+      await cli.build(options)
     }
   }
 

package/src/commands/build.test.js

@@ -108,8 +108,6 @@ test('build command should call eleventy CLI with default options', async (t) =>
   t.true(mockClean.called, 'clean should be called in preAction')
   t.false(mockEleventyApi.build.called, 'eleventy API build should not be called')
   t.true(mockEleventyCli.build.called, 'eleventy CLI build should be called')
-  t.true(mockReporter.start.called, 'reporter.start should be called')
-  t.true(mockReporter.succeed.called, 'reporter.succeed should be called')
 })
 
 test('build command should call eleventy API when 11ty option is "api"', async (t) => {
@@ -282,7 +280,7 @@ test('build command should pass options to eleventy build', async (t) => {
   t.true(mockEleventyCli.build.calledWith(options), 'eleventy CLI build should be called with options')
 })
 
-test('build command should call reporter.fail when build fails', async (t) => {
+test('build command should propagate errors from eleventy build', async (t) => {
   const { sandbox, fs, mockLogger, mockReporter } = t.context
 
   const buildError = new Error('Build failed')
@@ -334,11 +332,8 @@ test('build command should call reporter.fail when build fails', async (t) => {
   command.name = sandbox.stub().returns('build')
 
   // Run action and expect it to throw
+  // Nota bene: reporter.start/succeed/fail are called by the lib layer, not the command
   await t.throwsAsync(() => command.action({ '11ty': 'api' }, command), { message: 'Build failed' })
-
-  t.true(mockReporter.start.called, 'reporter.start should be called')
-  t.true(mockReporter.fail.called, 'reporter.fail should be called on error')
-  t.false(mockReporter.succeed.called, 'reporter.succeed should not be called on error')
 })
 
 test('build command should configure reporter with quiet option', async (t) => {

package/src/commands/preview.js

@@ -2,6 +2,7 @@ import Command from '#src/Command.js'
 import { Option } from 'commander'
 import { withOutputModes } from '#lib/commander/index.js'
 import { api, cli } from '#lib/11ty/index.js'
+import reporter from '#lib/reporter/index.js'
 import testcwd from '#helpers/test-cwd.js'
 
 /**
@@ -22,11 +23,13 @@ export default class PreviewCommand extends Command {
 Examples:
   quire preview                  Start preview server on default port
   quire preview --port 3000      Run on custom port
+  quire preview --open           Start server and open in browser
   quire preview --verbose        Start with detailed progress
 `,
     version: '1.1.0',
     options: [
       [ '-p, --port <port>', 'configure development server port', 8080 ],
+      [ '--open', 'open in default browser when server starts' ],
       // Use Option object syntax to configure this as a hidden option
       new Option('--11ty <module>', 'use the specified 11ty module')
         .choices(['api', 'cli']).default('api').hideHelp(),
@@ -40,12 +43,15 @@ Examples:
   async action(options, command) {
     this.debug('called with options %O', options)
 
+    // Configure reporter for this command
+    reporter.configure({ quiet: options.quiet, verbose: options.verbose })
+
     if (options['11ty'] === 'api') {
       this.debug('running eleventy using lib/11ty api')
-      api.serve(options)
+      await api.serve(options)
     } else {
       this.debug('running eleventy using lib/11ty cli')
-      cli.serve(options)
+      await cli.serve(options)
     }
   }
 

package/src/lib/11ty/api.js

@@ -33,7 +33,7 @@
 import { dynamicImport } from '#helpers/os-utils.js'
 import path from 'node:path'
 import paths from '#lib/project/index.js'
-import { logger } from '#lib/logger/index.js'
+import reporter from '#lib/reporter/index.js'
 import createDebug from '#debug'
 
 const debug = createDebug('lib:11ty:api')
@@ -172,15 +172,21 @@ class Quire11ty {
     const projectRoot = this.paths.getProjectRoot()
     process.chdir(projectRoot)
 
-    logger.info('Building site...')
-
     configureEleventyEnv({ mode: 'production', debug: options.debug })
 
+    reporter.start('Building site...', { showElapsed: true })
+
     const eleventy = await createEleventyInstance(options)
 
     eleventy.setDryRun(options.dryRun)
 
-    await eleventy.write()
+    try {
+      await eleventy.write()
+      reporter.succeed('Build complete')
+    } catch (error) {
+      reporter.fail('Build failed')
+      throw error
+    }
   }
 
   /**
@@ -196,10 +202,10 @@ class Quire11ty {
     const projectRoot = this.paths.getProjectRoot()
     process.chdir(projectRoot)
 
-    logger.info('Starting development server...')
-
     configureEleventyEnv({ mode: 'development', debug: options.debug })
 
+    reporter.start('Starting development server...')
+
     const eleventy =
       await createEleventyInstance({ ...options, runMode: 'serve' })
 
@@ -209,6 +215,19 @@ class Quire11ty {
     // Initialize Eleventy before serving (required for eleventyServe)
     await eleventy.init()
 
+    // Register a ready callback to resolve the spinner when the server is listening
+    // @see https://www.11ty.dev/docs/dev-server/#options
+    eleventy.eleventyServe.config.serverOptions = {
+      ...eleventy.eleventyServe.config.serverOptions,
+      ready: (server) => {
+        const url = server.getServerUrl('localhost')
+        reporter.succeed(`Server running at ${url}`)
+        if (options.open) {
+          import('open').then(({ default: open }) => open(url))
+        }
+      },
+    }
+
     await eleventy.serve(options.port)
   }
 }

package/src/lib/11ty/cli.js

@@ -3,8 +3,8 @@ import fs from 'node:fs'
 import path from 'node:path'
 import paths from '#lib/project/index.js'
 import processManager from '#lib/process/manager.js'
+import reporter from '#lib/reporter/index.js'
 import { BuildFailedError } from '#src/errors/index.js'
-import { logger } from '#lib/logger/index.js'
 import createDebug from '#debug'
 
 const debug = createDebug('lib:11ty')
@@ -108,14 +108,14 @@ export default {
    * @param {Object} options - Build options
    */
   build: async (options = {}) => {
-    logger.info('Building site...')
-
     const { command, env, projectRoot } = factory(options)
 
     if (options.dryRun) command.push('--dryrun')
 
     env.ELEVENTY_ENV = 'production'
 
+    reporter.start('Building site...', { showElapsed: true })
+
     try {
       const build = spawn(command, { cwd: projectRoot, env })
       await build
@@ -123,11 +123,13 @@ export default {
       if (build.exitCode !== 0) {
         throw new BuildFailedError(`Eleventy exited with code ${build.exitCode}`)
       }
+      reporter.succeed('Build complete')
     } catch (error) {
       if (error.isCanceled) {
         debug('build cancelled')
         return
       }
+      reporter.fail('Build failed')
       throw error
     }
   },
@@ -137,16 +139,26 @@ export default {
    * @param {Object} options - Serve options
    */
   serve: async (options = {}) => {
-    logger.info('Starting development server...')
-
     const { command, env, projectRoot } = factory(options)
 
     command.push('--serve')
 
+    const port = options.port || 8080
     if (options.port) command.push(`--port=${options.port}`)
 
     env.ELEVENTY_ENV = 'development'
 
+    reporter.start('Starting development server...')
+
+    // Resolve the spinner before the subprocess takes over stdout
+    const url = `http://localhost:${port}`
+    reporter.succeed(`Server running at ${url}`)
+
+    if (options.open) {
+      const { default: open } = await import('open')
+      open(url)
+    }
+
     try {
       await spawn(command, { cwd: projectRoot, env })
     } catch (error) {

package/src/lib/logger/debug.js

@@ -1,3 +1,4 @@
+import util from 'node:util'
 import debug from 'debug'
 
 /**
@@ -6,6 +7,10 @@ import debug from 'debug'
  * Creates debug instances with the `quire:` namespace prefix.
  * Uses the standard `debug` package for namespace-based filtering.
  *
+ * Object formatting:
+ *   %O  Pretty-printed, indented on a new line (multi-line)
+ *   %o  Compact single-line output (built-in default)
+ *
  * @example
  * // In a module (short alias)
  * import createDebug from '#debug'
@@ -22,6 +27,42 @@ import debug from 'debug'
  * @see https://www.npmjs.com/package/debug
  */
 
+/**
+ * Override %O formatter to produce indented multi-line output
+ *
+ * Pretty-prints objects with each line indented by 2 spaces,
+ * starting on a new line after the label.
+ *
+ * Use %o (lowercase) for compact single-line output.
+ */
+debug.formatters.O = function (value) {
+  this.inspectOpts.colors = this.useColors
+  const string = util.inspect(value, this.inspectOpts)
+  return '\n' + string.split('\n').map((line) => '  ' + line).join('\n')
+}
+
+/**
+ * Override formatArgs to prevent per-line namespace prefixing
+ *
+ * The default debug formatArgs (in color mode) splits the formatted
+ * message on newlines and inserts the namespace prefix before every
+ * line. This makes multi-line %O output noisy. This override only
+ * prefixes the first line, letting continuation lines flow cleanly.
+ */
+const originalFormatArgs = debug.formatArgs
+debug.formatArgs = function (args) {
+  if (this.useColors) {
+    const c = this.color
+    const colorCode = '\u001B[3' + (c < 8 ? c : '8;5;' + c)
+    const prefix = `  ${colorCode};1m${this.namespace} \u001B[0m`
+
+    args[0] = prefix + args[0]
+    args.push(colorCode + 'm+' + debug.humanize(this.diff) + '\u001B[0m')
+  } else {
+    originalFormatArgs.call(this, args)
+  }
+}
+
 /**
  * Root namespace for all Quire CLI debug output
  */
@@ -37,7 +78,8 @@ export const DEBUG_NAMESPACE = 'quire'
  * const debug = createDebug('lib:pdf:paged')
  * debug('printer options: %O', options)
  * // Output (when DEBUG=quire:lib:pdf:paged):
- * // quire:lib:pdf:paged printer options: { ... } +0ms
+ * // quire:lib:pdf:paged printer options:
+ * //   { format: 'A4', landscape: false } +0ms
  */
 export default function createDebug(namespace) {
   return debug(`${DEBUG_NAMESPACE}:${namespace}`)

package/src/lib/logger/debug.test.js

@@ -0,0 +1,128 @@
+import test from 'ava'
+import debug from 'debug'
+// Import to register formatter and formatArgs overrides
+import './debug.js'
+
+/**
+ * Debug formatter and output tests
+ *
+ * Verifies the custom %O formatter produces indented multi-line output,
+ * the %o formatter remains compact single-line, and the formatArgs
+ * override prevents per-line namespace prefixing in colored output.
+ */
+
+/**
+ * Helper to call a debug formatter with a value
+ *
+ * Formatters are called with `this` bound to a debugger-like context.
+ * We provide the minimal context the formatters expect.
+ */
+function callFormatter(specifier, value) {
+  const formatter = debug.formatters[specifier]
+  const context = {
+    useColors: false,
+    inspectOpts: { colors: false },
+  }
+  return formatter.call(context, value)
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// %O formatter (pretty-printed, indented)
+// ─────────────────────────────────────────────────────────────────────────────
+
+test('%O output starts with a newline', (t) => {
+  const result = callFormatter('O', { a: 1 })
+  t.true(result.startsWith('\n'))
+})
+
+test('%O output lines are indented with 2 spaces', (t) => {
+  const result = callFormatter('O', { a: 1, b: 2 })
+  const lines = result.split('\n').slice(1) // skip leading empty line
+  for (const line of lines) {
+    t.true(line.startsWith('  '), `Line not indented: "${line}"`)
+  }
+})
+
+test('%O formats nested objects with indentation', (t) => {
+  const result = callFormatter('O', { outer: { inner: 'value' } })
+  t.true(result.includes('outer'))
+  t.true(result.includes('inner'))
+  // Every line after the leading newline should be indented
+  const lines = result.split('\n').slice(1)
+  for (const line of lines) {
+    t.true(line.startsWith('  '), `Line not indented: "${line}"`)
+  }
+})
+
+test('%O handles null without error', (t) => {
+  const result = callFormatter('O', null)
+  t.true(result.includes('null'))
+})
+
+test('%O handles undefined without error', (t) => {
+  const result = callFormatter('O', undefined)
+  t.true(result.includes('undefined'))
+})
+
+test('%O handles primitive values', (t) => {
+  t.true(callFormatter('O', 42).includes('42'))
+  t.true(callFormatter('O', 'hello').includes('hello'))
+  t.true(callFormatter('O', true).includes('true'))
+})
+
+test('%O handles arrays', (t) => {
+  const result = callFormatter('O', [1, 2, 3])
+  t.true(result.includes('1'))
+  t.true(result.includes('2'))
+  t.true(result.includes('3'))
+})
+
+// ─────────────────────────────────────────────────────────────────────────────
+// %o formatter (compact single-line, built-in)
+// ─────────────────────────────────────────────────────────────────────────────
+
+test('%o output is single-line', (t) => {
+  const result = callFormatter('o', { a: 1, b: 2, c: 3 })
+  t.false(result.includes('\n'))
+})
+
+test('%o does not start with a newline', (t) => {
+  const result = callFormatter('o', { a: 1 })
+  t.false(result.startsWith('\n'))
+})
+
+// ─────────────────────────────────────────────────────────────────────────────
+// formatArgs override (prefix only on first line)
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Helper to call formatArgs and capture the result
+ *
+ * Creates a minimal debugger-like context to test formatArgs behavior.
+ * In color mode, the default debug formatArgs would split on newlines
+ * and insert the prefix before every line. Our override prevents this.
+ */
+function callFormatArgs(message, useColors = true) {
+  const args = [message]
+  const context = {
+    namespace: 'test',
+    useColors,
+    color: 5,
+    diff: 0,
+  }
+  debug.formatArgs.call(context, args)
+  return args[0]
+}
+
+test('formatArgs prefixes the first line in color mode', (t) => {
+  const result = callFormatArgs('hello')
+  t.true(result.includes('test'))
+  t.true(result.includes('hello'))
+})
+
+test('formatArgs does not duplicate prefix on multi-line output', (t) => {
+  const result = callFormatArgs('paths:\n  { a: 1 }\n  { b: 2 }')
+  // Namespace should appear exactly once
+  const matches = result.match(/test/g)
+  t.is(matches.length, 1)
+})