@thegetty/quire-cli 1.0.0-rc.23 → 1.0.0-rc.25

package/CHANGELOG.md

@@ -12,16 +12,30 @@ Changelog entries are classified using the following labels:
 - `Fixed`: for any bug fixes
 - `Removed`: for deprecated features removed in this release
 
-## [1.0.0-rc.23]
+## [1.0.0-rc.25]
+
+### Changed
+
+- Use quire-cli config values for quire-11ty version and version file name
+
+### Fixed
+
+- Install path for quire-11ty versions
+
+## [1.0.0-rc.24]
 
 ### Changed
 
-- Replace Node `import` assertions (deprecated) with file operations
+- Replace Node `import` assertions (deprecated) with a packageConfig module
 
 ### Fixed
 
 - Quire new command fails with newer version of Node #968
 
+## [1.0.0-rc.23]
+
+:warning: broken release candidate
+
 ## [1.0.0-rc.22]
 
 :warning: broken release candidate

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-rc.23",
+  "version": "1.0.0-rc.25",
   "author": "Getty Digital",
   "license": "SEE LICENSE IN https://github.com/thegetty/quire/blob/main/LICENSE",
   "bugs": {
@@ -64,6 +64,7 @@
     "install-npm-version": "^1.0.9",
     "js-yaml": "^4.1.0",
     "loglevel": "^1.8.1",
+    "node-fetch": "^3.3.2",
     "open": "^8.4.0",
     "ora": "^6.1.2",
     "pagedjs-cli": "^0.4.3",

package/src/PLUGIN.md

@@ -0,0 +1,57 @@
+## Quire Plugins
+
+### Defining Plugins
+
+```javascript
+import { definePlugin } from 'quire-cli/plugins'
+
+definePlugin({
+  commands: [],
+  compatability: {
+    // quire-cli version
+  },
+  name: 'plugin-name',
+  version: 'semantic-version',
+  install: () => {},
+  prepare: () => {},
+})
+```
+
+### Adding Quire Commands
+
+
+
+### Modifying Quire Commands
+
+```javascript
+import { modifyCommand } from 'quire-cli/plugins'
+
+/**
+ * Extend an existing quire-cli command with additional aliases or options
+ * 
+ * @todo how should the version be updated when a command is extended?
+ * 
+ * @typedef  {CommandDefinition}
+ * @property {String} alias
+ * @property {Array<String>} aliases
+ * @property {Array<CommandOption>} options
+ * 
+ * @returns {Command} instance of the extended command object
+ */
+modifyCommand(commandName, {})
+```
+
+### Overriding Quire Commands
+
+```javascript
+import { replaceCommand } from 'quire-cli/plugins'
+
+/**
+ * Override an existing quire-cli command
+ * 
+ * @params  {CommandDefinition}  A complete Command definition
+ * 
+ * @returns {Command} instance of the extended command object
+ */
+replaceCommand({})
+```

package/src/lib/quire/index.js

@@ -1,30 +1,36 @@
 import { IS_WINDOWS } from '#helpers/os-utils.js'
 import { chdir, cwd } from 'node:process'
 import { execa, execaCommand } from 'execa'
+import { fileURLToPath } from 'node:url'
 import { isEmpty } from '#helpers/is-empty.js'
+import config from '#lib/conf/config.js'
 import fetch from 'node-fetch'
 import fs from 'fs-extra'
-import git from '#src/lib/git/index.js'
+import git from '#lib/git/index.js'
 import inv from 'install-npm-version'
 import packageConfig from '#src/packageConfig.js'
 import path from 'node:path'
 import semver from 'semver'
 
-const { name: PACKAGE_NAME } = packageConfig
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
 
 // Version install path is relative to process working directory
 const INSTALL_PATH = path.join('src', 'lib', 'quire', 'versions')
-const VERSION_FILE = '.quire'
+const PACKAGE_NAME = '@thegetty/quire-11ty'
+
+const QUIRE_VERSION = config.get('quireVersion')
+const VERSION_FILE = config.get('versionFile')
 
 /**
- * Return an absolute path to an installed `quire-11ty` version
+ * Return an absolute path to an installed quire-11ty version
  *
- * @return  {String}  path to installed `quire-11ty` version
+ * @return  {String}  path to installed quire-11ty version
  */
-function getPath(version='latest') {
-  const absolutePath = path.relative('/', `${INSTALL_PATH}/${version}`)
+function getPath(version=QUIRE_VERSION) {
+  const absolutePath = path.relative('/', path.join(INSTALL_PATH, version))
   if (!fs.existsSync(absolutePath)) {
-    console.error(`[CLI:quire] \`quire-11ty@${version}\` is not installed`)
+    console.error(`[CLI:quire] quire-11ty@${version} is not installed`)
     return null
   }
   console.debug(`[CLI:quire] %s`, absolutePath)
@@ -32,7 +38,7 @@ function getPath(version='latest') {
 }
 
 /**
- * Read the required `quire-11ty` version for the project `.quire` file
+ * Read the required quire-11ty version for the quire version file
  *
  * @param    {String}   projectPath  Absolute system path to the project root
  *
@@ -47,7 +53,7 @@ function getVersion(projectPath) {
 }
 
 /**
- * Read the required `quire-11ty` and starter versions from starter `package.json` `peerDependencies`
+ * Read required quire-11ty and starter versions from starter peerDependencies
  *
  * @param    {String}   projectPath  Absolute system path to the project root
  *
@@ -87,8 +93,8 @@ async function initStarter (starter, projectPath, options) {
   }
 
   console.debug('[CLI:quire] init-starter',
-    `\n  project root: "${projectPath}"`,
-    `\n  starter: "${starter}"`
+    `\n  project: ${path.join(__dirname, projectPath)}`,
+    `\n  starter: ${starter}`
   )
 
   /**
@@ -101,19 +107,19 @@ async function initStarter (starter, projectPath, options) {
     .catch((error) => console.error('[CLI:error] ', error))
 
   /**
-   * Determine the `quire-11ty` version to use in the new project,
-   * from the `quireVersion` option or as required by the starter project.
+   * Determine the quire-11ty version to use in the new project,
+   * from the quireVersion option or as required by the starter project.
    *
-   * Uses `latest` to get the latest semantic version compatible with version ranges
+   * Uses 'latest' to get the latest semantic version compatible with version ranges
    */
   const { quire11tyVersion, starterVersion } = await getVersionsFromStarter(projectPath)
   const quireVersion = await latest(options.quireVersion || quire11tyVersion)
   setVersion(projectPath, quireVersion)
 
   /**
-   * Write quire-11ty, cli, starter name and version to VERSION_FILE
+   * Write quire-11ty, quire-cli, starter versions to the version file
    */
-  const versionInfo = { 
+  const versionInfo = {
     cli: packageConfig.version,
     starter: `${starter}@${starterVersion}`,
   }
@@ -142,7 +148,7 @@ async function initStarter (starter, projectPath, options) {
 }
 
 /**
- * Install `quire-11ty`, default to 'latest' version
+ * Install quire-11ty (default to 'latest' version)
  *
  * @TODO refactor this to be callable by the installInProject method
  *
@@ -150,7 +156,7 @@ async function initStarter (starter, projectPath, options) {
  * @return  {Promise}
  */
 async function install(options = {}) {
-  const version = options.quireVersion || 'latest'
+  const version = options.quireVersion || QUIRE_VERSION
   console.debug(`[CLI:quire] installing quire-11ty@${version}`)
   const absoluteInstallPath = path.join(__dirname, 'versions')
   fs.ensureDirSync(absoluteInstallPath)
@@ -181,9 +187,7 @@ async function install(options = {}) {
    * these must be `devDependencies` so that they are not bundled into
    * the final `_site` package when running `quire build`
    */
-  const currentWorkingDirectory = cwd()
-  const versionDir = path.join(absoluteInstallPath, version)
-  chdir(versionDir)
+  chdir(path.join(absoluteInstallPath, version))
   await execaCommand('npm cache clean --force')
   await execaCommand('npm install --save-dev')
 }

package/src/packageConfig.js

@@ -6,10 +6,9 @@ const __filename = fileURLToPath(import.meta.url)
 const __dirname = dirname(__filename)
 
 /**
- * Nota bene:
- * working directory will be the path from which quire-cli commands are run;
- * readPackageUpSync must be called with the change working directory option
- * set to the path of this module to find the quire-cli package config file.
+ * Nota bene: current working directory will be that from which cli commands
+ * are being, readPackageUpSync is passed the directory of this module as the
+ * starting path to search for the quire-cli package config file.
  */
 const { packageJson } = readPackageUpSync({ cwd: __dirname, normalize: true })