@thegetty/quire-cli 1.0.0-pre-release.6 → 1.0.0-pre-release.8

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-pre-release.6",
+  "version": "1.0.0-pre-release.8",
   "author": "Getty Digital",
   "license": "J Paul Getty Trust",
   "bugs": {
@@ -65,7 +65,7 @@
   },
   "devDependencies": {
     "del-cli": "^5.0.0",
-    "eslint": "^8.27.0"
+    "eslint": "^8.28.0"
   },
   "engines": {
     "node": ">=14.16"

package/src/helpers/is-quire.js

@@ -1,5 +1,12 @@
 import fs from 'node:fs'
-import path from 'node:path'
+
+const QUIRE_DOT_FILES = Object.freeze([
+  '.eleventy.js',
+  '.quire',
+  '.quire-11ty',
+  '.quire-version',
+  'eleventy.config.js',
+])
 
 /**
  * Test if a directory is a Quire project root
@@ -8,11 +15,13 @@ import path from 'node:path'
  * a directory is a Quire project, testing a Quire project subdirectory will
  * return falsely negative result.
  *
+ * @todo refactor this to throw an Error NOTQUIRE
+ *
  * @param    {String}   dirpath   path to a local directory
  * @return   {Promise}
  */
 export function isQuire (dirpath) {
   return fs.readdirSync(dirpath)
-    .includes((file) => file === '.eleventy.js' || file === '.quire.js')
+    .includes((file) => QUIRE_DOT_FILES.includes(file))
 }
 

package/src/helpers/test-cwd.js

@@ -0,0 +1,19 @@
+import isQuire from '#helpers/is-quire.js'
+
+/**
+ * Test current working directory is a Quire project directory
+ *
+ * @param  {String}  projectPath
+ * @return  {Boolean}
+ */
+export default (command) => {
+  const message = `[CLI] the '${command.name}' command must be run from a Quire project directory.`
+
+  return (projectPath) => {
+    if (!isQuire(process.cwd()) && !isQuire(projectPath)) {
+      if (command) console.error(message)
+      return false
+    }
+    return true
+  }
+}

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/quire/index.js

@@ -62,17 +62,20 @@ function getVersion(projectPath) {
  * (i.e `^1.0.0-pre-release.0` => `1.0.0-pre-release.2`) so this string-trimming
  * logic can be removed
  */
-function getVersionFromStarter(projectPath) {
+async function getVersionFromStarter(projectPath) {
   const packageConfig = fs.readFileSync(path.join(projectPath, 'package.json'), { encoding:'utf8' })
   const { peerDependencies } = JSON.parse(packageConfig)
   const version = peerDependencies[PACKAGE_NAME]
-  return version.substr(version.search(/\d/))
+  return version === 'latest'
+    ? await latest()
+    : version.substr(version.search(/\d/))
 }
 
 /**
  * Clone or copy a Quire starter project
  *
- * @param    {String}   starter   A repository URL or path to local starter
+ * @param    {String}   starter   A repository URL or an absolute path to local starter
+ * @TODO resolve both absolute and relative paths to local starter repositories 
  * @param    {String}   projectPath  Absolute system path to the project root
  *
  * @return   {String}   quireVersion  A string indicating the current version
@@ -112,7 +115,7 @@ async function initStarter (starter, projectPath) {
    * Determine `quire-11ty` version required by the starter project
    * and write a `.quire` file with the semantic version string.
    */
-  const quireVersion = getVersionFromStarter(projectPath) || await latest()
+  const quireVersion = await getVersionFromStarter(projectPath)
   setVersion(projectPath, quireVersion)
 
   // Re-initialize project directory as a new git repository