@thegetty/quire-cli 1.0.0-pre-release.12 → 1.0.0-pre-release.14

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-pre-release.12",
+  "version": "1.0.0-pre-release.14",
   "author": "Getty Digital",
-  "license": "J Paul Getty Trust",
+  "license": "SEE LICENSE IN https://github.com/thegetty/quire/blob/main/LICENSE",
   "bugs": {
     "url": "https://github.com/thegetty/quire/issues"
   },

package/src/commands/build.js

@@ -1,6 +1,7 @@
 import Command from '#src/Command.js'
 import { api, cli, paths, projectRoot  } from '#lib/11ty/index.js'
 import { clean } from '#helpers/clean.js'
+import testcwd from '#helpers/test-cwd.js'
 
 /**
  * Quire CLI `build` Command
@@ -56,6 +57,8 @@ export default class BuildCommand extends Command {
   }
 
   preAction(command) {
+    testcwd(command)
+
     const options = command.opts()
     if (options.debug) {
       console.debug('[CLI] Calling \'build\' command pre-action with options', options)

package/src/commands/clean.js

@@ -1,6 +1,7 @@
 import Command from '#src/Command.js'
 import { clean } from '#helpers/clean.js'
 import { paths, projectRoot  } from '#lib/11ty/index.js'
+import testcwd from '#helpers/test-cwd.js'
 
 /**
  * Quire CLI `clean` Command
@@ -53,4 +54,8 @@ export default class CleanCommand extends Command {
 
     console.debug(`[CLI] ${message} ${deletedPaths}`)
   }
+
+  preAction(command) {
+    testcwd(command)
+  }
 }

package/src/commands/preview.js

@@ -1,5 +1,6 @@
 import Command from '#src/Command.js'
 import { api, cli, paths, projectRoot  } from '#lib/11ty/index.js'
+import testcwd from '#helpers/test-cwd.js'
 
 /**
  * Quire CLI `preview` Command
@@ -53,4 +54,8 @@ export default class PreviewCommand extends Command {
       api.serve(options)
     }
   }
+
+  preAction(command) {
+    testcwd(command)
+  }
 }

package/src/commands/version.js

@@ -1,5 +1,7 @@
 import Command from '#src/Command.js'
+import { paths, projectRoot  } from '#lib/11ty/index.js'
 import * as quire from '#lib/quire/index.js'
+import testcwd from '#helpers/test-cwd.js'
 
 /**
  * Quire CLI `version` Command
@@ -21,7 +23,7 @@ export default class VersionCommand extends Command {
       [ '<version>', 'the local quire version to use' ],
     ],
     options: [
-      [ '-g', '--global', 'set the quire version globally' ],
+      // [ '-g', '--global', 'set the quire version globally' ],
     ],
   }
 
@@ -29,9 +31,13 @@ export default class VersionCommand extends Command {
     super(VersionCommand.definition)
   }
 
-  async action(path, starter, options = {}) {
+  action(args, options = {}) {
     if (options.debug) {
       console.info('Command \'%s\' called with options %o', this.name, options)
     }
   }
+
+  preAction(command) {
+    testcwd(command)
+  }
 }

package/src/helpers/is-quire.js

@@ -20,8 +20,8 @@ const QUIRE_DOT_FILES = Object.freeze([
  * @param    {String}   dirpath   path to a local directory
  * @return   {Promise}
  */
-export function isQuire (dirpath) {
+export default function (dirpath) {
   return fs.readdirSync(dirpath)
-    .includes((file) => QUIRE_DOT_FILES.includes(file))
+    .find((entry) => QUIRE_DOT_FILES.includes(entry))
 }
 

package/src/helpers/test-cwd.js

@@ -3,17 +3,13 @@ import isQuire from '#helpers/is-quire.js'
 /**
  * Test current working directory is a Quire project directory
  *
- * @param  {String}  projectPath
- * @return  {Boolean}
+ * @param  {Command}  command  the command from which testcwd was called
  */
 export default (command) => {
-  const message = `[CLI] the '${command.name}' command must be run from a Quire project directory.`
+  const message = `[CLI] ${ command ? command.name() : '' } command must be run while in a Quire project directory. Use 'cd' to navigate to your project directory and re-run the 'quire ${ command ? command.name() : '' }' command.`
 
-  return (projectPath) => {
-    if (!isQuire(process.cwd()) && !isQuire(projectPath)) {
-      if (command) console.error(message)
-      return false
-    }
-    return true
+  if (!isQuire(process.cwd())) {
+    console.error(message)
+    process.exit(1)
   }
 }

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

@@ -23,15 +23,6 @@ const cliRoot = path.resolve(__dirname, path.join('..', '..'))
 const eleventyConfig = '.eleventy.js'
 const version = 'latest'
 
-// 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()
 
 const inputDir = path.join(projectRoot, 'content')
@@ -47,10 +38,49 @@ const libQuirePath = path.resolve(__dirname, path.join(cliRoot, 'lib', 'quire',
  * Nota bene: to get a relative path to the `eleventyRoot`,
  * for example when the version is specified is 'latest',
  * it must be set to the real path to the symlink target.
+ *
+ * @todo refactor how and *when* the eleventyRoot is determined:
+ *  - we only need eleventyRoot for cli commands that run 11ty
+ *  - paths module is a concern of the `quire` module
+ *  - global quire-cli installation
+ *  - local quire-cli installation
+ *
+ *  For an excellent developer experience, the quire-11ty code should be
+ *  installed into an `11ty` or `quire-11ty` directory in the `projectRoot`
+ *  this will allow us to more easily manage symlinks for local development
+ *  using unpublished `quire-11ty` code.
+ *  @example
+ *  ```sh
+ *  blargh/
+ *    .git/
+ *    .gitignore
+ *    .node-version
+ *    .quire-version
+ *    11ty@ --> /Users/mph/Code/Getty/quire/packages/11ty
+ *    content/
+ *    CHANGELOG.md
+ *    LICENSE
+ *    README.md
+ *    package.json
+ *    package-lock.json
+ *  ```
+ *  Installing to a directory will allow more cleanly `eject` and `uneject`
+ *  using a symlink or single directory `rm -rf`.
+ *  Should the `11ty` directory be a dot directory to hide the complexity from
+ *  users or should it be visible to be more explicit when project is ejected?
  */
-export const eleventyRoot = hasEleventyConfig(projectRoot)
-  ? projectRoot
-  : fs.realpathSync(libQuirePath)
+const getEleventyRoot = () => {
+  // try {
+  //   return fs.readdirSync(projectRoot).includes(eleventyConfig)
+  //     ? projectRoot
+  //     : fs.realpathSync(libQuirePath)
+  // } catch (error) {
+  //   throw new Error(`[CLI:11ty] Unable to read project directory for eleventy config ${error}`)
+  // }
+  return projectRoot
+}
+
+export const eleventyRoot = getEleventyRoot()
 
 export default {
   config: path.join(eleventyRoot, '.eleventy.js'),

package/src/lib/quire/index.js

@@ -262,17 +262,21 @@ async function installInProject(projectPath, version, options={}) {
 
 /**
  * Retrieve latest published version of the `quire-11ty` package
+
+ * @todo refactor 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 that the latest function may be used like:
+ *  await latest('^1.0.0-pre-release.0') => '1.0.0-pre-release.2'
+ *
  * Nota bene: `npm view [<@scope>/]<name>[@<version>] version`
  * @see https://docs.npmjs.com/cli/v7/commands/npm-view
  * returns a list of versions that satisfy the `<version>` range specifier,
  * piping this to execa `stdout` we get only the last line of output.
+ * @todo use [`parse-columns`](https://github.com/sindresorhus/parse-columns)
+ * to parse the column formated list of versions returned by `npm view`
  *
  * @return {String} `quire-11ty@latest` semantic version string
- *
- * @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 it may be used like:
- * await latest('^1.0.0-pre-release.0') => '1.0.0-pre-release.2'
  */
 async function latest() {
   const { stdout: quireVersion } =

package/LICENSE

@@ -1 +0,0 @@
-Copyright (c) 2022, J Paul Getty Trust.