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

package/CHANGELOG.md

@@ -12,6 +12,19 @@ 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.27]
+
+### Fixed
+
+- Fixed post-v3 `quire info` bug (DEV-19984)
+
+## [1.0.0-rc.26]
+
+### Changed
+
+- Import path using node namespace in the cli info command
+- Correct file extension of cmd module called by the cli
+
 ## [1.0.0-rc.25]
 
 ### Changed

package/package.json

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

package/src/commands/info.js

@@ -2,7 +2,7 @@ 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 path from 'node:path'
 import testcwd from '#helpers/test-cwd.js'
 
 /**
@@ -40,17 +40,19 @@ export default class InfoCommand extends Command {
       console.debug('[CLI] Command \'%s\' called', this.name())
     }
 
+    // Load filename from config with a default constraint if it doesn't exist
     const versionFileName = this.config.get('versionFile')
+    let versionInfo = { cli: '<=1.0.0.rc-7' }
 
     try {
-      // the quire version file is always local to the project root
-      let fileData = fs.readFileSync(versionFileName, { encoding: 'utf8' })
-      versionInfo = JSON.parse(fileData)
+      const versionFileData = fs.readFileSync(versionFileName, { encoding: 'utf8' })
+
+      versionInfo = JSON.parse(versionFileData)      
     } 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.`
       )
-      versionInfo = { cli: '<=1.0.0.rc-7' }
+
       fs.writeFileSync(versionFileName, JSON.stringify(versionInfo))
     }
 

package/src/lib/11ty/cli.js

@@ -1,4 +1,5 @@
 import { execa } from 'execa'
+import fs from 'node:fs'
 import path from 'node:path'
 import paths, { eleventyRoot, projectRoot } from './paths.js'
 
@@ -17,9 +18,24 @@ const factory = (options = {}) => {
 
   /**
    * Use the version of Eleventy installed to `lib/quire/versions`
+   * 
+   * NB: in eleventy v3 the CLI extension (".cjs") is load-bearing but v2 is simply ".js"
+   * 
    */
-  const eleventy =
-    path.join(eleventyRoot, 'node_modules', '@11ty', 'eleventy', 'cmd.js')
+  const eleventyModuleDir = path.join(eleventyRoot, 'node_modules', '@11ty', 'eleventy')
+  const packagePath = path.join(eleventyModuleDir,'package.json')  
+
+  const pack = JSON.parse(fs.readFileSync(packagePath))
+
+  const { version } = pack
+
+  const eleventyMajorVer = version.split('.').at(0)
+
+  let eleventy = path.join(eleventyModuleDir,'cmd.cjs')
+
+  if ( Number(eleventyMajorVer) < 3 ) {
+    eleventy = path.join(eleventyModuleDir,'cmd.js')
+  }
 
   const command = [
     eleventy,

package/src/LOGGING.md

@@ -1,16 +0,0 @@
-
-## Logging
-
-- https://betterstack.com/community/guides/logging/nodejs-logging-best-practices/
-
-### `debug-js`
-- https://github.com/debug-js/debug
-- https://github.com/commenthol/debug-level
-
-### Pino
-- https://betterstack.com/community/guides/logging/how-to-install-setup-and-use-pino-to-log-node-js-applications/
-- https://github.com/pinojs/pino
-
-### Winston
-- https://betterstack.com/community/guides/logging/how-to-install-setup-and-use-winston-and-morgan-to-log-node-js-applications/
-- https://github.com/winstonjs/winston

package/src/PLUGIN.md

@@ -1,57 +0,0 @@
-## 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/commands/config/config-get.js

@@ -1,35 +0,0 @@
-import Command from '#src/Command.js'
-
-/**
- * Quire CLI `config get` Command
- *
- * @class      ConfigGetCommand
- * @extends    {Command}
- */
-export default class ConfigGetCommand extends Command {
-  static definition = {
-    name: 'config-get',
-    description: 'Get the value of a Quire CLI configuration property',
-    summary: 'get a cli configuration property',
-    version: '1.0.0',
-    args: [
-      [ '[property]', 'configuration property' ]
-    ]
-  }
-
-  constructor() {
-    super(ConfigGetCommand.definition)
-  }
-
-  /**
-   * @param      {String}  key
-   * @param      {Object}  options
-   * @return     {Promise}
-   */
-  async action(property, options = {}) {
-    for (const [ key, value ] of Object.entries(this.config.store)) {
-      if (key.startsWith('__internal__') && !options.debug) continue
-      console.info(`${key}: ${JSON.stringify(value, null, 2)}`)
-    }
-  }
-}

package/src/commands/config/config-reset.js

@@ -1,34 +0,0 @@
-import Command from '#src/Command.js'
-
-/**
- * Quire CLI `config reset` Command
- *
- * @class      ConfigResetCommand
- * @extends    {Command}
- */
-export default class ConfigResetCommand extends Command {
-  static definition = {
-    name: 'config-reset',
-    description: 'Reset the Quire CLI configuration to the default',
-    summary: 'reset cli configuration properties to default values',
-    version: '1.0.0',
-  }
-
-  constructor() {
-    super(ConfigResetCommand.definition)
-  }
-
-  /**
-   * @return     {Promise}
-   */
-  async action(options = {}) {
-    if (options.debug) {
-      console.info('Command \'%s\' called with options %o', this.name(), options)
-    }
-
-    for (const [ key, value ] of Object.entries(this.config.store)) {
-      if (key.startsWith('__internal__') && !options.debug) continue
-      console.info(`${key}: ${JSON.stringify(value, null, 2)}`)
-    }
-  }
-}

package/src/commands/config/config-set.js

@@ -1,37 +0,0 @@
-import Command from '#src/Command.js'
-
-/**
- * Quire CLI `config set` Command
- *
- * @class      ConfigCommand
- * @extends    {Command}
- */
-export default class ConfigSetCommand extends Command {
-  static definition = {
-    name: 'config-set',
-    description: 'Set a Quire CLI configuration property',
-    summary: 'set a cli configuration property',
-    version: '1.0.0',
-    args: [
-      [ '[key]', 'configuration property key' ],
-      [ '[value]', 'configuration property value' ]
-    ]
-  }
-
-  constructor() {
-    super(ConfigSetCommand.definition)
-  }
-
-  /**
-   * @param      {String}  key
-   * @param      {String}  value
-   * @param      {Object}  options
-   * @return     {Promise}
-   */
-  async action(key, value, options = {}) {
-    for (const [ key, value ] of Object.entries(this.config.store)) {
-      if (key.startsWith('__internal__') && !options.debug) continue
-      console.info(`${key}: ${JSON.stringify(value, null, 2)}`)
-    }
-  }
-}