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

package/CHANGELOG.md

@@ -18,6 +18,24 @@ Changelog entries are classified using the following labels:
 
 - `Removed`: for deprecated features removed in this release
 
+## [1.0.0-rc.10]
 
-## [Unreleased]
+### Added
+- Support semantic version ranges for `quire-11ty` in quire starter projects and the `--quire-version` option of the `quire new` command, and use the latest compatible `quire-11ty` version when creating and installing a new project.
 
+## [1.0.0-rc.9]
+
+### Added
+- Update old `.quire` files  when running `info` command on versions prior to `1.0.0-rc.8`
+- Include `quire-cli` version used to generate project in `info` output
+- Adds headings to `info` output
+
+## [1.0.0-rc.8]
+
+### Added
+- Added `info` command to output package versions
+
+## [1.0.0-rc.7]
+
+### Added
+- Added `new` command `--quire-path` option to support development with local version of `quire-11ty`

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,12 +20,12 @@ const INTERVAL = Object.freeze({
  * @todo user configuration of choosen update interval
  */
 const notifier = updateNotifier({
-  distTag: 'rc',
+  distTag: 'latest',
   pkg: packageConfig,
   updateCheckInterval: INTERVAL.DAILY,
 })
 
-notifier.notify()
+notifier.notify({ defer: false })
 
 /**
  * Run the cli program

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.10",
   "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.3",
     "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

@@ -16,6 +16,14 @@ Build Quire publication EPUB format.
 quire build epub
 ```
 
+#### `info`
+
+List `quire-11ty`, `quire-cli`, and starter package versions; use the `--debug` option to include node, npm, and os versions.
+
+```sh
+quire build info
+```
+
 #### `pdf`
 
 Build Quire publication PDF format.
@@ -42,41 +50,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`
-
-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`
+### `install` **not yet implemented**
 
-Clone an existing project from a git repository.
+Clone an existing Quire project from a git repository.
 
 ```sh
 quire install <repository>
@@ -104,47 +88,51 @@ To create a new project from a starter template
 quire new <path> <starter>
 ```
 
-### `preview`
+#### Specifying the `quire-11ty` version
 
-Build and server the Quire site in development mode.
+When the `--quire` flag is used the new project will be started using the specified version of `quire-11ty`
 
 ```sh
-quire preview --port 8080
+quire new <path> <starter> --quire <version>
 ```
 
-#### `epub`
+##### Version identifiers
 
-Preview the Quire publication epub in the default application.
+The `--quire` flag must be either a semantic version identifier or a npm distribution tag. For example:
 
 ```sh
-quire preview epub --open
+quire new ./blargh --quire 1.0.0-rc.5
 ```
 
-To preview the epub in Apple iBooks or Kindle Previewer
-
 ```sh
-quire preview epub --open iBooks
+quire new ./blargh --quire latest
 ```
 
+### `preview`
+
+Build and server the Quire site in development mode.
+
 ```sh
-quire preview epub --open Kindle
+quire preview --port 8080
 ```
 
-#### `pdf`
+#### `epub` **not yet implemented**
 
-Preview the Quire publication PDF in the default application.
+Preview the Quire publication epub in the default application.
 
 ```sh
-quire preview pdf --open
+quire preview epub --open
 ```
 
-Preview the Quire publication PDF in an application.
+#### `pdf` **not yet implemented**
+
+Preview the Quire publication PDF in the default application.
 
 ```sh
-quire preview pdf --open <Application>
+quire preview pdf --open
 ```
 
-#### `site`
+#### `site` **default subcommand**
 
 Build and serve the Quire site in development mode.
 
@@ -152,7 +140,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 +148,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.
 
@@ -174,14 +162,6 @@ To set the quire version globally use the `--global` command flag.
 quire version 1.0.0 --global
 ```
 
-#### `info`
-
-Display the local and global `quire-11ty` version; this is the *default* subcommand (running `quire version` invokes the `info` subcommand).
-
-```sh
-quire version info
-```
-
 #### `install`
 
 ```sh

package/src/commands/create.js

@@ -1,4 +1,5 @@
 import Command from '#src/Command.js'
+import fs from 'fs-extra'
 import { quire } from '#src/lib/quire/index.js'
 
 /**
@@ -22,8 +23,10 @@ export default class CreateCommand extends Command {
       [ '[starter]', 'repository url or local path for a starter project' ],
     ],
     options: [
-      [ '--debug', 'debug the `quire new` command' ],
-      [ '--eject', 'install quire-11ty into the project directory', 'true' ],
+      [ '--quire-path <path>', 'local path to quire-11ty package' ],
+      [ '--quire-version <version>', 'quire-11ty version to install' ],
+      // [ '--eject', 'install quire-11ty into the project directory', true ],
+      [ '--debug', 'debug the `quire new` command', false ],
     ],
   }
 
@@ -52,14 +55,27 @@ export default class CreateCommand extends Command {
       // const starter = starters['default']
       // `git clone starter path`
     } else {
-      const version = await quire.initStarter(starter, projectPath)
-      // @TODO we will want to abstract the test for emptiness to prevent further install steps on error
-      if (!version) return
+      /**
+       * @TODO test that `version` is compatible with the `requiredVersion`
+       * if version is incompatible or unknown
+       *   - interactive mode prompt to continue
+       *   - non-interactive mode throw an error and exit the process
+       */
+      let quireVersion
+      try {
+        quireVersion = await quire.initStarter(starter, projectPath, options)
+      } catch (error) {
+        console.error(error.message)
+        fs.removeSync(projectPath)
+        return
+      }
+
+      options.eject = true
 
       if (options.eject) {
-        await quire.installInProject(projectPath, version, options)
+        await quire.installInProject(projectPath, quireVersion, options)
       } else {
-        await quire.install(version, options)
+        await quire.install(options)
       }
     }
   }

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/info.js

@@ -0,0 +1,125 @@
+import Command from '#src/Command.js'
+import { execaCommand } from 'execa'
+import fs from 'node:fs'
+import os from 'node:os'
+import path from 'path'
+import testcwd from '#helpers/test-cwd.js'
+
+const VERSION_FILE = '.quire'
+
+/**
+ * Quire CLI `info` Command
+ *
+ * Runs the Eleventy `info` command to list the quire-cli, quire-11ty, node, and npm versions.
+ *
+ * @class      InfoCommand
+ * @extends    {Command}
+ */
+export default class InfoCommand extends Command {
+  static definition = {
+    name: 'info',
+    description: 'List Quire cli, quire-11ty, and node versions',
+    summary: 'list info',
+    version: '1.0.0',
+    args: [],
+    options: [['--debug', 'include os versions in output']],
+  }
+
+  constructor() {
+    super(InfoCommand.definition)
+  }
+
+  async action(options, command) {
+    if (options.debug) {
+      console.debug(
+        '[CLI] Command \'%s\' called with options %o',
+        this.name(),
+        options
+      )
+    } else {
+      console.debug('[CLI] Command \'%s\' called', this.name())
+    }
+
+    let versionFile = fs.readFileSync(VERSION_FILE, { encoding: 'utf8' })
+    try {
+      versionFile = JSON.parse(versionFile)
+    } catch (error) {
+      console.warn(
+        `This project was generated with the quire-cli prior to version 1.0.0.rc-8. Updating the version file to the new format, though this project's version file will not contain specific starter version information.`
+      )
+      versionFile = { cli: '<=1.0.0.rc-7' }
+      fs.writeFileSync(VERSION_FILE, JSON.stringify(versionFile))
+    }
+
+    const { name: projectDirectory } = path.parse(process.cwd())
+
+    const versions = [
+      {
+        title: `[${projectDirectory}]`,
+        items: [
+          {
+            name: 'quire-cli',
+            get: () => versionFile.cli,
+          },
+          {
+            name: 'quire-11ty',
+            get: () => {
+              const { version } = JSON.parse(fs.readFileSync('./package.json'))
+              return version
+            },
+          },
+          {
+            name: 'starter',
+            get: () => versionFile.starter,
+          },
+        ],
+      },
+      {
+        title: '[System]',
+        items: [
+          {
+            name: 'quire-cli',
+            get: async () => {
+              const { stdout } = await execaCommand('quire --version')
+              return stdout
+            },
+          },
+          {
+            debug: true,
+            name: 'node',
+            get: () => process.version,
+          },
+          {
+            debug: true,
+            name: 'npm',
+            get: async () => {
+              const { stdout } = await execaCommand('npm --version')
+              return stdout
+            },
+          },
+          {
+            debug: true,
+            name: 'os',
+            get: () => `${os.type()} ${os.release()}`,
+          },
+        ],
+      },
+    ]
+
+    /**
+     * Filter the command output based on `debug` settings
+     */
+    versions.forEach(async ({ items, title }) => {
+      const versions = await Promise.all(
+        items
+          .filter(({ debug }) => !debug || (options.debug && debug))
+          .map(async ({ name, get }) => `${name} ${await get()}`)
+      )
+      console.info(`${title}\n ${versions.join('\n ')}`)
+    })
+  }
+
+  preAction(command) {
+    testcwd(command)
+  }
+}

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/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,33 @@ 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()) {
+  const normalizedName = name.replace(/[-_.\s]/g, '').toLowerCase()
+
+  switch (normalizedName) {
     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,35 @@ 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()) {
+  const normalizedName = name.replace(/[-_.\s]/g, '').toLowerCase()
+
+  switch (normalizedName) {
     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)
   }
 }