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

package/CHANGELOG.md

@@ -12,6 +12,42 @@ 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,3 +24,12 @@ 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,11 +1,29 @@
 #!/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'
+
+/**
+ * Dynamic import ensures env var is 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.35",
+  "version": "1.0.0-rc.36",
   "author": "Getty Digital",
   "license": "SEE LICENSE IN https://github.com/thegetty/quire/blob/main/LICENSE",
   "bugs": {
@@ -39,26 +39,34 @@
     "docs": "jsdoc2md --configure jsdoc.json --files src/**/*.js > docs/cli.md",
     "lint": "eslint src --ext .js",
     "lint:fix": "npm run lint -- --fix",
-    "test": "echo \"No test specified\" && exit 0"
+    "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"
   },
   "imports": {
     "#root/*": "./*",
     "#src/*.js": "./src/*.js",
     "#helpers/*.js": "./src/helpers/*.js",
-    "#lib/*.js": "./src/lib/*.js"
+    "#lib/*.js": "./src/lib/*.js",
+    "#debug": "./src/lib/logger/debug.js"
   },
   "dependencies": {
     "ajv": "^8.16.0",
     "boxen": "^7.0.1",
     "chalk": "^5.2.0",
-    "commander": "^12.1.0",
-    "conf": "^13.1.0",
+    "commander": "^14.0.2",
+    "conf": "^15.0.2",
     "cross-env": "^7.0.3",
+    "debug": "^4.4.0",
     "del": "^7.0.0",
     "epubjs-cli": "^0.1.6",
     "execa": "^6.1.0",
     "fs-extra": "^11.1.0",
     "hosted-git-info": "^6.1.1",
+    "i18next": "^22.4.9",
     "inquirer": "^9.1.4",
     "js-yaml": "^4.1.0",
     "loglevel": "^1.8.1",
@@ -66,14 +74,19 @@
     "open": "^8.4.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",
-    "simple-git": "^3.16.0",
-    "update-notifier": "^7.3.1"
+    "update-notifier": "^7.3.1",
+    "which": "^2.0.2"
   },
   "devDependencies": {
+    "ava": "^6.2.0",
     "eslint": "^8.32.0",
-    "jsdoc-to-markdown": "^9.1.1"
+    "esmock": "^2.7.3",
+    "jsdoc-to-markdown": "^9.1.1",
+    "memfs": "^4.51.1",
+    "sinon": "^17.0.1"
   },
   "engines": {
     "node": ">=22"

package/patches/README.md

@@ -0,0 +1,19 @@
+## Quire CLI Patches
+
+Patches in this directory are applied to locally installed `node_modules` by the npm `postinstall` script ([npm scripts docs](https://docs.npmjs.com/cli/v10/using-npm/scripts)).
+
+See [`patch-package`](https://github.com/ds300/patch-package) documenation for [making](https://github.com/ds300/patch-package#making-patches), [updating](https://github.com/ds300/patch-package#updating-patches), [applying](https://github.com/ds300/patch-package#applying-patches) and [reversing](https://github.com/ds300/patch-package#applying-patches) patches.
+
+*Nota bene*
+
+Patching the `quire-cli` package dependencies changes the way in which it must be must be installed. When installing the `quire-cli` as a _local package dependency_ the `--install-strategy=nested` flag must be used as follows
+
+```sh
+npm install quire-cli --install-strategy=nested
+```
+
+Installing the `quire-cli` as a global npm module has not changed,
+
+```sh
+npm install quire-cli --global
+```