@thegetty/quire-cli 1.0.0-rc.0 → 1.0.0-rc.10

package/src/lib/pdf/paged.js

@@ -13,10 +13,30 @@ export default async (input, output, options = {}) => {
   const printerOptions = {
     allowLocal: true,
     debug: options.debug || false,
+    enableWarnings: options.debug || false,
+  }
+
+  if (options.debug) {
+    const optionsOutput = JSON.stringify(printerOptions, null, 2)
+    console.debug(`[CLI:lib/pdf/pagedjs] Printer options\n${optionsOutput}`)
   }
 
   const printer = new Printer(printerOptions)
 
+  printer.on('page', (page) => {
+    if (page.position === 0) {
+      console.info(`[CLI:lib/pdf/pagedjs] loaded`)
+    }
+  })
+
+  printer.on('rendered', (msg) => {
+    console.info(`[CLI:lib/pdf/pagedjs] ${msg}`)
+  })
+
+  printer.on('postprocessing', () => {
+    console.info(`[CLI:lib/pdf/pagedjs] post-processing`)
+  })
+
   /**
    * Configure the Paged.js PDF options
    * @see
@@ -28,13 +48,22 @@ export default async (input, output, options = {}) => {
     outlineTags: options.outlineTags || ['h1'],
   }
 
+  if (options.debug) {
+    const optionsOutput = JSON.stringify(pdfOptions, null, 2)
+    console.debug(`[CLI:lib/pdf/pagedjs] PDF options\n${optionsOutput}`)
+  }
+
   try {
     console.info(`[CLI:lib/pdf/pagedjs] printing ${input}`)
+
     const file = await printer.pdf(input, pdfOptions)
       .catch((error) => console.error(error))
 
+    printer.close()
+
     if (file && output) {
-      fs.writeFile(output, file, (error) => { if (error) throw error })
+      await fs.promises.writeFile(output, file)
+        .catch((error) => console.error(error))
     }
   } catch (ERR_FILE_NOT_FOUND) {
     console.error(`[CLI:lib/pdf/pagedjs] file not found ${input}`)

package/src/lib/pdf/prince.js

@@ -8,10 +8,16 @@ import which from '#helpers/which.js'
 export default async (input, output, options = {}) => {
   which('prince')
 
+  /**
+   * @see https://www.princexml.com/doc/command-line/#options
+   */
   const cmdOptions = [
     `--output=${output}`,
   ]
 
+  if (options.debug) cmdOptions.push('--debug')
+  if (options.verbose) cmdOptions.push('--verbose')
+
   const { stderror, stdout } = await execa('prince', [...cmdOptions, input])
   return { stderror, stdout }
 }

package/src/lib/quire/index.js

@@ -3,9 +3,11 @@ import { chdir, cwd } from 'node:process'
 import { execa, execaCommand } from 'execa'
 import { fileURLToPath } from 'node:url'
 import { isEmpty } from '#helpers/is-empty.js'
+import fetch from 'node-fetch'
 import fs from 'fs-extra'
 import git from '#src/lib/git/index.js'
 import inv from 'install-npm-version'
+import packageConfig from '#root/package.json' assert { type: 'json' }
 import path from 'node:path'
 import semver from 'semver'
 
@@ -48,25 +50,19 @@ function getVersion(projectPath) {
 }
 
 /**
- * Read the required `quire-11ty` version from starter `package.json` `peerDependencies`
+ * Read the required `quire-11ty` and starter versions from starter `package.json` `peerDependencies`
  *
  * @param    {String}   projectPath  Absolute system path to the project root
  *
- * @return  {String}  version  Quire-11ty semantic version with caret or other
- * comparators trimmed off the beginning
- *
- * @TODO refactor `latest()` function to programmatically return a specific
- * version of `@thegetty/quire-11ty` from a semantic version string
- * (i.e `^1.0.0-pre-release.0` => `1.0.0-pre-release.2`) so this string-trimming
- * logic can be removed
+ * @return  {Object}
+ * @property {String} quire11tyVersion  Latest compatible Quire-11ty semantic version
+ * @property {String} starterVersion  Starter project version defined in the starter package.json
  */
-async function getVersionFromStarter(projectPath) {
-  const packageConfig = fs.readFileSync(path.join(projectPath, 'package.json'), { encoding:'utf8' })
-  const { peerDependencies } = JSON.parse(packageConfig)
-  const version = peerDependencies[PACKAGE_NAME]
-  return version === 'latest'
-    ? await latest()
-    : version.substr(version.search(/\d/))
+async function getVersionsFromStarter(projectPath) {
+  const projectPackageConfig = fs.readFileSync(path.join(projectPath, 'package.json'), { encoding:'utf8' })
+  const { peerDependencies, version: starterVersion } = JSON.parse(projectPackageConfig)
+  const quire11tyVersion = peerDependencies[PACKAGE_NAME]
+  return { quire11tyVersion, starterVersion }
 }
 
 /**
@@ -79,7 +75,7 @@ async function getVersionFromStarter(projectPath) {
  * @return   {String}   quireVersion  A string indicating the current version
  *                                    of quire being used with a new project
  */
-async function initStarter (starter, projectPath) {
+async function initStarter (starter, projectPath, options) {
   projectPath = projectPath || cwd()
 
   // ensure that the target path exists
@@ -110,12 +106,24 @@ async function initStarter (starter, projectPath) {
     .catch((error) => console.error('[CLI:error] ', error))
 
   /**
-   * Determine `quire-11ty` version required by the starter project
-   * and write a `.quire` file with the semantic version string.
+   * Determine the `quire-11ty` version to use in the new project,
+   * from the `quireVersion` option or as required by the starter project.
+   *
+   * Uses `latest` to get the latest semantic version compatible with version ranges
    */
-  const quireVersion = await getVersionFromStarter(projectPath)
+  const { quire11tyVersion, starterVersion } = await getVersionsFromStarter(projectPath)
+  const quireVersion = await latest(options.quireVersion || quire11tyVersion)
   setVersion(projectPath, quireVersion)
 
+  /**
+   * Write quire-11ty, cli, starter name and version to VERSION_FILE
+   */
+  const versionInfo = { 
+    cli: packageConfig.version,
+    starter: `${starter}@${starterVersion}`,
+  }
+  fs.writeFileSync(path.join(projectPath, VERSION_FILE), JSON.stringify(versionInfo))
+
   // Re-initialize project directory as a new git repository
   await fs.remove(path.join(projectPath, '.git'))
 
@@ -135,18 +143,19 @@ async function initStarter (starter, projectPath) {
    */
   const projectFiles = fs.readdirSync(projectPath)
   await git.init().add(projectFiles).commit('Initial Commit')
-
   return quireVersion
 }
 
 /**
- * Install a specific version of `quire-11ty`
+ * Install `quire-11ty`, default to 'latest' version
+ *
+ * @TODO refactor this to be callable by the installInProject method
  *
- * @param  {String}  version  Quire-11ty semantic version
  * @param  {Object}  options  options passed from `quire new` command
  * @return  {Promise}
  */
-async function install(version, options={}) {
+async function install(options = {}) {
+  const version = options.quireVersion || 'latest'
   console.debug(`[CLI:quire] installing quire-11ty@${version}`)
   const absoluteInstallPath = path.join(__dirname, 'versions')
   fs.ensureDirSync(absoluteInstallPath)
@@ -185,19 +194,23 @@ async function install(version, options={}) {
 }
 
 /**
- * Install a specific version of `quire-11ty` directly into a quire project
+ * Install `quire-11ty` directly into a quire project
+ *
+ * @TODO refactor this to use the install method with pre and post-install hooks
+ * or steps to prepare the working directory and cleanup on error and completion
  *
  * @param  {String}  projectPath  Absolute system path to the project root
- * @param  {String}  version  Quire-11ty semantic version
  * @param  {Object}  options  options passed from `quire new` command
  * @return  {Promise}
  */
-async function installInProject(projectPath, version, options={}) {
-  console.debug(`[CLI:quire] installing quire-11ty@${version} into ${projectPath}`)
+async function installInProject(projectPath, quireVersion, options = {}) {
+  const { quirePath } = options
+  const quire11tyPackage = fs.existsSync(quirePath) ? quirePath : `${PACKAGE_NAME}@${quireVersion}`
+  console.debug(`[CLI:quire] installing ${quire11tyPackage} into ${projectPath}`)
 
   /**
-   * delete `package.json` from starter project, as it will be replaced with
-   * `package.json` from `@thegetty/quire-11ty`
+   * Delete the starter project package configuration so that it can be replaced
+   * with the `@thegetty/quire-11ty` configuration
    * @TODO If a user runs quire eject at a later date we may want to merge their
    * package.json with the `quire-11ty` dev dependencies, scripts, etc
    */
@@ -220,7 +233,7 @@ async function installInProject(projectPath, version, options={}) {
     Verbosity: options.debug ? 'Debug' : 'Silent',
     WorkingDirectory: projectPath
   }
-  await inv.Install(`${PACKAGE_NAME}@${version}`, installOptions)
+  await inv.Install(quire11tyPackage, installOptions)
 
   // delete empty `node_modules` directory that `install-npm-version` creates
   const invNodeModulesDir = path.join(projectPath, 'node_modules')
@@ -262,25 +275,27 @@ async function installInProject(projectPath, version, options={}) {
 
 /**
  * Retrieve latest published version of the `quire-11ty` package
-
- * @todo refactor to programmatically return a specific version
- * of `@thegetty/quire-11ty` from a semantic version string
- * (i.e `^1.0.0-pre-release.0` => `1.0.0-pre-release.2`)
- * so that the latest function may be used like:
- *  await latest('^1.0.0-pre-release.0') => '1.0.0-pre-release.2'
- *
- * Nota bene: `npm view [<@scope>/]<name>[@<version>] version`
- * @see https://docs.npmjs.com/cli/v7/commands/npm-view
- * returns a list of versions that satisfy the `<version>` range specifier,
- * piping this to execa `stdout` we get only the last line of output.
- * @todo use [`parse-columns`](https://github.com/sindresorhus/parse-columns)
- * to parse the column formated list of versions returned by `npm view`
- *
+ * or the latest compatible version with the provided semantic version string
+ * 
+ * @param {String} version A semantic version string, i.e `^1.0.0-pre-release.0`
+ * 
  * @return {String} `quire-11ty@latest` semantic version string
  */
-async function latest() {
-  const { stdout: quireVersion } =
-    await execa('npm', ['view', PACKAGE_NAME, 'version'])
+async function latest(version) {
+  let quireVersion;
+  if (!version || version === 'latest') {
+    const { stdout } = 
+      await execa('npm', ['view', PACKAGE_NAME, 'version'])
+    quireVersion = stdout
+  } else {
+    const response = await fetch(`https://registry.npmjs.org/${PACKAGE_NAME}`)
+    const json = await response.json()
+    const versions = Object.keys(json.versions)
+    quireVersion = semver.maxSatisfying(versions, version)
+  }
+  if (!quireVersion) {
+    throw new Error(`[CLI:quire] Sorry, we couldn't find a version of quire-11ty compatible with the version "${version}". You can set the quire-11ty version in the starter project's package.json or specify a version when running \`quire new\` with the \`--quire-version\` flag. You can run \`npm view @thegetty/quire-11ty versions\` to view all versions.`)
+  }
   return quireVersion
 }
 
@@ -314,16 +329,11 @@ async function remove(version) {
 /**
  * Sets the quire-11ty version for a project
  *
- * @param  {String}  version  Quire-11ty semantic version
+ * @param  {String}  version  a version identifier or distribution tag
  */
 function setVersion(projectPath, version) {
-  if (!version) {
-    console.error('[CLI] no version specified')
-  }
   const projectName = path.basename(projectPath)
   console.info(`${projectName} set to use quire-11ty@${version}`)
-  const versionFilePath = path.join(projectPath, VERSION_FILE)
-  fs.writeFileSync(versionFilePath, version)
 }
 
 /**

package/src/main.js

@@ -14,7 +14,7 @@ const program = new Command()
 program
   .name('quire-cli')
   .description('Quire command-line interface')
-  .version(packageConfig.version)
+  .version(packageConfig.version,  '-v, --version', 'output quire version number')
   .configureHelp({
     helpWidth: 80,
     sortOptions: false,