@thegetty/quire-cli 1.0.0-rc.5 → 1.0.0-rc.7

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-rc.5",
+  "version": "1.0.0-rc.7",
   "author": "Getty Digital",
   "license": "SEE LICENSE IN https://github.com/thegetty/quire/blob/main/LICENSE",
   "bugs": {

package/src/commands/README.md

@@ -80,6 +80,26 @@ To create a new project from a starter template
 quire new <path> <starter>
 ```
 
+#### Specifying the `quire-11ty` version
+
+When the `--quire` flag is used the new project will be started using the specified version of `quire-11ty`
+
+```sh
+quire new <path> <starter> --quire <version>
+```
+
+##### Version identifiers
+
+The `--quire` flag must be either a semantic version identifier or a npm distribution tag. For example:
+
+```sh
+quire new ./blargh --quire 1.0.0-rc.5
+```
+
+```sh
+quire new ./blargh --quire latest
+```
+
 ### `preview`
 
 Build and server the Quire site in development mode.

package/src/commands/create.js

@@ -22,8 +22,10 @@ export default class CreateCommand extends Command {
       [ '[starter]', 'repository url or local path for a starter project' ],
     ],
     options: [
-      [ '--debug', 'debug the `quire new` command' ],
-      [ '--eject', 'install quire-11ty into the project directory', 'true' ],
+      [ '--quire-path <path>', 'local path to quire-11ty package' ],
+      [ '--quire-version <version>', 'quire-11ty version to install', 'latest' ],
+      // [ '--eject', 'install quire-11ty into the project directory', true ],
+      [ '--debug', 'debug the `quire new` command', false ],
     ],
   }
 
@@ -52,14 +54,20 @@ export default class CreateCommand extends Command {
       // const starter = starters['default']
       // `git clone starter path`
     } else {
-      const version = await quire.initStarter(starter, projectPath)
-      // @TODO we will want to abstract the test for emptiness to prevent further install steps on error
-      if (!version) return
+      /**
+       * @TODO test that `version` is compatible with the `requiredVersion`
+       * if version is incompatible or unknown
+       *   - interactive mode prompt to continue
+       *   - non-interactive mode throw an error and exit the process
+       */
+      await quire.initStarter(starter, projectPath, options)
+
+      options.eject = true
 
       if (options.eject) {
-        await quire.installInProject(projectPath, version, options)
+        await quire.installInProject(projectPath, options)
       } else {
-        await quire.install(version, options)
+        await quire.install(options)
       }
     }
   }

package/src/lib/epub/index.js

@@ -11,7 +11,9 @@ const __dirname = path.dirname(__filename)
 export default async (name = 'epubjs', options = {}) => {
   const lib = { name, options, path }
 
-  switch (lib.toLowerCase()) {
+  const normalizedName = name.replace(/[-_.\s]/g, '').toLowerCase()
+
+  switch (normalizedName) {
     case 'epubjs': {
       lib.name = 'Epub.js'
       lib.options = {}

package/src/lib/pdf/index.js

@@ -11,7 +11,9 @@ const __dirname = path.dirname(__filename)
 export default async (name = 'pagedjs', options = {}) => {
   const lib = { name, options, path }
 
-  switch (name.toLowerCase()) {
+  const normalizedName = name.replace(/[-_.\s]/g, '').toLowerCase()
+
+  switch (normalizedName) {
     case 'paged':
     case 'pagedjs': {
       lib.name = 'Paged.js'

package/src/lib/quire/index.js

@@ -79,7 +79,7 @@ async function getVersionFromStarter(projectPath) {
  * @return   {String}   quireVersion  A string indicating the current version
  *                                    of quire being used with a new project
  */
-async function initStarter (starter, projectPath) {
+async function initStarter (starter, projectPath, options) {
   projectPath = projectPath || cwd()
 
   // ensure that the target path exists
@@ -110,10 +110,12 @@ async function initStarter (starter, projectPath) {
     .catch((error) => console.error('[CLI:error] ', error))
 
   /**
-   * Determine `quire-11ty` version required by the starter project
-   * and write a `.quire` file with the semantic version string.
+   * Determine `quire-11ty` version required by the starter project.
+   *
+   * A version specified in `options.quireVersion` overrides the version in starter
+   * project `package.json`.
    */
-  const quireVersion = await getVersionFromStarter(projectPath)
+  const quireVersion = options.quireVersion || await getVersionFromStarter(projectPath)
   setVersion(projectPath, quireVersion)
 
   // Re-initialize project directory as a new git repository
@@ -140,13 +142,15 @@ async function initStarter (starter, projectPath) {
 }
 
 /**
- * Install a specific version of `quire-11ty`
+ * Install `quire-11ty`, default to 'latest' version
+ *
+ * @TODO refactor this to be callable by the installInProject method
  *
- * @param  {String}  version  Quire-11ty semantic version
  * @param  {Object}  options  options passed from `quire new` command
  * @return  {Promise}
  */
-async function install(version, options={}) {
+async function install(options = {}) {
+  const version = options.quireVersion || 'latest'
   console.debug(`[CLI:quire] installing quire-11ty@${version}`)
   const absoluteInstallPath = path.join(__dirname, 'versions')
   fs.ensureDirSync(absoluteInstallPath)
@@ -185,19 +189,23 @@ async function install(version, options={}) {
 }
 
 /**
- * Install a specific version of `quire-11ty` directly into a quire project
+ * Install `quire-11ty` directly into a quire project
+ *
+ * @TODO refactor this to use the install method with pre and post-install hooks
+ * or steps to prepare the working directory and cleanup on error and completion
  *
  * @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}`)
+async function installInProject(projectPath, options = {}) {
+  const { quirePath, quireVersion } = options
+  const quire11tyPackage = fs.existsSync(quirePath) ? quirePath : `${PACKAGE_NAME}@${quireVersion}`
+  console.debug(`[CLI:quire] installing ${quire11tyPackage} into ${projectPath}`)
 
   /**
-   * delete `package.json` from starter project, as it will be replaced with
-   * `package.json` from `@thegetty/quire-11ty`
+   * Delete the starter project package configuration so that it can be replaced
+   * with the `@thegetty/quire-11ty` configuration
    * @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
    */
@@ -220,7 +228,7 @@ async function installInProject(projectPath, version, options={}) {
     Verbosity: options.debug ? 'Debug' : 'Silent',
     WorkingDirectory: projectPath
   }
-  await inv.Install(`${PACKAGE_NAME}@${version}`, installOptions)
+  await inv.Install(quire11tyPackage, installOptions)
 
   // delete empty `node_modules` directory that `install-npm-version` creates
   const invNodeModulesDir = path.join(projectPath, 'node_modules')
@@ -314,16 +322,16 @@ async function remove(version) {
 /**
  * Sets the quire-11ty version for a project
  *
- * @param  {String}  version  Quire-11ty semantic version
+ * @param  {String}  version  a version identifier or distribution tag
  */
 function setVersion(projectPath, version) {
   if (!version) {
     console.error('[CLI] no version specified')
+    return
   }
+  fs.writeFileSync(path.join(projectPath, VERSION_FILE), version)
   const projectName = path.basename(projectPath)
   console.info(`${projectName} set to use quire-11ty@${version}`)
-  const versionFilePath = path.join(projectPath, VERSION_FILE)
-  fs.writeFileSync(versionFilePath, version)
 }
 
 /**