@thegetty/quire-cli 1.0.0-pre-release.2 → 1.0.0-pre-release.4

package/README.md

@@ -9,3 +9,10 @@ The `quire-cli` implements the [command pattern](https://en.wikipedia.org/wiki/C
 ```sh
 npx quire-cli --help
 ```
+
+
+#### Microsoft Windows
+
+https://learnshareit.com/how-to-solve-nodemon-ps1-cannot-be-loaded-because-running-scripts-is-disabled-on-this-system-in-nodejs/
+
+See [Microsoft About Execution Policies](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.3)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-pre-release.2",
+  "version": "1.0.0-pre-release.4",
   "author": "Getty Digital",
   "license": "J Paul Getty Trust",
   "bugs": {
@@ -19,6 +19,7 @@
   "type": "module",
   "files": [
     "bin/",
+    "scripts",
     "src/",
     "CHANGELOG.md",
     "LICENSE",
@@ -35,7 +36,6 @@
   "scripts": {
     "lint": "eslint src --ext .js",
     "lint:fix": "npm run lint -- --fix",
-    "postinstall": "node scripts/postinstall.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "imports": {

package/scripts/postinstall.js

@@ -0,0 +1,27 @@
+#!/usr/bin/env node --no-warnings
+import chalk from 'chalk'
+
+// @todo use an i18n string for the documentation url
+const docsUrl = 'https://quire.getty.edu/docs/quire-cli/'
+
+const showSuccessMessage = () => {
+  const heading = chalk.inverse.green('Success!')
+  const messsage = chalk.magenta(
+    'Quire CLI installed! Please visit ',
+    chalk.underline(docsUrl),
+    ' for more information.'
+  )
+  console.log(heading, messsage)
+}
+
+try {
+  // check if the cli is a global installation of quire-cli
+  const npmArgs = JSON.parse(process.env['npm_config_argv'])
+  if (npmArgs.cooked && npmArgs.cooked.includes('--global')) {
+    showSuccessMessage()
+    // @todo run `quire-cli --help` on success
+    // cli('--help')
+  }
+} catch (error) {
+  console.error('postinstall', error)
+}

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,