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

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' }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-rc.0",
+  "version": "1.0.0-rc.2",
   "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

@@ -40,7 +40,7 @@ export default class PreviewCommand extends Command {
     super(PreviewCommand.definition)
   }
 
-  action(options, command) {
+  async action(options, command) {
     if (options.debug) {
       console.debug('[CLI] Command \'%s\' called with arguments [%o] and options %o', this.name(), options)
     }

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

@@ -13,9 +13,9 @@ 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
@@ -113,8 +113,8 @@ export default {
     if (options.debug) process.env.DEBUG = 'Eleventy*'
 
     const eleventy = await factory(options)
+
     eleventy.setDryRun(options.dryrun)
-    eleventy.setIncrementalBuild(true)
 
     await eleventy.write()
   },
@@ -127,7 +127,6 @@ export default {
     if (options.debug) process.env.DEBUG = 'Eleventy*'
 
     const eleventy = await factory(options)
-    eleventy.setIncrementalBuild(true)
 
     await eleventy.serve(options.port)
   }

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/11ty/plugins/before.js

@@ -0,0 +1,16 @@
+/**
+ * { item_description }
+ */
+module.export = (eleventyConfig) => {  
+  /**
+   * The `eleventy.before` event runs every time Eleventy starts building,
+   * it will run before the start of each stand-alone build, as well as
+   * each time building starts as either part of `--watch` or `--serve`.
+   * @see https://www.11ty.dev/docs/events/#eleventy.before
+   */
+  eleventyConfig.on('eleventy.before', async () => {
+    console.debug('[11ty] before build')
+  })
+
+  return eleventyConfig
+}

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/lib/quire/constants.js

@@ -0,0 +1,6 @@
+/**
+ * Quire constants
+ */
+export const CONSTANTS = Object.freeze({
+  PACKAGE_NAME: '@thegetty/quire-11ty'
+})

package/src/lib/quire/project.js

@@ -0,0 +1,104 @@
+import { CONSTANT } from 'constants.js'
+import fs from 'fs-extra'
+import path from 'node:path'
+
+const { PACKAGE_NAME } = CONSTANT
+
+/**
+ * Read the required `quire-11ty` version 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
+ */
+async function getVersion(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/))
+}
+
+/**
+ * Clone or copy a Quire starter project
+ *
+ * @param    {String}   starter   A repository URL or an absolute path to local starter
+ * @TODO resolve both absolute and relative paths to local starter repositories
+ * @param    {String}   projectPath  Absolute system path to the project root
+ *
+ * @return   {String}   quireVersion  A string indicating the current version
+ *                                    of quire being used with a new project
+ */
+async function init (starter, projectPath) {
+  projectPath = projectPath || cwd()
+
+  // ensure that the target path exists
+  fs.ensureDirSync(projectPath)
+
+  // if the target directory exists it must be empty
+  if (!isEmpty(projectPath)) {
+    const location = projectPath === '.' ? 'the current directory' : projectPath
+    console.error(`[CLI] cannot create a starter project in ${location} because it is not empty`)
+    // @TODO cleanup directories from failed new command
+    return
+  }
+
+  starter = starter || 'https://github.com/thegetty/quire-starter-default'
+
+  console.debug('[CLI:quire] init-starter',
+    `\n  project root: "${projectPath}"`,
+    `\n  starter: "${starter}"`
+  )
+
+  /**
+   * Clone starter project repository
+   * @todo pipe `git clone` status to stdout for better UX
+   */
+  await git
+    .cwd(projectPath)
+    .clone(starter, '.')
+    .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.
+   */
+  const quireVersion = await getVersion(projectPath)
+  setVersion(projectPath, quireVersion)
+
+  // Re-initialize project directory as a new git repository
+  await fs.remove(path.join(projectPath, '.git'))
+
+  /**
+   * Remove the starter repository package config file
+   * and create a new package config for the project
+   * (this is necessary for Eleventy to resolve project paths)
+   * @todo allow interactive init using a custom questionnaire
+   * @see https://docs.npmjs.com/creating-a-package-json-file#customizing-the-packagejson-questionnaire
+   */
+  await fs.remove(path.join(projectPath, 'package.json'))
+  await execaCommand('npm init --yes', { cwd: projectPath })
+
+  /**
+   * Create an initial commit of files in new repository
+   * @todo use a localized string for the commit message
+   */
+  const projectFiles = fs.readdirSync(projectPath)
+  await git.init().add(projectFiles).commit('Initial Commit')
+
+  return quireVersion
+}
+
+/**
+ * Update quire-11ty
+ *
+ * @return     {Promise}  { description_of_the_return_value }
+ */
+async function update () {}

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,