@thegetty/quire-cli 1.0.0-pre-release.16 → 1.0.0-rc.1

package/bin/cli.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node --no-warnings
+#!/usr/bin/env -S node --no-warnings
 
 import cli from '#src/main.js'
 import packageConfig from '#root/package.json' assert { type: 'json' }
@@ -20,7 +20,7 @@ const INTERVAL = Object.freeze({
  * @todo user configuration of choosen update interval
  */
 const notifier = updateNotifier({
-  distTag: 'pre-release',
+  distTag: 'rc',
   pkg: packageConfig,
   updateCheckInterval: INTERVAL.DAILY,
 })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-pre-release.16",
+  "version": "1.0.0-rc.1",
   "author": "Getty Digital",
   "license": "SEE LICENSE IN https://github.com/thegetty/quire/blob/main/LICENSE",
   "bugs": {
@@ -45,30 +45,29 @@
     "#lib/*.js": "./src/lib/*.js"
   },
   "dependencies": {
-    "boxen": "^7.0.0",
-    "chalk": "^5.1.2",
-    "commander": "^9.4.1",
-    "conf": "^10.2.0",
+    "boxen": "^7.0.1",
+    "chalk": "^5.2.0",
+    "commander": "^10.0.0",
+    "conf": "^11.0.1",
     "cross-env": "^7.0.3",
     "del": "^7.0.0",
-    "epubjs": "^0.4.2",
+    "epubjs-cli": "^0.1.1",
     "execa": "^6.1.0",
-    "fs-extra": "^11.0.0",
+    "fs-extra": "^11.1.0",
     "hosted-git-info": "^6.1.1",
-    "i18next": "^22.0.4",
+    "i18next": "^22.4.9",
     "inquirer": "^9.1.4",
     "install-npm-version": "^1.0.8",
-    "loglevel": "^1.8.0",
+    "loglevel": "^1.8.1",
     "open": "^8.4.0",
     "ora": "^6.1.2",
-    "pagedjs-cli": "^0.3.1",
+    "pagedjs-cli": "^0.3.3",
     "semver": "^7.3.8",
-    "simple-git": "^3.15.0",
+    "simple-git": "^3.16.0",
     "update-notifier": "^6.0.2"
   },
   "devDependencies": {
-    "del-cli": "^5.0.0",
-    "eslint": "^8.28.0"
+    "eslint": "^8.32.0"
   },
   "engines": {
     "node": ">=14.16"

package/src/commands/README.md

@@ -42,41 +42,17 @@ Note that this command is distinct from the [quire/11ty package](https://github.
 quire clean --dry-run
 ```
 
-### `configure`
+### `configure` **not yet implemented**
 
-Edit a Quire project configuration.
+Edit the Quire CLI configuration.
 
 ```sh
 quire configure
 ```
 
-### `debug`
+### `install` **not yet implemented**
 
-Display Quire debugging information in the console.
-
-```sh
-quire debug
-```
-
-### `dev`
-
-Clone `quire/packages/11ty` into the local project.
-
-```sh
-quire dev
-```
-
-### `edit`
-
-Open or create a new content file in the default editor.
-
-```sh
-quire edit
-```
-
-### `install`
-
-Clone an existing project from a git repository.
+Clone an existing Quire project from a git repository.
 
 ```sh
 quire install <repository>
@@ -112,7 +88,7 @@ Build and server the Quire site in development mode.
 quire preview --port 8080
 ```
 
-#### `epub`
+#### `epub` **not yet implemented**
 
 Preview the Quire publication epub in the default application.
 
@@ -120,17 +96,7 @@ Preview the Quire publication epub in the default application.
 quire preview epub --open
 ```
 
-To preview the epub in Apple iBooks or Kindle Previewer
-
-```sh
-quire preview epub --open iBooks
-```
-
-```sh
-quire preview epub --open Kindle
-```
-
-#### `pdf`
+#### `pdf` **not yet implemented**
 
 Preview the Quire publication PDF in the default application.
 
@@ -138,13 +104,7 @@ Preview the Quire publication PDF in the default application.
 quire preview pdf --open
 ```
 
-Preview the Quire publication PDF in an application.
-
-```sh
-quire preview pdf --open <Application>
-```
-
-#### `site`
+#### `site` **default subcommand**
 
 Build and serve the Quire site in development mode.
 
@@ -152,7 +112,7 @@ Build and serve the Quire site in development mode.
 quire preview site
 ```
 
-#### `server`
+### `server` **not yet implemented**
 
 Start a local web server to serve a previously built Quire site.
 
@@ -160,7 +120,7 @@ Start a local web server to serve a previously built Quire site.
 quire server --port 8080
 ```
 
-### `version`
+### `version` **partial implementation**
 
 Sets the Quire version to use when running commands on the project.
 

package/src/commands/epub.js

@@ -48,8 +48,8 @@ export default class EpubCommand extends Command {
 
     const output = path.join(projectRoot, `${options.lib}.epub`)
 
-    const epubLib = await libEpub(options.lib, { ...options.debug })
-    await epubLib(input, output, { ...options.debug })
+    const epubLib = await libEpub(options.lib, { debug: options.debug })
+    await epubLib(input, output)
 
     if (fs.existsSync(output) && options.open) open(output)
   }

package/src/commands/pdf.js

@@ -50,8 +50,8 @@ export default class PDFCommand extends Command {
 
     const output = path.join(projectRoot, `${options.lib}.pdf`)
 
-    const pdfLib = await libPdf(options.lib, { ...options.debug })
-    await pdfLib(input, output, { ...options.debug })
+    const pdfLib = await libPdf(options.lib, { debug: options.debug })
+    await pdfLib(input, output)
 
     try {
       if (fs.existsSync(output) && options.open) open(output)

package/src/commands/preview.js

@@ -42,7 +42,7 @@ export default class PreviewCommand extends Command {
 
   async action(options, command) {
     if (options.debug) {
-      console.debug('[CLI] Command \'%s\' called with arguments [%o] and options %o', this.name(), args.join(', '), options)
+      console.debug('[CLI] Command \'%s\' called with arguments [%o] and options %o', this.name(), options)
     }
 
     if (options['11ty'] === 'cli') {

package/src/lib/11ty/api.js

@@ -13,12 +13,12 @@ import paths, { eleventyRoot, projectRoot } from './paths.js'
 const factory = async (options = {}) => {
   const { config, input, output } = paths
 
-  console.info(`[CLI:11ty] projectRoot ${projectRoot}`)
-
-  console.debug('[CLI:11ty] %o', paths)
+  if (options.debug) {
+    console.debug('[CLI:11ty] projectRoot %s\n%o', projectRoot, paths)
+  }
 
   /**
-   * Dynamically import the correct version of Eleventy from `lib/quire/versions`
+   * Dynamically import the correct version of Eleventy
    */
   const modulePath = path.join(eleventyRoot, 'node_modules', '@11ty', 'eleventy', 'src', 'Eleventy.js')
   const { default: Eleventy } = await dynamicImport(modulePath)
@@ -29,8 +29,7 @@ const factory = async (options = {}) => {
    * @see https://github.com/timkendrick/recursive-copy
    */
   const copyOptions = {
-    debug: options.debug || false,
-    expand: false,
+    debug: options.debug || false
   }
 
   /**
@@ -64,23 +63,23 @@ const factory = async (options = {}) => {
        * to the `config` file however the quire-cli separates 11ty from the
        * project directory (`input`) and needs to use absolute system paths.
        */
-      // const addPassthroughCopy = eleventyConfig.addPassthroughCopy.bind(eleventyConfig)
-      // eleventyConfig.addPassthroughCopy = (entry) => {
-      //   if (typeof entry === 'string') {
-      //     const filePath = path.resolve(entry) //path.join(projectRoot, file)
-      //     // console.debug('[11ty:API] passthrough copy %s', filePath)
-      //     return addPassthroughCopy(filePath, copyOptions)
-      //   } else {
-      //     // console.debug('[11ty:API] passthrough copy %o', entry)
-      //     entry = Object.fromEntries(
-      //       Object.entries(entry).map(([ src, dest ]) => {
-      //         return [ path.join(eleventyRoot, src), path.resolve(dest) ]
-      //       })
-      //     )
-      //     // console.debug('[11ty:API] passthrough copy %o', entry)
-      //     return addPassthroughCopy(entry, copyOptions)
-      //   }
-      // }
+      const addPassthroughCopy = eleventyConfig.addPassthroughCopy.bind(eleventyConfig)
+      eleventyConfig.addPassthroughCopy = (entry) => {
+        if (typeof entry === 'string') {
+          const filePath = path.resolve(entry) //path.join(projectRoot, file)
+          // console.debug('[11ty:API] passthrough copy %s', filePath)
+          return addPassthroughCopy(filePath, copyOptions)
+        } else {
+          // console.debug('[11ty:API] passthrough copy %o', entry)
+          entry = Object.fromEntries(
+            Object.entries(entry).map(([ src, dest ]) => {
+              return [ path.join(eleventyRoot, src), path.resolve(dest) ]
+            })
+          )
+          // console.debug('[11ty:API] passthrough copy %o', entry)
+          return addPassthroughCopy(entry, copyOptions)
+        }
+      }
 
       /**
        * Event callback when a build completes

package/src/lib/11ty/cli.js

@@ -11,9 +11,9 @@ import paths, { eleventyRoot, projectRoot } from './paths.js'
 const factory = (options = {}) => {
   const { config, input, output } = paths
 
-  console.info(`[CLI:11ty] projectRoot ${projectRoot}`)
-
-  console.debug('[CLI:11ty] %o', paths)
+  if (options.debug) {
+    console.debug('[CLI:11ty] projectRoot %s\n%o', projectRoot, paths)
+  }
 
   /**
    * Use the version of Eleventy installed to `lib/quire/versions`

package/src/lib/epub/epub.js

@@ -1,9 +1,27 @@
-// import epub from 'epubjs'
+import { ManifestToEpub } from 'epubjs-cli'
+import fs from 'fs-extra'
+import { pathToFileURL } from 'node:url'
 
 /**
  * A façade module for the EPUB.js library
- * @see https://github.com/futurepress/epub.js
+ * @see https://github.com/futurepress/epubjs-cli
  */
-export default async (input, output, options) => {
-  console.info('[CLI:lib/epubjs] integration with epub.js is not yet implemented.')
+export default async (input, output, options = {}) => {
+  try {
+    console.info(`[CLI:lib/epub/epubjs] Generating ePub from ${input}`)
+
+    const url = pathToFileURL(`${input}/manifest.json`).toString()
+
+    const epub = await new ManifestToEpub(url)
+      .catch((error) => console.error(error))
+
+    const file = await epub.save()
+      .catch((error) => console.error(error))
+
+    if (file && output) {
+      fs.writeFile(output, file, (error) => { if (error) throw error })
+    }
+  } catch (ERR_FILE_NOT_FOUND) {
+    console.error(`[CLI:lib/epub/epubjs] file not found ${input}`)
+  }
 }

package/src/lib/epub/index.js

@@ -8,29 +8,31 @@ const __dirname = path.dirname(__filename)
 /**
  * A façade delegation module for EPUB libraries
  */
-export default async (lib = 'epubjs', options = {}) => {
-  let libName, libPath
+export default async (name = 'epubjs', options = {}) => {
+  const lib = { name, options, path }
 
   switch (lib.toLowerCase()) {
     case 'epubjs': {
-      libName = 'Epub.js'
-      libPath = path.join(__dirname, 'epub.js')
+      lib.name = 'Epub.js'
+      lib.options = {}
+      lib.path = path.join(__dirname, 'epub.js')
       break
     }
     case 'pandoc': {
-      libName = 'Pandoc'
-      libPath = path.join(__dirname, 'pandoc.js')
+      lib.name = 'Pandoc'
+      lib.options = {}
+      lib.path = path.join(__dirname, 'pandoc.js')
       break
     }
     default:
-      console.error(`[CLI:lib/pdf] Unrecognized EPUB library '${lib}'`)
+      console.error(`[CLI:lib/pdf] Unrecognized EPUB library '${name}'`)
       return
   }
 
-  const { default: epubLib } = await dynamicImport(libPath)
+  const { default: epubLib } = await dynamicImport(lib.path)
 
-  return async (input, output, options = {}) => {
-    console.info(`[CLI:lib/epub] generating EPUB using ${libName}`)
-    return await epubLib(input, output, options)
+  return async (input, output) => {
+    console.info(`[CLI:lib/epub] generating EPUB using ${lib.name}`)
+    return await epubLib(input, output, lib.options)
   }
 }

package/src/lib/epub/pandoc.js

@@ -20,7 +20,7 @@ const xhtmlFiles = (dirent) => {
  * A façade module for interacting with Pandoc CLI.
  * @see https://pandoc.org/MANUAL.html#general-options
  */
-export default async (input, output, options) => {
+export default async (input, output, options = {}) => {
   which('pandoc')
 
   const inputs = fs.readdirSync(input)

package/src/lib/pdf/index.js

@@ -8,31 +8,33 @@ const __dirname = path.dirname(__filename)
 /**
  * A façade delegation module for PDF generation libraries
  */
-export default async (lib = 'pagedjs', options = {}) => {
-  let libName, libPath
+export default async (name = 'pagedjs', options = {}) => {
+  const lib = { name, options, path }
 
-  switch (lib.toLowerCase()) {
+  switch (name.toLowerCase()) {
     case 'paged':
     case 'pagedjs': {
-      libName = 'Paged.js'
-      libPath = path.join(__dirname, 'paged.js')
+      lib.name = 'Paged.js'
+      lib.options = { debug: options.debug }
+      lib.path = path.join(__dirname, 'paged.js')
       break
     }
     case 'prince':
     case 'princexml': {
-      libName = 'Prince'
-      libPath = path.join(__dirname, 'prince.js')
+      lib.name = 'Prince'
+      lib.options = { debug: options.debug, verbose: options.verbose }
+      lib.path = path.join(__dirname, 'prince.js')
       break
     }
     default:
-      console.error(`[CLI:lib/pdf] Unrecognized PDF library '${lib}'`)
+      console.error(`[CLI:lib/pdf] Unrecognized PDF library '${name}'`)
       return
   }
 
-  const { default: pdfLib } = await dynamicImport(libPath)
+  const { default: pdfLib } = await dynamicImport(lib.path)
 
-  return async (input, output, options = {}) => {
-    console.info(`[CLI:lib/pdf] generating PDF using ${libName}`)
-    return await pdfLib(input, output, options)
+  return async (input, output) => {
+    console.info(`[CLI:lib/pdf] generating PDF using ${lib.name}`)
+    return await pdfLib(input, output, lib.options)
   }
 }

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/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,