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

package/CHANGELOG.md

@@ -12,42 +12,6 @@ Changelog entries are classified using the following labels:
 - `Fixed`: for any bug fixes
 - `Removed`: for deprecated features removed in this release
 
-## [Unreleased]
-
-### Added
-
-- New `quire validate` command to check YAML syntax in `content/_data/` directory
-- New `quire use <version>` command (renamed from `quire version`) to change quire-11ty version
-- Config settings for default PDF and EPUB engines via `quire settings set pdfEngine <engine>` and `quire settings set epubEngine <engine>`
-- Config settings for default log level via `quire settings set logLevel <level>`
-- Debug logger module with namespace support (`DEBUG=quire:*`)
-- Process manager for graceful shutdown handling (Ctrl+C) during long-running operations
-- `--build` flag for `quire pdf` and `quire epub` commands to run build first if output is missing
-- `--engine` option for `quire pdf` and `quire epub` commands (deprecates `--lib`)
-- Helper functions for build output detection (`hasSiteOutput`, `hasEpubOutput`, `hasPdfOutput`)
-- Comprehensive error handling system with domain-specific error classes
-- Documentation for CLI architecture, error handling, and testing
-
-### Changed
-
-- Renamed `quire conf` command to `quire config` (aliased as `quire settings`)
-- Renamed `quire version` command to `quire use`
-- Refactored error handling to use thrown errors instead of `process.exit()` for better testability
-- Commands now inherit `debug()` and `logger` methods from base Command class
-- Improved log output with configurable log levels (trace, debug, info, warn, error, silent)
-- Replaced `simple-git` dependency with a lightweight git façade module
-- Replaced `execaCommand` with `execa` for improved command execution
-- Encapsulated project concerns into dedicated `lib/project` module
-- Encapsulated 11ty interactions into a façade module with process lifecycle management
-
-### Fixed
-
-- `quire new` command arguments and options validation
-- Command lifecycle hook errors are now correctly handled and reported
-- Disabled auto-deletion of project directory on `quire new` failures to prevent accidental data loss
-- Package schema files validation
-- Process manager import paths for logger module
-
 ## [1.0.0-rc.33]
 
 ### Bumped

package/README.md

@@ -24,12 +24,3 @@ npm install quire-cli --install-strategy=nested
 ```sh
 npx quire-cli --help
 ```
-
-### Testing
-
-The CLI uses two types of test files for commands:
-
-- **`*.spec.js`** - Contract/interface tests that verify the command definition is correctly transformed into Commander.js Command object instance and the public API is correct
-- **`*.test.js`** - Integration/behavior tests that verify command execution with real dependencies
-
-See [docs/testing-commands.md](docs/testing-commands.md) for the complete testing guide and patterns.

package/bin/cli.js

@@ -1,56 +1,11 @@
 #!/usr/bin/env -S node --no-warnings
+import cli from '#src/main.js'
 import config from '#src/lib/conf/config.js'
 import packageConfig from '#src/packageConfig.js'
 import updateNotifier from 'update-notifier'
 
-// Import process manager to register signal handlers for graceful shutdown
-import '#lib/process/manager.js'
-
 process.removeAllListeners('warning')
 
-/**
- * Set log level from config before importing CLI modules
- *
- * This env var is read by the logger at module creation time.
- * Setting it here ensures all loggers (including module-level ones)
- * use the configured level.
- *
- * @see lib/logger/index.js
- */
-process.env.QUIRE_LOG_LEVEL = config.get('logLevel') || 'info'
-
-/**
- * Set REDUCED_MOTION env var from config before importing CLI modules
- *
- * The reporter reads REDUCED_MOTION to decide whether to use animated
- * spinners or static text output. Setting it here ensures the reporter
- * picks up the config value at module load time.
- * If REDUCED_MOTION is already set in the shell environment, we do not override it.
- *
- * @see lib/reporter/index.js
- */
-if (process.env.REDUCED_MOTION === undefined && config.get('reducedMotion') === true) {
-  process.env.REDUCED_MOTION = '1'
-}
-
-/**
- * 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')
-
 /**
  * Interval constants in milliseconds
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-rc.45",
+  "version": "1.0.0-rc.46",
   "author": "Getty Digital",
   "license": "SEE LICENSE IN https://github.com/thegetty/quire/blob/main/LICENSE",
   "bugs": {
@@ -16,13 +16,10 @@
     "quire": "./bin/cli.js"
   },
   "exports": "./bin/cli.js",
-  "man": "./man/quire.1",
   "type": "module",
   "files": [
     "bin/",
-    "man/",
     "patches/",
-    "schemas/",
     "scripts/",
     "src/",
     "CHANGELOG.md",
@@ -38,30 +35,24 @@
     "directory": "packages/cli"
   },
   "scripts": {
+    "docs": "jsdoc2md --configure jsdoc.json --files src/**/*.js > docs/cli.md",
     "lint": "eslint src --ext .js",
     "lint:fix": "npm run lint -- --fix",
-    "test": "ava",
-    "test:watch": "ava --watch",
-    "test:unit": "ava src/commands/**/*.spec.js src/lib/**/*.spec.js",
-    "test:integration": "ava src/commands/**/*.test.js src/helpers/**/*.test.js src/lib/**/*.test.js",
-    "test:e2e": "ava test/e2e/**/*.e2e.js",
-    "test:coverage": "c8 ava"
+    "test": "ava ./_tests/**"
   },
   "imports": {
     "#root/*": "./*",
     "#src/*.js": "./src/*.js",
     "#helpers/*.js": "./src/helpers/*.js",
-    "#lib/*.js": "./src/lib/*.js",
-    "#debug": "./src/lib/logger/debug.js"
+    "#lib/*.js": "./src/lib/*.js"
   },
   "dependencies": {
     "ajv": "^8.16.0",
     "boxen": "^7.0.1",
     "chalk": "^5.2.0",
-    "commander": "^14.0.2",
-    "conf": "^15.0.2",
+    "commander": "^12.1.0",
+    "conf": "^13.1.0",
     "cross-env": "^7.0.3",
-    "debug": "^4.4.0",
     "del": "^7.0.0",
     "epubjs-cli": "^0.1.6",
     "execa": "^6.1.0",
@@ -71,26 +62,18 @@
     "inquirer": "^9.1.4",
     "js-yaml": "^4.1.0",
     "loglevel": "^1.8.1",
-    "marked": "^15.0.12",
-    "marked-terminal": "^7.3.0",
     "node-fetch": "^3.3.2",
     "open": "^8.4.0",
-    "ora": "^9.1.0",
+    "ora": "^6.1.2",
     "pagedjs-cli": "^0.4.3",
-    "pdf-lib": "^1.17.1",
     "read-package-up": "^11.0.0",
     "semver": "^7.3.8",
-    "update-notifier": "^7.3.1",
-    "which": "^2.0.2",
-    "wrap-ansi": "^8.1.0"
+    "simple-git": "^3.16.0",
+    "update-notifier": "^7.3.1"
   },
   "devDependencies": {
-    "ava": "^6.2.0",
     "eslint": "^8.32.0",
-    "esmock": "^2.7.3",
-
-    "memfs": "^4.51.1",
-    "sinon": "^17.0.1"
+    "jsdoc-to-markdown": "^9.1.1"
   },
   "engines": {
     "node": ">=22"

package/src/Command.js

@@ -1,6 +1,4 @@
 import config from '#src/lib/conf/config.js'
-import createLogger from '#lib/logger/index.js'
-import createDebug from '#debug'
 
 /**
  * Command
@@ -15,13 +13,10 @@ export default class Command {
 
   /**
    * @typedef CommandDefinition
-   * @property {String} name - Command name used to invoke it
-   * @property {String} alias - Single alias for the command
-   * @property {Array<String>} aliases - Multiple aliases for the command
-   * @property {String} description - Full description shown in command's own help
-   * @property {String} summary - One-line summary shown in parent help listing
-   * @property {String} [docsLink] - Path appended to docs base URL (e.g., 'quire-commands/#output-files')
-   * @property {String} [helpText] - Custom help text shown after built-in help (examples, notes)
+   * @property {String} name
+   * @property {String} alias
+   * @property {Array<String>} aliases
+   * @property {String} descriptions
    * @property {Array<CommandArgument>} args
    * @property {Array<CommandOption>} options
    * @property {String} version
@@ -37,24 +32,12 @@ export default class Command {
    * @param {CommandDefinition}  definition  The definition
    */
   constructor(definition) {
-    if (this.constructor === Command) {
+    if (this.constructor.prototype === Command) {
       throw new Error('Command is an *abstract* class')
     }
 
     this.config = config // quire-cli configuration
 
-    /**
-     * Command-specific debug instance for internal debugging
-     * Enable via: DEBUG=quire:commands:name or DEBUG=quire:commands:*
-     */
-    this.debug = createDebug(`commands:${definition.name}`)
-
-    /**
-     * Command-specific logger with prefix including command name
-     * Output format: [quire] LEVEL commands:name message
-     */
-    this.logger = createLogger(`commands:${definition.name}`)
-
     /**
      * Merge and deduplicate command definition alias and aliases
      * Nota bene: Only the first command alias is displayed in the help.
@@ -65,9 +48,6 @@ export default class Command {
     this.name = definition.name
     this.aliases = definition.aliases
     this.description = definition.description
-    this.summary = definition.summary
-    this.docsLink = definition.docsLink
-    this.helpText = definition.helpText
     this.args = definition.args
     this.options = definition.options
     this.version = definition.version
@@ -75,7 +55,7 @@ export default class Command {
   }
 
   definition() {
-    return this.constructor.definition
+    return this.prototype.definition
   }
 
   action() {