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

package/CHANGELOG.md

@@ -19,5 +19,5 @@ Changelog entries are classified using the following labels:
 - `Removed`: for deprecated features removed in this release
 
 
-## [Unreleased]
+## [1.0.0-pre-release]
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-pre-release.7",
+  "version": "1.0.0-pre-release.9",
   "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/commands/index.js

@@ -1,4 +1,5 @@
-import { fileURLToPath } from 'node:url'
+import { IS_WINDOWS } from '#helpers/os-utils.js'
+import { fileURLToPath, pathToFileURL } from 'node:url'
 import fs from 'fs-extra'
 import path from 'node:path'
 
@@ -14,7 +15,10 @@ const thisfile = path.basename(__filename)
 const commands = await Promise.all(
   fs.readdirSync(__dirname)
     .filter((file) => file !== thisfile && file.match(/^.*\.js$/))
-    .map((file) => import(path.resolve(__dirname, file)))
+    .map((file) => IS_WINDOWS
+      ? import(pathToFileURL(path.resolve(__dirname, file)))
+      : import(path.resolve(__dirname, file))
+    )
 ).then((modules) => {
   return modules.map(({ default: CommandClass }) => new CommandClass())
 })

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/os-utils.js

@@ -0,0 +1,5 @@
+/**
+ * Determine if the process is running on Windows operating system
+ */
+export const IS_WINDOWS =
+  process.platform === 'win32' || /^(cygwin|msys)$/.test(process.env.OSTYPE)

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/lib/11ty/api.js

@@ -1,3 +1,5 @@
+import { IS_WINDOWS } from '#helpers/os-utils.js'
+import { pathToFileURL } from 'node:url'
 import path from 'node:path'
 import paths, { eleventyRoot, projectRoot } from './paths.js'
 
@@ -18,7 +20,10 @@ const factory = async (options = {}) => {
   /**
    * Dynamically import the correct version of Eleventy from `lib/quire/versions`
    */
-  const { default: Eleventy } = await import(path.join(eleventyRoot, 'node_modules', '@11ty', 'eleventy', 'src', 'Eleventy.js'))
+  const modulePath = path.join(eleventyRoot, 'node_modules', '@11ty', 'eleventy', 'src', 'Eleventy.js')
+  const { default: Eleventy } = IS_WINDOWS
+    ? await import(pathToFileURL(modulePath))
+    : await import(modulePath)
 
   /**
    * Set Eleventy passthrough copy options

package/src/lib/quire/index.js

@@ -1,3 +1,4 @@
+import { IS_WINDOWS } from '#helpers/os-utils.js'
 import { chdir, cwd } from 'node:process'
 import { execa, execaCommand } from 'execa'
 import { fileURLToPath } from 'node:url'
@@ -16,9 +17,6 @@ const INSTALL_PATH = path.join('src', 'lib', 'quire', 'versions')
 const PACKAGE_NAME = '@thegetty/quire-11ty'
 const VERSION_FILE = '.quire'
 
-const IS_WINDOWS =
-  process.platform === 'win32' || /^(cygwin|msys)$/.test(process.env.OSTYPE)
-
 /**
  * Return an absolute path to an installed `quire-11ty` version
  *
@@ -30,7 +28,7 @@ function getPath(version='latest') {
     console.error(`[CLI:quire] \`quire-11ty@${version}\` is not installed`)
     return null
   }
-  console.debug(`[CLI:quire] \%`, absolutePath)
+  console.debug(`[CLI:quire] %s`, absolutePath)
   return absolutePath
 }
 
@@ -62,17 +60,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 +113,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

package/src/lib/pdf/paged.js

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

@@ -1,7 +0,0 @@
-// 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])