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

package/bin/cli.js

@@ -20,7 +20,20 @@ process.removeAllListeners('warning')
 process.env.QUIRE_LOG_LEVEL = config.get('logLevel') || 'info'
 
 /**
- * Dynamic import ensures env var is set before logger modules are loaded
+ * Set NO_COLOR env var from config before importing CLI modules
+ *
+ * Chalk 5.x and ora read NO_COLOR at module load time.
+ * Setting it here ensures color is disabled before any styled imports.
+ * If NO_COLOR is already set in the shell environment, we do not override it.
+ *
+ * @see https://no-color.org/
+ */
+if (process.env.NO_COLOR === undefined && config.get('logUseColor') === false) {
+  process.env.NO_COLOR = '1'
+}
+
+/**
+ * Dynamic import ensures env vars are set before logger modules are loaded
  */
 const { default: cli } = await import('#src/main.js')
 

package/package.json

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

package/src/commands/config.js

@@ -205,7 +205,7 @@ Examples:
     const output = formatSettings(this.config.store, {
       showInternal: options.debug,
       configPath: this.config.path,
-      useColor: this.config.get('logUseColor'),
+      useColor: this.config.get('logUseColor') && !process.env.NO_COLOR,
     })
     this.logger.info(output)
   }

package/src/lib/commander/index.js

@@ -10,6 +10,8 @@ import { Argument, Option } from 'commander'
 
 // Re-export shared option definitions
 export {
+  colorOption,
+  noColorOption,
   quietOption,
   verboseOption,
   debugOption,

package/src/lib/commander/options.js

@@ -124,6 +124,30 @@ export const debugOption = [
   { conflicts: ['quiet'] }
 ]
 
+/**
+ * Color options - enable/disable colored output
+ *
+ * Commander.js requires separate option definitions for --color and --no-color
+ * to support both the positive and negative forms. When --color has no default,
+ * the three-state semantics are:
+ *
+ * - `--color` → options.color = true (force color on)
+ * - `--no-color` → options.color = false (force color off)
+ * - (no flag) → options.color = undefined (falls back to env/config)
+ *
+ * Respects the NO_COLOR environment variable (https://no-color.org/).
+ * Respects config default: `quire settings set logUseColor false`
+ *
+ * @type {Array[]}
+ */
+export const colorOption = [
+  '--color', 'force colored output (overrides NO_COLOR env var)',
+]
+
+export const noColorOption = [
+  '--no-color', 'disable colored output',
+]
+
 /**
  * Standard output mode options (quiet, verbose, debug, progress)
  *

package/src/lib/commander/options.test.js

@@ -1,7 +1,7 @@
 import test from 'ava'
 import { Command } from 'commander'
 import { arrayToOption } from './index.js'
-import { quietOption, verboseOption, debugOption } from './options.js'
+import { colorOption, noColorOption, quietOption, verboseOption, debugOption } from './options.js'
 
 // ─────────────────────────────────────────────────────────────────────────────
 // Integration tests for option conflicts
@@ -16,6 +16,8 @@ import { quietOption, verboseOption, debugOption } from './options.js'
 function createTestProgram() {
   const program = new Command()
   program
+    .addOption(arrayToOption(colorOption))
+    .addOption(arrayToOption(noColorOption))
     .addOption(arrayToOption(quietOption))
     .addOption(arrayToOption(verboseOption))
     .addOption(arrayToOption(debugOption))
@@ -107,3 +109,46 @@ test('options order does not affect conflict detection', (t) => {
   t.throws(() => program1.parse(['node', 'test', '--quiet', '--verbose']))
   t.throws(() => program2.parse(['node', 'test', '--verbose', '--quiet']))
 })
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Color option tests
+// ─────────────────────────────────────────────────────────────────────────────
+
+test('--no-color sets color to false', (t) => {
+  const program = createTestProgram()
+  program.parse(['node', 'test', '--no-color'])
+  t.is(program.opts().color, false)
+})
+
+test('--color sets color to true', (t) => {
+  const program = createTestProgram()
+  program.parse(['node', 'test', '--color'])
+  t.is(program.opts().color, true)
+})
+
+test('no color flag leaves color undefined', (t) => {
+  const program = createTestProgram()
+  program.parse(['node', 'test'])
+  t.is(program.opts().color, undefined)
+})
+
+test('--no-color can be combined with --verbose', (t) => {
+  const program = createTestProgram()
+  t.notThrows(() => {
+    program.parse(['node', 'test', '--no-color', '--verbose'])
+  })
+})
+
+test('--no-color can be combined with --quiet', (t) => {
+  const program = createTestProgram()
+  t.notThrows(() => {
+    program.parse(['node', 'test', '--no-color', '--quiet'])
+  })
+})
+
+test('--no-color can be combined with --debug', (t) => {
+  const program = createTestProgram()
+  t.notThrows(() => {
+    program.parse(['node', 'test', '--no-color', '--debug'])
+  })
+})

package/src/lib/logger/index.js

@@ -162,7 +162,7 @@ export default function createLogger(name = 'quire', level) {
       const prefix = config.get('logPrefix')
       const prefixStyle = config.get('logPrefixStyle')
       const showLevel = config.get('logShowLevel')
-      const useColor = config.get('logUseColor')
+      const useColor = config.get('logUseColor') && !process.env.NO_COLOR
       const colorMessages = config.get('logColorMessages')
 
       const parts = []

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

@@ -475,3 +475,104 @@ test.serial('invalid env var value falls back to info', async (t) => {
     }
   }
 })
+
+// ─────────────────────────────────────────────────────────────────────────────
+// NO_COLOR environment variable tests
+// ─────────────────────────────────────────────────────────────────────────────
+
+test.serial('logger disables color when NO_COLOR env var is set', async (t) => {
+  const { sandbox } = t.context
+  const consoleErrorStub = sandbox.stub(console, 'error')
+  const originalNoColor = process.env.NO_COLOR
+
+  try {
+    process.env.NO_COLOR = '1'
+
+    const mockConfig = {
+      get: sandbox.stub().callsFake((key) => ({
+        logPrefix: 'quire',
+        logPrefixStyle: 'bracket',
+        logShowLevel: true,
+        logUseColor: true, // Config says use color, but NO_COLOR overrides
+        logColorMessages: true,
+      })[key])
+    }
+
+    const { default: createLoggerMocked } = await esmock('./index.js', {
+      '#lib/conf/config.js': { default: mockConfig }
+    })
+
+    const log = createLoggerMocked('test:nocolor', 'error')
+    log.error('Error message')
+
+    t.true(consoleErrorStub.calledOnce)
+    const output = consoleErrorStub.firstCall.args.join(' ')
+    // Should not contain ANSI escape sequences when NO_COLOR is set
+    t.false(/\u001b\[/.test(output), 'output should not contain ANSI escape codes')
+    // Should still contain the actual text
+    t.true(output.includes('[quire]'))
+    t.true(output.includes('ERROR'))
+    t.true(output.includes('Error message'))
+  } finally {
+    if (originalNoColor === undefined) {
+      delete process.env.NO_COLOR
+    } else {
+      process.env.NO_COLOR = originalNoColor
+    }
+  }
+})
+
+test.serial('logger uses color when NO_COLOR env var is not set and config enables color', async (t) => {
+  const { sandbox } = t.context
+  const consoleErrorStub = sandbox.stub(console, 'error')
+  const originalNoColor = process.env.NO_COLOR
+
+  try {
+    delete process.env.NO_COLOR
+
+    const mockConfig = {
+      get: sandbox.stub().callsFake((key) => ({
+        logPrefix: 'quire',
+        logPrefixStyle: 'bracket',
+        logShowLevel: true,
+        logUseColor: true,
+        logColorMessages: true,
+      })[key])
+    }
+
+    // Create a mock chalk that always applies ANSI styling regardless of TTY/env
+    const ansiRed = (s) => `\u001b[91m${s}\u001b[39m`
+    const ansiRedInverse = (s) => `\u001b[91m\u001b[7m${s}\u001b[27m\u001b[39m`
+    const ansiBold = (s) => `\u001b[1m${s}\u001b[22m`
+    const mockChalk = {
+      bold: ansiBold,
+      gray: (s) => s,
+      yellow: (s) => s,
+      magenta: (s) => s,
+      red: ansiRed,
+      redBright: { inverse: ansiRedInverse },
+      'yellow.inverse': (s) => s,
+    }
+    // Support chained properties
+    mockChalk.yellow.inverse = (s) => s
+
+    const { default: createLoggerMocked } = await esmock('./index.js', {
+      '#lib/conf/config.js': { default: mockConfig },
+      'chalk': { default: mockChalk }
+    })
+
+    const log = createLoggerMocked('test:withcolor', 'error')
+    log.error('Error message')
+
+    t.true(consoleErrorStub.calledOnce)
+    const output = consoleErrorStub.firstCall.args.join(' ')
+    // Should contain ANSI escape sequences when color is enabled and NO_COLOR not set
+    t.true(/\u001b\[/.test(output), 'output should contain ANSI escape codes')
+  } finally {
+    if (originalNoColor === undefined) {
+      delete process.env.NO_COLOR
+    } else {
+      process.env.NO_COLOR = originalNoColor
+    }
+  }
+})

package/src/main.js

@@ -2,6 +2,8 @@ import { Command, Argument, Option } from 'commander'
 import {
   arrayToArgument,
   arrayToOption,
+  colorOption,
+  noColorOption,
   quietOption,
   verboseOption,
   debugOption
@@ -34,12 +36,20 @@ Output Modes:
 
   Set defaults: quire settings set verbose true
 
+Color Output:
+  --no-color       Disable colored output
+  --color          Force colored output (overrides NO_COLOR env var)
+
+  Respects NO_COLOR environment variable (https://no-color.org/)
+  Set default: quire settings set logUseColor false
+
 Paging:
   --no-pager             Disable paging for long output
   NO_PAGER=1             Disable paging via environment variable
   PAGER=cat              Traditional Unix alternative (passes output through)
 
 Environment Variables:
+  NO_COLOR               Disable colored output (https://no-color.org/)
   NO_PAGER=1             Disable paging for long output
   PAGER=<program>        Set pager program (default: less). Use PAGER=cat to disable
   DEBUG=quire:*          Enable debug output for all modules
@@ -50,6 +60,8 @@ Examples:
   $ quire build                  Build the publication
   $ quire build --verbose        Build with detailed progress
   $ quire build --debug          Build with debug output
+  $ quire build --no-color       Build without colored output
+  $ NO_COLOR=1 quire build       Build without colored output
   $ DEBUG=quire:* quire pdf      Generate PDF with debug output
 `
 
@@ -66,6 +78,8 @@ program
   .name('quire')
   .description('Quire command-line interface')
   .version(version, '-V, --version', 'output quire version number')
+  .addOption(arrayToOption(colorOption))
+  .addOption(arrayToOption(noColorOption))
   .addOption(arrayToOption(quietOption))
   .addOption(arrayToOption(verboseOption))
   .addOption(arrayToOption(debugOption))
@@ -88,6 +102,8 @@ program
  * - --quiet: Suppress progress spinners (for CI/scripts)
  * - --verbose: Show detailed progress (paths, timing, steps)
  * - --debug: Enable DEBUG namespace + tool debug modes (for developers)
+ * - --no-color: Disable colored output (sets NO_COLOR env var)
+ * - --color: Force colored output (overrides NO_COLOR env var)
  *
  * These global options are passed through to commands via opts()
  * and should be merged with command-level options.
@@ -95,6 +111,16 @@ program
 program.hook('preAction', (thisCommand) => {
   const opts = thisCommand.opts()
 
+  // Handle --no-color / --color flag
+  // Sets NO_COLOR env var for chalk, ora, and logger to read
+  if (opts.color === false) {
+    process.env.NO_COLOR = '1'
+    delete process.env.FORCE_COLOR
+  } else if (opts.color === true) {
+    delete process.env.NO_COLOR
+    process.env.FORCE_COLOR = '1'
+  }
+
   // --debug or config.debug enables the quire:* DEBUG namespace for internal logging
   // CLI flag takes precedence, then config setting
   if (opts.debug ?? config.get('debug')) {