@thegetty/quire-cli 1.0.0-pre-release.5 → 1.0.0-pre-release.7

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-pre-release.5",
+  "version": "1.0.0-pre-release.7",
   "author": "Getty Digital",
   "license": "J Paul Getty Trust",
   "bugs": {

package/src/helpers/which.js

@@ -0,0 +1,17 @@
+import which from 'which'
+
+/**
+ * A simple wrapper around the `which` utility
+ * to find the first instance of an executable in the shell environment PATH
+ *
+ * @param  {String}  executable  shell executable to find
+ */
+export default (executable) => {
+  const result = which.sync(executable, { nothrow: true })
+  if (!result) {
+    console.error(`Unable to locate executable '${executable}'\n
+      Ensure that the '${executable}' executable is installed and available in the shell environment PATH.
+    `)
+  }
+  return result
+}

package/src/lib/pdf/paged.js

@@ -0,0 +1,21 @@
+// if (!commandExists('pagedjs-cli')) return
+// const opts = [
+//   `--outline-tags 'h1'`,
+//   `--output ${output}`,
+// ]
+// const { stderror, stdout } = execa('pagedjs-cli', [...opts, input])
+
+// console.info(`[CLI:lib/pdf] generating PDF using ${lib}`)
+// const Printer = await import('pagedjs-cli')
+/**
+ * Configure the Paged.js Printer options
+ * @see https://gitlab.coko.foundation/pagedjs/pagedjs-cli/-/blob/main/src/cli.js
+ */
+// const printerOptions = { debug: options.debug || false }
+// const printer = new Printer(printerOptions)
+/**
+ * Configure the Paged.js PDF options
+ * @see
+ */
+// const pdfOptions = {}
+// const pdfFile = await printer.pdf(input, pdfOptions)

package/src/lib/pdf/prince.js

@@ -0,0 +1,7 @@
+// if (!commandExists('prince')) return
+// const opts = [
+//   `--outline-tags 'h1'`,
+//   `--output ${output}`,
+// ]
+// console.info(`[CLI:lib/pdf] generating PDF using ${lib}`)
+// const { stderror, stdout } = execa('prince', [...opts, input])

package/src/build-copy/epub.js

@@ -1,54 +0,0 @@
-import Command from '#src/Command.js'
-import { build } from '#lib/pdf/index.js'
-import open from 'open'
-
-/**
- * Quire CLI `build epub` Command
- *
- * Generate an EPUB from Eleventy `build` output.
- *
- * @class      EpubCommand
- * @extends    {Command}
- */
-export default class EpubCommand extends Command {
-  static definition = {
-    name: 'epub',
-    description: 'Generate publication EPUB',
-    summary: 'run build epub',
-    version: '1.0.0',
-    args: [
-    ],
-    options: [
-      [
-        '--lib <module>', 'use the specified pdf module', 'pagedjs',
-        // { choices: ['pagedjs', 'prince'], default: 'pagedjs' }
-      ],
-      [ '--open', 'open PDF in default application' ],
-      [ '--debug', 'run build with debug output to console' ],
-    ],
-  }
-
-  constructor() {
-    super(PDFCommand.definition)
-  }
-
-  action(options, command) {
-    if (options.debug) {
-      console.debug('[CLI] Command \'%s\' called with options %o', this.name(), options)
-    }
-    const pdf = await pdf.build()
-    if (options.open) await open(pdf)
-  }
-
-  /**
-   * test that `build site` has been run and output can be reused
-   * @todo
-   */
-  preAction(command) {
-    const options = command.opts()
-    if (options.debug) {
-      console.debug('[CLI] Calling \'build\' command pre-action with options', options)
-    }
-    // console.log(command.parent)
-  }
-}

package/src/build-copy/pdf.js

@@ -1,54 +0,0 @@
-import Command from '#src/Command.js'
-import { build } from '#lib/pdf/index.js'
-import open from 'open'
-
-/**
- * Quire CLI `build pdf` Command
- *
- * Generate a PDF from Eleventy `build` output.
- *
- * @class      PDFCommand
- * @extends    {Command}
- */
-export default class PDFCommand extends Command {
-  static definition = {
-    name: 'pdf',
-    description: 'Generate publication PDF',
-    summary: 'run build pdf',
-    version: '1.0.0',
-    args: [
-    ],
-    options: [
-      [
-        '--lib <module>', 'use the specified pdf module', 'pagedjs',
-        // { choices: ['pagedjs', 'prince'], default: 'pagedjs' }
-      ],
-      [ '--open', 'open PDF in default application' ],
-      [ '--debug', 'run build with debug output to console' ],
-    ],
-  }
-
-  constructor() {
-    super(PDFCommand.definition)
-  }
-
-  action(options, command) {
-    if (options.debug) {
-      console.debug('[CLI] Command \'%s\' called with options %o', this.name(), options)
-    }
-    const pdf = await pdf.build()
-    if (options.open) await open(pdf)
-  }
-
-  /**
-   * test that `build site` has been run and output can be reused
-   * @todo
-   */
-  preAction(command) {
-    const options = command.opts()
-    if (options.debug) {
-      console.debug('[CLI] Calling \'build\' command pre-action with options', options)
-    }
-    // console.log(command.parent)
-  }
-}

package/src/build-copy/site.js

@@ -1,66 +0,0 @@
-import Command from '#src/Command.js'
-import { api, cli, paths, projectRoot  } from '#lib/11ty/index.js'
-import { clean } from '#helpers/clean.js'
-
-/**
- * Quire CLI `build site` Command
- *
- * Runs the Eleventy `build` to generate static output.
- *
- * @class      SiteCommand
- * @extends    {Command}
- */
-export default class SiteCommand extends Command {
-  static definition = {
-    name: 'site',
-    description: 'Generate publication outputs',
-    summary: 'run build site',
-    version: '1.0.0',
-    isDefault: true,
-    args: [
-      // [
-      //   '[formats]', 'output formats',
-      //   {
-      //     choices: ['html', 'pdf', 'epub'],
-      //     default: ['html', 'html only']
-      //   }
-      // ],
-    ],
-    options: [
-      [ '-d', '--dry-run', 'run build without writing files' ],
-      [ '-q', '--quiet', 'run build with no console messages' ],
-      [ '-v', '--verbose', 'run build with verbose console messages' ],
-      [
-        '--11ty <module>', 'use the specified 11ty module', 'cli',
-        // { choices: ['api', 'cli'], default: 'cli' }
-      ],
-      [ '--debug', 'run build with debug output to console' ],
-    ],
-  }
-
-  constructor() {
-    super(SiteCommand.definition)
-  }
-
-  action(options, command) {
-    if (options.debug) {
-      console.debug('[CLI] Command \'%s\' called with options %o', this.name(), options)
-    }
-
-    if (options['11ty'] === 'cli') {
-      console.debug('[CLI] running eleventy using lib/11ty cli')
-      cli.build(options)
-    } else {
-      console.debug('[CLI] running eleventy using lib/11ty api')
-      api.build(options)
-    }
-  }
-
-  preAction(command) {
-    const options = command.opts()
-    if (options.debug) {
-      console.debug('[CLI] Calling \'build\' command pre-action with options', options)
-    }
-    clean(projectRoot, paths, options)
-  }
-}