@thegetty/quire-cli 1.0.0-rc.15 → 1.0.0-rc.17

package/CHANGELOG.md

@@ -5,19 +5,23 @@ 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.16]
+
+### Changed
+
+- Patch for `install-npm-version@8.0.0`; see https://nodejs.org/en/blog/vulnerability/april-2024-security-releases-2
+
+### Fixed
+
+- Dependency instal error on Windows when running quire new DEV-19124
+
 ## [1.0.0-rc.12]
 
 ### Added

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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-rc.15",
+  "version": "1.0.0-rc.17",
   "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",
@@ -36,6 +37,7 @@
   "scripts": {
     "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": {
@@ -58,11 +60,12 @@
     "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",
+    "patch-package": "^8.0.0",
     "pagedjs-cli": "^0.4.3",
     "semver": "^7.3.8",
     "simple-git": "^3.16.0",

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