@thegetty/quire-cli 1.0.0-rc.3 → 1.0.0-rc.6

package/bin/cli.js

@@ -20,12 +20,12 @@ const INTERVAL = Object.freeze({
  * @todo user configuration of choosen update interval
  */
 const notifier = updateNotifier({
-  distTag: 'rc',
+  distTag: 'latest',
   pkg: packageConfig,
   updateCheckInterval: INTERVAL.DAILY,
 })
 
-notifier.notify()
+notifier.notify({ defer: false })
 
 /**
  * Run the cli program

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-rc.3",
+  "version": "1.0.0-rc.6",
   "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,9 @@ 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 <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 +53,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.quire` overrides the version in starter
+   * project `package.json`.
    */
-  const quireVersion = await getVersionFromStarter(projectPath)
+  const quireVersion = options.quire || 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.quire || 'latest'
   console.debug(`[CLI:quire] installing quire-11ty@${version}`)
   const absoluteInstallPath = path.join(__dirname, 'versions')
   fs.ensureDirSync(absoluteInstallPath)
@@ -185,19 +189,22 @@ 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={}) {
+async function installInProject(projectPath, options = {}) {
+  const version = options.quire || 'latest'
   console.debug(`[CLI:quire] installing quire-11ty@${version} 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
    */
@@ -314,16 +321,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)
 }
 
 /**

package/src/lib/11ty/plugins/before.js

@@ -1,16 +0,0 @@
-/**
- * { item_description }
- */
-module.export = (eleventyConfig) => {  
-  /**
-   * The `eleventy.before` event runs every time Eleventy starts building,
-   * it will run before the start of each stand-alone build, as well as
-   * each time building starts as either part of `--watch` or `--serve`.
-   * @see https://www.11ty.dev/docs/events/#eleventy.before
-   */
-  eleventyConfig.on('eleventy.before', async () => {
-    console.debug('[11ty] before build')
-  })
-
-  return eleventyConfig
-}

package/src/lib/quire/constants.js

@@ -1,6 +0,0 @@
-/**
- * Quire constants
- */
-export const CONSTANTS = Object.freeze({
-  PACKAGE_NAME: '@thegetty/quire-11ty'
-})

package/src/lib/quire/project.js

@@ -1,104 +0,0 @@
-import { CONSTANT } from 'constants.js'
-import fs from 'fs-extra'
-import path from 'node:path'
-
-const { PACKAGE_NAME } = CONSTANT
-
-/**
- * Read the required `quire-11ty` version from starter `package.json` `peerDependencies`
- *
- * @param    {String}   projectPath  Absolute system path to the project root
- *
- * @return  {String}  version  Quire-11ty semantic version with caret or other
- * comparators trimmed off the beginning
- *
- * @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 this string-trimming
- * logic can be removed
- */
-async function getVersion(projectPath) {
-  const packageConfig = fs.readFileSync(path.join(projectPath, 'package.json'), { encoding:'utf8' })
-  const { peerDependencies } = JSON.parse(packageConfig)
-  const version = peerDependencies[PACKAGE_NAME]
-  return version === 'latest'
-    ? await latest()
-    : version.substr(version.search(/\d/))
-}
-
-/**
- * Clone or copy a Quire starter project
- *
- * @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
- *                                    of quire being used with a new project
- */
-async function init (starter, projectPath) {
-  projectPath = projectPath || cwd()
-
-  // ensure that the target path exists
-  fs.ensureDirSync(projectPath)
-
-  // if the target directory exists it must be empty
-  if (!isEmpty(projectPath)) {
-    const location = projectPath === '.' ? 'the current directory' : projectPath
-    console.error(`[CLI] cannot create a starter project in ${location} because it is not empty`)
-    // @TODO cleanup directories from failed new command
-    return
-  }
-
-  starter = starter || 'https://github.com/thegetty/quire-starter-default'
-
-  console.debug('[CLI:quire] init-starter',
-    `\n  project root: "${projectPath}"`,
-    `\n  starter: "${starter}"`
-  )
-
-  /**
-   * Clone starter project repository
-   * @todo pipe `git clone` status to stdout for better UX
-   */
-  await git
-    .cwd(projectPath)
-    .clone(starter, '.')
-    .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.
-   */
-  const quireVersion = await getVersion(projectPath)
-  setVersion(projectPath, quireVersion)
-
-  // Re-initialize project directory as a new git repository
-  await fs.remove(path.join(projectPath, '.git'))
-
-  /**
-   * Remove the starter repository package config file
-   * and create a new package config for the project
-   * (this is necessary for Eleventy to resolve project paths)
-   * @todo allow interactive init using a custom questionnaire
-   * @see https://docs.npmjs.com/creating-a-package-json-file#customizing-the-packagejson-questionnaire
-   */
-  await fs.remove(path.join(projectPath, 'package.json'))
-  await execaCommand('npm init --yes', { cwd: projectPath })
-
-  /**
-   * Create an initial commit of files in new repository
-   * @todo use a localized string for the commit message
-   */
-  const projectFiles = fs.readdirSync(projectPath)
-  await git.init().add(projectFiles).commit('Initial Commit')
-
-  return quireVersion
-}
-
-/**
- * Update quire-11ty
- *
- * @return     {Promise}  { description_of_the_return_value }
- */
-async function update () {}