@thegetty/quire-cli 1.0.0-rc.28 → 1.0.0-rc.31

package/CHANGELOG.md

@@ -12,6 +12,22 @@ Changelog entries are classified using the following labels:
 - `Fixed`: for any bug fixes
 - `Removed`: for deprecated features removed in this release
 
+## [1.0.0-rc.31]
+
+### Changed
+
+- Improved accessibility of PDFs generated with prince with `--pdf-profile=PDF/UA-1` flag
+
+### Removed
+
+- Removed `install-npm-version` in favor of `npm pack` and `tar xfz` run as subprocesses
+- Removed `patch-package`
+
+## [1.0.0-rc.30]
+## [1.0.0-rc.29]
+
+Candidate versions skipped to align with @thegetty/quire-11ty
+
 ## [1.0.0-rc.28]
 
 ### Fixed

package/README.md

@@ -1,4 +1,5 @@
 ## Quire CLI
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/thegetty/quire/tree/main.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/thegetty/quire/tree/main)
 
 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.
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-rc.28",
+  "version": "1.0.0-rc.31",
   "author": "Getty Digital",
   "license": "SEE LICENSE IN https://github.com/thegetty/quire/blob/main/LICENSE",
   "bugs": {
@@ -38,8 +38,7 @@
     "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"
+    "test": "echo \"No test specified\" && exit 0"
   },
   "imports": {
     "#root/*": "./*",
@@ -61,14 +60,12 @@
     "hosted-git-info": "^6.1.1",
     "i18next": "^22.4.9",
     "inquirer": "^9.1.4",
-    "install-npm-version": "^1.0.9",
     "js-yaml": "^4.1.0",
     "loglevel": "^1.8.1",
     "node-fetch": "^3.3.2",
     "open": "^8.4.0",
     "ora": "^6.1.2",
     "pagedjs-cli": "^0.4.3",
-    "patch-package": "^8.0.0",
     "read-package-up": "^11.0.0",
     "semver": "^7.3.8",
     "simple-git": "^3.16.0",

package/src/commands/create.js

@@ -72,13 +72,7 @@ export default class CreateCommand extends Command {
         return
       }
 
-      options.eject = true
-
-      if (options.eject) {
-        await quire.installInProject(projectPath, quireVersion, options)
-      } else {
-        await quire.install(options)
-      }
+      await quire.installInProject(projectPath, quireVersion, options)
     }
   }
 }

package/src/lib/pdf/prince.js

@@ -32,6 +32,7 @@ export default async (publicationInput, coversInput, output, options = {}) => {
   // These options are for the actual user-facing PDF
   const cmdOptions = [
     `--output=${output}`,
+    `--pdf-profile=PDF/UA-1`,
   ]
 
   if (options.debug) {

package/src/lib/quire/index.js

@@ -7,7 +7,6 @@ import config from '#lib/conf/config.js'
 import fetch from 'node-fetch'
 import fs from 'fs-extra'
 import git from '#lib/git/index.js'
-import inv from 'install-npm-version'
 import packageConfig from '#src/packageConfig.js'
 import path from 'node:path'
 import semver from 'semver'
@@ -147,51 +146,6 @@ async function initStarter (starter, projectPath, options) {
   return quireVersion
 }
 
-/**
- * Install quire-11ty (default to 'latest' version)
- *
- * @TODO refactor this to be callable by the installInProject method
- *
- * @param  {Object}  options  options passed from `quire new` command
- * @return  {Promise}
- */
-async function install(options = {}) {
-  const version = options.quireVersion || QUIRE_VERSION
-  console.debug(`[CLI:quire] installing quire-11ty@${version}`)
-  const absoluteInstallPath = path.join(__dirname, 'versions')
-  fs.ensureDirSync(absoluteInstallPath)
-  /**
-   * `Destination` is relative to `node_modules` of the working-directory
-   * so we have included a relative path to parent directory in order to
-   * install versions to a different local path.
-   * @see https://github.com/scott-lin/install-npm-version
-   */
-  const installOptions = {
-    Destination: path.join('..', version),
-    Debug: false,
-    Overwrite: options.force || options.overwrite || false,
-    Verbosity: options.debug ? 'Debug' : 'Silent',
-    WorkingDirectory: absoluteInstallPath
-  }
-  await inv.Install(`${PACKAGE_NAME}@${version}`, installOptions)
-
-  // delete empty `node_modules` directory that `install-npm-version` creates
-  const invNodeModulesDir = path.join(absoluteInstallPath, 'node_modules')
-  if (fs.existsSync(invNodeModulesDir)) fs.rmdir(invNodeModulesDir)
-
-  symlinkLatest()
-
-  console.debug('[CLI:quire] installing dev dependencies')
-  /**
-   * Manually install necessary dev dependencies to run 11ty;
-   * these must be `devDependencies` so that they are not bundled into
-   * the final `_site` package when running `quire build`
-   */
-  chdir(path.join(absoluteInstallPath, version))
-  await execaCommand('npm cache clean --force')
-  await execaCommand('npm install --save-dev')
-}
-
 /**
  * Install `quire-11ty` directly into a quire project
  *
@@ -204,7 +158,8 @@ async function install(options = {}) {
  */
 async function installInProject(projectPath, quireVersion, options = {}) {
   const { quirePath } = options
-  const quire11tyPackage = fs.existsSync(quirePath) ? quirePath : `${PACKAGE_NAME}@${quireVersion}`
+  const quire11tyPackage = `${PACKAGE_NAME}@${quireVersion}`
+
   console.debug(`[CLI:quire] installing ${quire11tyPackage} into ${projectPath}`)
 
   /**
@@ -219,27 +174,21 @@ async function installInProject(projectPath, quireVersion, options = {}) {
     .catch((error) => console.error('[CLI:error] ', error))
 
   const temp11tyDirectory = '.temp'
-  /**
-   * `Destination` is relative to `node_modules` of the working-directory
-   * so we have included a relative path to parent directory in order to
-   * install versions to a different local path.
-   * @see https://github.com/scott-lin/install-npm-version
-   */
-  const installOptions = {
-    Destination: path.join('..', temp11tyDirectory),
-    Debug: false,
-    Overwrite: options.force || options.overwrite || false,
-    Verbosity: options.debug ? 'Debug' : 'Silent',
-    WorkingDirectory: projectPath
-  }
-  await inv.Install(quire11tyPackage, installOptions)
+  const tempDir = path.join(projectPath,temp11tyDirectory)
+  fs.mkdirSync(tempDir)
+
+  // Copy if passed a path and it exists, otherwise attempt to download the tarball for this pathspec
+  if (fs.existsSync(quirePath)) {
+    fs.copySync(quirePath, tempDir)
+  } else {
+    await execaCommand(`npm pack ${ options.debug ? '--debug' : '--quiet' } ${quire11tyPackage}`)
 
-  // delete empty `node_modules` directory that `install-npm-version` creates
-  const invNodeModulesDir = path.join(projectPath, 'node_modules')
-  if (fs.existsSync(invNodeModulesDir)) fs.rmdir(invNodeModulesDir)
+    // Extract only the package dir from the tar bar and strip it from the extracted path
+    await execaCommand(`tar -xzf thegetty-quire-11ty-${quireVersion}.tgz -C ${tempDir} --strip-components=1 package/`)
+  }
 
-  // Copy all files installed in `.temp` to projectPath
-  fs.copySync(path.join(projectPath, '.temp'), projectPath)
+  // Copy `.temp` to projectPath
+  fs.copySync(tempDir, projectPath)
 
   console.debug('[CLI:quire] installing dev dependencies into quire project')
   /**
@@ -257,7 +206,7 @@ async function installInProject(projectPath, quireVersion, options = {}) {
   }
 
   const eleventyFilesToCommit = fs
-    .readdirSync(path.join(projectPath, temp11tyDirectory))
+    .readdirSync(tempDir)
     .filter((filePath) => filePath !== 'node_modules')
 
   eleventyFilesToCommit.push('package-lock.json')
@@ -379,19 +328,6 @@ function symlinkLatest() {
   return fs.symlinkSync(target, source, type)
 }
 
-/**
- * Tests if a `quire-11ty` version is already installed
- * and installs the version if it is not already installed.
- *
- * @param  {String}  version  `quire-11ty` semantic version
- */
-function testVersion(version) {
-  version ||= getVersion()
-  if (!versions.includes(version)) {
-    install(version)
-  }
-}
-
 /**
  * Get an array of published `quire-11ty` package versions
  *
@@ -405,12 +341,10 @@ export const quire = {
   getPath,
   getVersion,
   initStarter,
-  install,
   installInProject,
   latest,
   list,
   remove,
   setVersion,
-  testVersion,
   versions,
 }