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

package/CHANGELOG.md

@@ -12,6 +12,16 @@ 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.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

package/package.json

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

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,26 +1,33 @@
 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 __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 PACKAGE_NAME = '@thegetty/quire-11ty'
-const VERSION_FILE = '.quire'
+
+const QUIRE_VERSION = config.get('quireVersion')
+const VERSION_FILE = config.get('versionFile')
 
 /**
  * Return an absolute path to an installed quire-11ty version
  *
  * @return  {String}  path to installed quire-11ty version
  */
-function getPath(version='latest') {
+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`)
@@ -86,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}`
   )
 
   /**
@@ -149,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)
@@ -180,7 +187,6 @@ 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()
   chdir(path.join(absoluteInstallPath, version))
   await execaCommand('npm cache clean --force')
   await execaCommand('npm install --save-dev')