@thegetty/quire-cli 1.0.0-rc.2 → 1.0.0-rc.21

package/CHANGELOG.md

@@ -5,19 +5,105 @@ All notable changes to the `quire-cli` will be documented in this file.
 The log format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 Changelog entries are classified using the following labels:
-
 - `Added`: for new features
-
 - `Bumped`: updated dependencies, only minor or higher will be listed
-
 - `Changed`: for changes in existing functionality
-
 - `Deprecated`: for once-stable features removed in upcoming releases
-
 - `Fixed`: for any bug fixes
-
 - `Removed`: for deprecated features removed in this release
 
+## [1.0.0-rc.21]
+
+### Fixed
+
+- Fixed missing import of `node:path`
+
+## [1.0.0-rc.20]
+
+### Changed
+
+- Replace Node `import` assertions (deprecated) with file operations
+
+### Fixed
+
+- Quire new command fails with newer version of Node #968
+
+## [1.0.0-rc.19]
+
+### Added
+
+- `jsdoc-to-markdown` to development dependencies
+- JSDoc configuration (see https://jsdoc.app/about-configuring-jsdoc)
+- Npm script `docs` to run jsdoc-to-markdown
+
+## [1.0.0-rc.18]
+
+### Added
+
+- Quire CLI configuration management using the `conf` package
+- `quire conf` command to manage cli configuration properties
+
+## [1.0.0-rc.17]
+
+### Bumped
+
+- `install-npm-version` patch version
+
+### Changed
+
+- update patch `install-npm-version`
+
+## [1.0.0-rc.16]
+
+### Added
+
+- Patch for `install-npm-version`; see https://nodejs.org/en/blog/vulnerability/april-2024-security-releases-2
+
+### Changed
+
+**Nota bene** installing `quire-cli` as a _local package_ requires running `npm install` with the `--install-strategy=nested` flag; installing `quire-cli` as a global node module has not changed.
+
+### Fixed
+
+- Dependency instal error on Windows when running quire new DEV-19124
+
+## [1.0.0-rc.12]
+
+### Added
+- Handling for single-page PDFs
+- Paged and Prince plugins to map quire pages to PDF page sections 
+
+### Changed
+
+- `quire clean` also removes `.11ty-vite` in the project root
+
+## [1.0.0-rc.11]
+
+### Bumped
+- `epubjs-cli` to version 0.1.6
+- `pagedjs-cli` to version 0.4.3
+
+### Fixed
+- EPUB validation error where pages that include SVGs must include SVG as property under `readingOrder`
+
+## [1.0.0-rc.10]
+
+### Added
+- Support semantic version ranges for `quire-11ty` in quire starter projects and the `--quire-version` option of the `quire new` command, and use the latest compatible `quire-11ty` version when creating and installing a new project.
+
+## [1.0.0-rc.9]
+
+### Added
+- Update old `.quire` files  when running `info` command on versions prior to `1.0.0-rc.8`
+- Include `quire-cli` version used to generate project in `info` output
+- Adds headings to `info` output
+
+## [1.0.0-rc.8]
+
+### Added
+- Added `info` command to output package versions
 
-## [Unreleased]
+## [1.0.0-rc.7]
 
+### Added
+- Added `new` command `--quire-path` option to support development with local version of `quire-11ty`

package/README.md

@@ -2,6 +2,20 @@
 
 The `quire-cli` implements the [command pattern](https://en.wikipedia.org/wiki/Command_pattern) to receive input from a user and delegate command behavoir to modules for the services, such as `git` and `11ty`, involved in working on Quire publications.
 
+### Installing the CLI
+
+The `quire-cli` can be installed as a global npm module as follows
+
+```sh
+npm install quire-cli --global
+```
+
+Installing the `quire-cli` as a _local package dependency_ requires additional npm command flags to support patching package dependencies as follows,
+
+```sh
+npm install quire-cli --install-strategy=nested
+```
+
 ### Using the CLI
 
 `npx` supports executing npm package binaries even when they are not yet installed and will download the package into a cache if it does not find either a locally or globally installed version. Simply run

package/bin/cli.js

@@ -1,31 +1,44 @@
 #!/usr/bin/env -S node --no-warnings
-
+import { dirname, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import fs from 'node:fs'
 import cli from '#src/main.js'
-import packageConfig from '#root/package.json' assert { type: 'json' }
+import config from '#src/lib/conf/config.js'
 import updateNotifier from 'update-notifier'
 
+const __dirname = dirname(fileURLToPath(import.meta.url))
+
+const packagePath = join(__dirname, 'package.json')
+const packageConfig = JSON.parse(fs.readFileSync(packagePath, 'utf8'))
+
 process.removeAllListeners('warning')
 
+/**
+ * Interval constants in milliseconds
+ */
 const INTERVAL = Object.freeze({
-  MINUTES: 1000 * 60 * 1,
+  MINUTE: 1000 * 60 * 1,
   HOURLY: 1000 * 60 * 60,
   DAILY: 1000 * 60 * 60 * 24,
   WEEKLY: 1000 * 60 * 60 * 24 * 7
 })
 
+const updateChannel = config.get('updateChannel')
+const updateIterval = config.get('updateIterval')
+
 /**
- * Check for quire-cli updates
+ * Create a notifier to Check for quire-cli updates
  * @see https://github.com/yeoman/update-notifier#usage
  *
- * @todo user configuration of choosen update interval
+ * @todo refactor to check multiple channels
  */
 const notifier = updateNotifier({
-  distTag: 'rc',
+  distTag: updateChannel,
   pkg: packageConfig,
-  updateCheckInterval: INTERVAL.DAILY,
+  updateCheckInterval: INTERVAL[updateIterval],
 })
 
-notifier.notify()
+notifier.notify({ defer: false })
 
 /**
  * Run the cli program

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0-rc.21",
   "author": "Getty Digital",
   "license": "SEE LICENSE IN https://github.com/thegetty/quire/blob/main/LICENSE",
   "bugs": {
@@ -19,7 +19,8 @@
   "type": "module",
   "files": [
     "bin/",
-    "scripts",
+    "patches/",
+    "scripts/",
     "src/",
     "CHANGELOG.md",
     "LICENSE",
@@ -34,8 +35,10 @@
     "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",
+    "postinstall": "cross-env patch-package --error-on-fail",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "imports": {
@@ -45,29 +48,33 @@
     "#lib/*.js": "./src/lib/*.js"
   },
   "dependencies": {
+    "ajv": "^8.16.0",
     "boxen": "^7.0.1",
     "chalk": "^5.2.0",
-    "commander": "^10.0.0",
-    "conf": "^11.0.1",
+    "commander": "^12.1.0",
+    "conf": "^13.1.0",
     "cross-env": "^7.0.3",
     "del": "^7.0.0",
-    "epubjs-cli": "^0.1.1",
+    "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",
-    "install-npm-version": "^1.0.8",
+    "install-npm-version": "^1.0.9",
+    "js-yaml": "^4.1.0",
     "loglevel": "^1.8.1",
     "open": "^8.4.0",
     "ora": "^6.1.2",
-    "pagedjs-cli": "^0.3.3",
+    "pagedjs-cli": "^0.4.3",
+    "patch-package": "^8.0.0",
     "semver": "^7.3.8",
     "simple-git": "^3.16.0",
-    "update-notifier": "^6.0.2"
+    "update-notifier": "^7.3.1"
   },
   "devDependencies": {
-    "eslint": "^8.32.0"
+    "eslint": "^8.32.0",
+    "jsdoc-to-markdown": "^9.1.1"
   },
   "engines": {
     "node": ">=14.16"

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
+```