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

package/bin/cli.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node --no-warnings
+
 import cli from '#src/main.js'
 import packageConfig from '#root/package.json' assert { type: 'json' }
 import updateNotifier from 'update-notifier'

package/package.json

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

package/src/build-copy/epub.js

@@ -0,0 +1,54 @@
+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

@@ -0,0 +1,54 @@
+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

@@ -0,0 +1,66 @@
+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)
+  }
+}

package/src/commands/README.md

@@ -194,14 +194,6 @@ To reinstall a `quire-11ty` version run
 quire version install <version> --force
 ```
 
-#### `link`
-
-Link to a local `quire-11ty` package for development and testing.
-
-```sh
-quire version link [path]
-```
-
 #### `list`
 
 List installed versions of `quire-11ty`
@@ -218,20 +210,12 @@ Remove outdated versions of `quire-11ty`
 quire version prune
 ```
 
-#### `unlink`
-
-Unlink a local `quire-11ty` package
+#### `remove` (alias `uninstall`)
 
 ```sh
-quire version unlink
+quire version remove <version>
 ```
 
-#### `uninstall` (alias `remove`)
-
 ```sh
 quire version uninstall <version>
 ```
-
-```sh
-quire version remove <version>
-```

package/src/commands/create.js

@@ -23,6 +23,7 @@ export default class CreateCommand extends Command {
     ],
     options: [
       [ '--debug', 'debug the `quire new` command' ],
+      [ '--eject', 'install quire-11ty into the project directory', 'true' ],
     ],
   }
 
@@ -38,7 +39,7 @@ export default class CreateCommand extends Command {
    */
   async action(projectPath, starter, options = {}) {
     if (options.debug) {
-      console.info('Command \'%s\' called with options %o', this.name, options)
+      console.info('Command \'%s\' called with options %o', CreateCommand.name, options)
     }
 
     if (!projectPath && !starter) {
@@ -52,7 +53,14 @@ export default class CreateCommand extends Command {
       // `git clone starter path`
     } else {
       const version = await quire.initStarter(starter, projectPath)
-      await quire.install(version)
+      // @TODO we will want to abstract the test for emptiness to prevent further install steps on error
+      if (!version) return
+
+      if (options.eject) {
+        await quire.installInProject(projectPath, version, options)
+      } else {
+        await quire.install(version, options)
+      }
     }
   }
 }

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

@@ -8,7 +8,7 @@ import paths, { eleventyRoot, projectRoot } from './paths.js'
  * @param  {Object}  options  Eleventy configuration options
  * @return  {Eleventy}  A configured instance of Eleventy
  */
-const factory = async (options) => {
+const factory = async (options = {}) => {
   const { config, input, output } = paths
 
   console.info(`[CLI:11ty] projectRoot ${projectRoot}`)
@@ -20,13 +20,61 @@ const factory = async (options) => {
    */
   const { default: Eleventy } = await import(path.join(eleventyRoot, 'node_modules', '@11ty', 'eleventy', 'src', 'Eleventy.js'))
 
-  return new Eleventy(input, output, {
+  /**
+   * Set Eleventy passthrough copy options
+   * @see https://www.11ty.dev/docs/copy/#advanced-options
+   * @see https://github.com/timkendrick/recursive-copy
+   */
+  const copyOptions = {
+    debug: options.debug || false,
+    expand: true,
+  }
+
+  /**
+   * Get an instance of the runtime of eleventy.
+   * @see https://github.com/11ty/eleventy/blob/src/Eleventy.js
+   *
+   * @param {String} input  Path from which to read content templates
+   * @param {String} output  Path where rendered files will be written
+   * @param {Object} options  Options are merged with the Eleventy UserConfig
+   * @param {Object} config  An eleventy configurtion object
+   *
+   * @returns {module:11ty/eleventy/Eleventy~Eleventy}
+   */
+  const eleventy = new Eleventy(input, output, {
     config: (eleventyConfig) => {
-      // custom configuration
+      /**
+       * Override addPassthroughCopy to use _absolute_ system paths.
+       * @see https://www.11ty.dev/docs/copy/#passthrough-file-copy
+       * Nota bene: Eleventy addPassthroughCopy assumes paths are _relative_
+       * 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)
+        }
+      }
+      return eleventyConfig
     },
     configPath: options.config || config,
     quietMode: options.quiet || false,
+    // source: 'script',
   })
+
+  return eleventy
 }
 
 /**
@@ -44,6 +92,9 @@ export default {
     if (options.debug) process.env.DEBUG = 'Eleventy*'
 
     const eleventy = await factory(options)
+
+    eleventy.setDryRun(options.dryrun)
+
     await eleventy.executeBuild()
   },
   serve: async (options = {}) => {
@@ -52,6 +103,7 @@ export default {
     if (options.debug) process.env.DEBUG = 'Eleventy*'
 
     const eleventy = await factory(options)
-    await eleventy.serve()
+
+    await eleventy.serve(options.port)
   }
 }

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

@@ -1,7 +1,6 @@
 import { execa } from 'execa'
-import { fileURLToPath } from 'node:url'
 import path from 'node:path'
-import paths, { projectRoot } from './paths.js'
+import paths, { eleventyRoot, projectRoot } from './paths.js'
 
 /**
  * A factory function to configure an Eleventy CLI command
@@ -9,20 +8,31 @@ import paths, { projectRoot } from './paths.js'
  * @param  {Object}  options  Eleventy configuration options
  * @return  {Array} Eleventy CLI options
  */
-const factory = () => {
+const factory = (options = {}) => {
   const { config, input, output } = paths
 
   console.info(`[CLI:11ty] projectRoot ${projectRoot}`)
 
   console.debug('[CLI:11ty] %o', paths)
 
-  return [
-    `@11ty/eleventy`,
+  /**
+   * Use the version of Eleventy installed to `lib/quire/versions`
+   */
+  const eleventy =
+    path.join(eleventyRoot, 'node_modules', '@11ty', 'eleventy', 'cmd.js')
+
+  const command = [
+    eleventy,
     `--config=${config}`,
     `--input=${input}`,
     `--output=${output}`,
     `--incremental`,
   ]
+
+  if (options.quiet) command.push('--quiet')
+  if (options.verbose) command.push('--verbose')
+
+  return command
 }
 
 /**
@@ -33,7 +43,7 @@ export default {
   build: async (options = {}) => {
     console.info('[CLI:11ty] running eleventy build')
 
-    const eleventyOptions = factory()
+    const eleventyCommand = factory()
 
     /**
      * Set execa environment variables
@@ -42,10 +52,10 @@ export default {
     const execaEnv = {}
 
     if (options.debug) execaEnv.DEBUG = 'Eleventy*'
-    if (options.dryRun) eleventyOptions.push('--dryrun')
-    if (options.quiet) eleventyOptions.push('--quiet')
 
-    await execa('npx', eleventyOptions, {
+    if (options.dryRun) eleventyCommand.push('--dryrun')
+
+    await execa('node', eleventyCommand, {
       all: true,
       cwd: projectRoot,
       env: execaEnv,
@@ -56,9 +66,9 @@ export default {
   serve: async (options = {}) => {
     console.info(`[CLI:11ty] running eleventy serve`)
 
-    const eleventyOptions = factory()
+    const eleventyCommand = factory(options)
 
-    eleventyOptions.push('--serve')
+    eleventyCommand.push('--serve')
 
     /**
      * Set execa environment variables
@@ -67,11 +77,10 @@ export default {
     const execaEnv = {}
 
     if (options.debug) execaEnv.DEBUG = 'Eleventy*'
-    if (options.port) eleventyOptions.push(`--port=${options.port}`)
-    if (options.quiet) eleventyOptions.push('--quiet')
-    if (options.verbose) eleventyOptions.push('--verbose')
 
-    await execa('npx', eleventyOptions, {
+    if (options.port) eleventyCommand.push(`--port=${options.port}`)
+
+    await execa('node', eleventyCommand, {
       all: true,
       cwd: projectRoot,
       env: execaEnv,

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

@@ -1,4 +1,5 @@
 import { fileURLToPath } from 'node:url'
+import fs from 'fs-extra'
 import path from 'node:path'
 
 const __filename = fileURLToPath(import.meta.url)
@@ -19,13 +20,25 @@ const __dirname = path.dirname(__filename)
  *   and correctly resolve the path to the target of the 'latest' symlink
  */
 const cliRoot = path.resolve(__dirname, path.join('..', '..'))
+const eleventyConfig = '.eleventy.js'
 const version = 'latest'
 
-// Absolute path to the current version of quire-11ty
-export const eleventyRoot =
-  path.resolve(__dirname, path.join(cliRoot, 'lib', 'quire', 'versions', version))
+// Test project directory for an eleventy configuration file
+const hasEleventyConfig = (dir) => {
+  try {
+    return fs.readdirSync(dir).includes(eleventyConfig)
+  } catch (error) {
+    throw new Error(`[CLI:11ty] Unable to read project directory for eleventy config ${error}`)
+  }
+}
+
 export const projectRoot = process.cwd()
 
+// Absolute path to the current version of quire-11ty
+export const eleventyRoot = hasEleventyConfig(projectRoot)
+  ? projectRoot
+  : path.resolve(__dirname, path.join(cliRoot, 'lib', 'quire', 'versions', version))
+
 export default {
   config: path.join(eleventyRoot, '.eleventy.js'),
   input: path.relative(eleventyRoot, path.join(projectRoot, 'content')),

package/src/lib/quire/index.js

@@ -141,9 +141,8 @@ async function initStarter (starter, projectPath) {
 /**
  * Install a specific version of `quire-11ty`
  *
- * If a `version` argument is not given `latest` is assumed.
- *
  * @param  {String}  version  Quire-11ty semantic version
+ * @param  {Object}  options  options passed from `quire new` command
  * @return  {Promise}
  */
 async function install(version, options={}) {
@@ -157,7 +156,7 @@ async function install(version, options={}) {
    * @see https://github.com/scott-lin/install-npm-version
    */
   const installOptions = {
-    Destination: path.join('../', version),
+    Destination: path.join('..', version),
     Debug: false,
     Overwrite: options.force || options.overwrite || false,
     Verbosity: options.debug ? 'Debug' : 'Silent',
@@ -184,6 +183,82 @@ async function install(version, options={}) {
   await execaCommand('npm install --save-dev')
 }
 
+/**
+ * Install a specific version of `quire-11ty` directly into a quire project
+ *
+ * @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}`)
+
+  /**
+   * delete `package.json` from starter project, as it will be replaced with
+   * `package.json` from `@thegetty/quire-11ty`
+   * @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
+   */
+  await git
+    .cwd(projectPath)
+    .rm(['package.json'])
+    .catch((error) => console.error('[CLI:error] ', error))
+
+  const temp11tyDirectory = '.temp'
+  /**
+   * `Destination` is relative to `node_modules` of the working-directory
+   * so we have included a relative path to parent directory in order to
+   * install versions to a different local path.
+   * @see https://github.com/scott-lin/install-npm-version
+   */
+  const installOptions = {
+    Destination: path.join('..', temp11tyDirectory),
+    Debug: false,
+    Overwrite: options.force || options.overwrite || false,
+    Verbosity: options.debug ? 'Debug' : 'Silent',
+    WorkingDirectory: projectPath
+  }
+  await inv.Install(`${PACKAGE_NAME}@${version}`, installOptions)
+
+  // delete empty `node_modules` directory that `install-npm-version` creates
+  const invNodeModulesDir = path.join(projectPath, 'node_modules')
+  if (fs.existsSync(invNodeModulesDir)) fs.rmdir(invNodeModulesDir)
+
+  // Copy all files installed in `.temp` to projectPath
+  fs.copySync(path.join(projectPath, '.temp'), projectPath)
+
+  console.debug('[CLI:quire] installing dev dependencies into quire project')
+  /**
+   * Manually install necessary dev dependencies to run 11ty;
+   * these must be `devDependencies` so that they are not bundled into
+   * the final `_site` package when running `quire build`
+   */
+  await execaCommand('npm cache clean --force', { cwd: projectPath })
+  try {
+    await execaCommand('npm install --save-dev', { cwd: projectPath })
+  } catch(error) {
+    console.warn(`[CLI:error]`, error)
+    fs.removeSync(projectPath)
+    return
+  }
+
+  const eleventyFilesToCommit = fs
+    .readdirSync(path.join(projectPath, temp11tyDirectory))
+    .filter((filePath) => filePath !== 'node_modules')
+
+  eleventyFilesToCommit.push('package-lock.json')
+
+  /**
+   * Create an additional commit of new `@thegetty/quire-11ty` files in repository
+   * @todo use a localized string for the commit message
+   */
+  await git.add(eleventyFilesToCommit).commit('Adds `@thegetty/quire-11ty` files')
+
+  // remove temporary 11ty install directory
+  fs.removeSync(path.join(projectPath, temp11tyDirectory))
+}
+
 /**
  * Retrieve latest published version of the `quire-11ty` package
  * Nota bene: `npm view [<@scope>/]<name>[@<version>] version`
@@ -317,6 +392,7 @@ export const quire = {
   getVersion,
   initStarter,
   install,
+  installInProject,
   latest,
   list,
   remove,

package/src/main.js

@@ -1,4 +1,3 @@
-#!/usr/bin/env node --no-warnings
 import { Command } from 'commander'
 import commands from './commands/index.js'
 import packageConfig from '../package.json' assert { type: 'json' }