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

package/CHANGELOG.md

@@ -18,6 +18,19 @@ Changelog entries are classified using the following labels:
 
 - `Removed`: for deprecated features removed in this release
 
+## [1.0.0-rc.9]
 
-## [Unreleased]
+### Added
+- Update old `.quire` files  when running `info` command on versions prior to `1.0.0-rc.8`
+- Include `quire-cli` version used to generate project in `info` output
+- Adds headings to `info` output
 
+## [1.0.0-rc.8]
+
+### Added
+- Added `info` command to output package versions
+
+## [1.0.0-rc.7]
+
+### Added
+- Added `new` command `--quire-path` option to support development with local version of `quire-11ty`

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-rc.6",
+  "version": "1.0.0-rc.9",
   "author": "Getty Digital",
   "license": "SEE LICENSE IN https://github.com/thegetty/quire/blob/main/LICENSE",
   "bugs": {
@@ -51,7 +51,7 @@
     "conf": "^11.0.1",
     "cross-env": "^7.0.3",
     "del": "^7.0.0",
-    "epubjs-cli": "^0.1.2",
+    "epubjs-cli": "^0.1.3",
     "execa": "^6.1.0",
     "fs-extra": "^11.1.0",
     "hosted-git-info": "^6.1.1",

package/src/commands/README.md

@@ -16,6 +16,14 @@ Build Quire publication EPUB format.
 quire build epub
 ```
 
+#### `info`
+
+List `quire-11ty`, `quire-cli`, and starter package versions; use the `--debug` option to include node, npm, and os versions.
+
+```sh
+quire build info
+```
+
 #### `pdf`
 
 Build Quire publication PDF format.
@@ -154,14 +162,6 @@ To set the quire version globally use the `--global` command flag.
 quire version 1.0.0 --global
 ```
 
-#### `info`
-
-Display the local and global `quire-11ty` version; this is the *default* subcommand (running `quire version` invokes the `info` subcommand).
-
-```sh
-quire version info
-```
-
 #### `install`
 
 ```sh

package/src/commands/create.js

@@ -22,7 +22,8 @@ export default class CreateCommand extends Command {
       [ '[starter]', 'repository url or local path for a starter project' ],
     ],
     options: [
-      [ '--quire <version>', 'quire-11ty version to install', 'latest' ],
+      [ '--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 ],
     ],

package/src/commands/info.js

@@ -0,0 +1,125 @@
+import Command from '#src/Command.js'
+import { execaCommand } from 'execa'
+import fs from 'node:fs'
+import os from 'node:os'
+import path from 'path'
+import testcwd from '#helpers/test-cwd.js'
+
+const VERSION_FILE = '.quire'
+
+/**
+ * Quire CLI `info` Command
+ *
+ * Runs the Eleventy `info` command to list the quire-cli, quire-11ty, node, and npm versions.
+ *
+ * @class      InfoCommand
+ * @extends    {Command}
+ */
+export default class InfoCommand extends Command {
+  static definition = {
+    name: 'info',
+    description: 'List Quire cli, quire-11ty, and node versions',
+    summary: 'list info',
+    version: '1.0.0',
+    args: [],
+    options: [['--debug', 'include os versions in output']],
+  }
+
+  constructor() {
+    super(InfoCommand.definition)
+  }
+
+  async action(options, command) {
+    if (options.debug) {
+      console.debug(
+        '[CLI] Command \'%s\' called with options %o',
+        this.name(),
+        options
+      )
+    } else {
+      console.debug('[CLI] Command \'%s\' called', this.name())
+    }
+
+    let versionFile = fs.readFileSync(VERSION_FILE, { encoding: 'utf8' })
+    try {
+      versionFile = JSON.parse(versionFile)
+    } catch (error) {
+      console.warn(
+        `This project was generated with the quire-cli prior to version 1.0.0.rc-8. Updating the version file to the new format, though this project's version file will not contain specific starter version information.`
+      )
+      versionFile = { cli: '<=1.0.0.rc-7' }
+      fs.writeFileSync(VERSION_FILE, JSON.stringify(versionFile))
+    }
+
+    const { name: projectDirectory } = path.parse(process.cwd())
+
+    const versions = [
+      {
+        title: `[${projectDirectory}]`,
+        items: [
+          {
+            name: 'quire-cli',
+            get: () => versionFile.cli,
+          },
+          {
+            name: 'quire-11ty',
+            get: () => {
+              const { version } = JSON.parse(fs.readFileSync('./package.json'))
+              return version
+            },
+          },
+          {
+            name: 'starter',
+            get: () => versionFile.starter,
+          },
+        ],
+      },
+      {
+        title: '[System]',
+        items: [
+          {
+            name: 'quire-cli',
+            get: async () => {
+              const { stdout } = await execaCommand('quire --version')
+              return stdout
+            },
+          },
+          {
+            debug: true,
+            name: 'node',
+            get: () => process.version,
+          },
+          {
+            debug: true,
+            name: 'npm',
+            get: async () => {
+              const { stdout } = await execaCommand('npm --version')
+              return stdout
+            },
+          },
+          {
+            debug: true,
+            name: 'os',
+            get: () => `${os.type()} ${os.release()}`,
+          },
+        ],
+      },
+    ]
+
+    /**
+     * Filter the command output based on `debug` settings
+     */
+    versions.forEach(async ({ items, title }) => {
+      const versions = await Promise.all(
+        items
+          .filter(({ debug }) => !debug || (options.debug && debug))
+          .map(async ({ name, get }) => `${name} ${await get()}`)
+      )
+      console.info(`${title}\n ${versions.join('\n ')}`)
+    })
+  }
+
+  preAction(command) {
+    testcwd(command)
+  }
+}

package/src/lib/quire/index.js

@@ -6,6 +6,7 @@ import { isEmpty } from '#helpers/is-empty.js'
 import fs from 'fs-extra'
 import git from '#src/lib/git/index.js'
 import inv from 'install-npm-version'
+import packageConfig from '#root/package.json' assert { type: 'json' }
 import path from 'node:path'
 import semver from 'semver'
 
@@ -60,13 +61,14 @@ 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
  */
-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 === 'latest'
+async function getVersionsFromStarter(projectPath) {
+  const projectPackageConfig = fs.readFileSync(path.join(projectPath, 'package.json'), { encoding:'utf8' })
+  const { peerDependencies, version: starterVersion } = JSON.parse(projectPackageConfig)
+  const quire11ty = peerDependencies[PACKAGE_NAME]
+  const quire11tyVersion = quire11ty === 'latest'
     ? await latest()
-    : version.substr(version.search(/\d/))
+    : quire11ty.substr(quire11ty.search(/\d/))
+  return { quire11tyVersion, starterVersion }
 }
 
 /**
@@ -112,12 +114,23 @@ async function initStarter (starter, projectPath, options) {
   /**
    * Determine `quire-11ty` version required by the starter project.
    *
-   * A version specified in `options.quire` overrides the version in starter
+   * A version specified in `options.quireVersion` overrides the version in starter
    * project `package.json`.
    */
-  const quireVersion = options.quire || await getVersionFromStarter(projectPath)
+  const { quire11tyVersion, starterVersion } = await getVersionsFromStarter(projectPath)
+  const quireVersion = options.quireVersion || quire11tyVersion
+
   setVersion(projectPath, quireVersion)
 
+  /**
+   * Write quire-11ty, cli, starter name and version to VERSION_FILE
+   */
+  const versionInfo = { 
+    cli: packageConfig.version,
+    starter: `${starter}@${starterVersion}`,
+  }
+  fs.writeFileSync(path.join(projectPath, VERSION_FILE), JSON.stringify(versionInfo))
+
   // Re-initialize project directory as a new git repository
   await fs.remove(path.join(projectPath, '.git'))
 
@@ -150,7 +163,7 @@ async function initStarter (starter, projectPath, options) {
  * @return  {Promise}
  */
 async function install(options = {}) {
-  const version = options.quire || 'latest'
+  const version = options.quireVersion || 'latest'
   console.debug(`[CLI:quire] installing quire-11ty@${version}`)
   const absoluteInstallPath = path.join(__dirname, 'versions')
   fs.ensureDirSync(absoluteInstallPath)
@@ -199,8 +212,9 @@ async function install(options = {}) {
  * @return  {Promise}
  */
 async function installInProject(projectPath, options = {}) {
-  const version = options.quire || 'latest'
-  console.debug(`[CLI:quire] installing quire-11ty@${version} into ${projectPath}`)
+  const { quirePath, quireVersion } = options
+  const quire11tyPackage = fs.existsSync(quirePath) ? quirePath : `${PACKAGE_NAME}@${quireVersion}`
+  console.debug(`[CLI:quire] installing ${quire11tyPackage} into ${projectPath}`)
 
   /**
    * Delete the starter project package configuration so that it can be replaced
@@ -227,7 +241,7 @@ async function installInProject(projectPath, 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')
@@ -328,7 +342,7 @@ function setVersion(projectPath, 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}`)
 }