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

package/src/lib/quire/index.js

@@ -3,9 +3,11 @@ 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 inv from 'install-npm-version'
+import git from '#lib/git/index.js'
+import packageConfig from '#src/packageConfig.js'
 import path from 'node:path'
 import semver from 'semver'
 
@@ -15,17 +17,19 @@ 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 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)
@@ -33,7 +37,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
  *
@@ -48,25 +52,19 @@ function getVersion(projectPath) {
 }
 
 /**
- * Read the required `quire-11ty` version 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
  *
- * @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
+ * @return  {Object}
+ * @property {String} quire11tyVersion  Latest compatible Quire-11ty semantic version
+ * @property {String} starterVersion  Starter project version defined in the starter package.json
  */
-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'
-    ? await latest()
-    : version.substr(version.search(/\d/))
+async function getVersionsFromStarter(projectPath) {
+  const projectPackageConfig = fs.readFileSync(path.join(projectPath, 'package.json'), { encoding:'utf8' })
+  const { peerDependencies, version: starterVersion } = JSON.parse(projectPackageConfig)
+  const quire11tyVersion = peerDependencies[PACKAGE_NAME]
+  return { quire11tyVersion, starterVersion }
 }
 
 /**
@@ -79,7 +77,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
@@ -93,11 +91,9 @@ async function initStarter (starter, projectPath) {
     return
   }
 
-  starter = starter || 'https://github.com/thegetty/quire-starter-default'
-
   console.debug('[CLI:quire] init-starter',
-    `\n  project root: "${projectPath}"`,
-    `\n  starter: "${starter}"`
+    `\n  project: ${path.join(__dirname, projectPath)}`,
+    `\n  starter: ${starter}`
   )
 
   /**
@@ -110,12 +106,24 @@ 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 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
    */
-  const quireVersion = await getVersionFromStarter(projectPath)
+  const { quire11tyVersion, starterVersion } = await getVersionsFromStarter(projectPath)
+  const quireVersion = await latest(options.quireVersion || quire11tyVersion)
   setVersion(projectPath, quireVersion)
 
+  /**
+   * Write quire-11ty, quire-cli, starter versions to the 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'))
 
@@ -135,69 +143,28 @@ async function initStarter (starter, projectPath) {
    */
   const projectFiles = fs.readdirSync(projectPath)
   await git.init().add(projectFiles).commit('Initial Commit')
-
   return quireVersion
 }
 
 /**
- * Install a specific version of `quire-11ty`
+ * Install `quire-11ty` directly into a quire project
  *
- * @param  {String}  version  Quire-11ty semantic version
- * @param  {Object}  options  options passed from `quire new` command
- * @return  {Promise}
- */
-async function install(version, options={}) {
-  console.debug(`[CLI:quire] installing quire-11ty@${version}`)
-  const absoluteInstallPath = path.join(__dirname, 'versions')
-  fs.ensureDirSync(absoluteInstallPath)
-  /**
-   * `Destination` is relative to `node_modules` of the working-directory
-   * so we have included a relative path to parent directory in order to
-   * install versions to a different local path.
-   * @see https://github.com/scott-lin/install-npm-version
-   */
-  const installOptions = {
-    Destination: path.join('..', version),
-    Debug: false,
-    Overwrite: options.force || options.overwrite || false,
-    Verbosity: options.debug ? 'Debug' : 'Silent',
-    WorkingDirectory: absoluteInstallPath
-  }
-  await inv.Install(`${PACKAGE_NAME}@${version}`, installOptions)
-
-  // delete empty `node_modules` directory that `install-npm-version` creates
-  const invNodeModulesDir = path.join(absoluteInstallPath, 'node_modules')
-  if (fs.existsSync(invNodeModulesDir)) fs.rmdir(invNodeModulesDir)
-
-  symlinkLatest()
-
-  console.debug('[CLI:quire] installing dev dependencies')
-  /**
-   * Manually install necessary dev dependencies to run 11ty;
-   * 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)
-  await execaCommand('npm cache clean --force')
-  await execaCommand('npm install --save-dev')
-}
-
-/**
- * Install a specific version of `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={}) {
-  console.debug(`[CLI:quire] installing quire-11ty@${version} into ${projectPath}`)
+async function installInProject(projectPath, quireVersion, options = {}) {
+  const { quirePath } = options
+  const quire11tyPackage = `${PACKAGE_NAME}@${quireVersion}`
+
+  console.debug(`[CLI:quire] installing ${quire11tyPackage} 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
    */
@@ -207,27 +174,21 @@ async function installInProject(projectPath, version, options={}) {
     .catch((error) => console.error('[CLI:error] ', error))
 
   const temp11tyDirectory = '.temp'
-  /**
-   * `Destination` is relative to `node_modules` of the working-directory
-   * so we have included a relative path to parent directory in order to
-   * install versions to a different local path.
-   * @see https://github.com/scott-lin/install-npm-version
-   */
-  const installOptions = {
-    Destination: path.join('..', temp11tyDirectory),
-    Debug: false,
-    Overwrite: options.force || options.overwrite || false,
-    Verbosity: options.debug ? 'Debug' : 'Silent',
-    WorkingDirectory: projectPath
-  }
-  await inv.Install(`${PACKAGE_NAME}@${version}`, installOptions)
+  const tempDir = path.join(projectPath,temp11tyDirectory)
+  fs.mkdirSync(tempDir)
+
+  // Copy if passed a path and it exists, otherwise attempt to download the tarball for this pathspec
+  if (fs.existsSync(quirePath)) {
+    fs.copySync(quirePath, tempDir)
+  } else {
+    await execaCommand(`npm pack ${ options.debug ? '--debug' : '--quiet' } ${quire11tyPackage}`)
 
-  // delete empty `node_modules` directory that `install-npm-version` creates
-  const invNodeModulesDir = path.join(projectPath, 'node_modules')
-  if (fs.existsSync(invNodeModulesDir)) fs.rmdir(invNodeModulesDir)
+    // Extract only the package dir from the tar bar and strip it from the extracted path
+    await execaCommand(`tar -xzf thegetty-quire-11ty-${quireVersion}.tgz -C ${tempDir} --strip-components=1 package/`)
+  }
 
-  // Copy all files installed in `.temp` to projectPath
-  fs.copySync(path.join(projectPath, '.temp'), projectPath)
+  // Copy `.temp` to projectPath
+  fs.copySync(tempDir, projectPath)
 
   console.debug('[CLI:quire] installing dev dependencies into quire project')
   /**
@@ -245,7 +206,7 @@ async function installInProject(projectPath, version, options={}) {
   }
 
   const eleventyFilesToCommit = fs
-    .readdirSync(path.join(projectPath, temp11tyDirectory))
+    .readdirSync(tempDir)
     .filter((filePath) => filePath !== 'node_modules')
 
   eleventyFilesToCommit.push('package-lock.json')
@@ -262,25 +223,27 @@ async function installInProject(projectPath, version, options={}) {
 
 /**
  * Retrieve latest published version of the `quire-11ty` package
-
- * @todo refactor 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 that the latest function may be used like:
- *  await latest('^1.0.0-pre-release.0') => '1.0.0-pre-release.2'
- *
- * Nota bene: `npm view [<@scope>/]<name>[@<version>] version`
- * @see https://docs.npmjs.com/cli/v7/commands/npm-view
- * returns a list of versions that satisfy the `<version>` range specifier,
- * piping this to execa `stdout` we get only the last line of output.
- * @todo use [`parse-columns`](https://github.com/sindresorhus/parse-columns)
- * to parse the column formated list of versions returned by `npm view`
- *
+ * or the latest compatible version with the provided semantic version string
+ * 
+ * @param {String} version A semantic version string, i.e `^1.0.0-pre-release.0`
+ * 
  * @return {String} `quire-11ty@latest` semantic version string
  */
-async function latest() {
-  const { stdout: quireVersion } =
-    await execa('npm', ['view', PACKAGE_NAME, 'version'])
+async function latest(version) {
+  let quireVersion;
+  if (!version || version === 'latest') {
+    const { stdout } = 
+      await execa('npm', ['view', PACKAGE_NAME, 'version'])
+    quireVersion = stdout
+  } else {
+    const response = await fetch(`https://registry.npmjs.org/${PACKAGE_NAME}`)
+    const json = await response.json()
+    const versions = Object.keys(json.versions)
+    quireVersion = semver.maxSatisfying(versions, version)
+  }
+  if (!quireVersion) {
+    throw new Error(`[CLI:quire] Sorry, we couldn't find a version of quire-11ty compatible with the version "${version}". You can set the quire-11ty version in the starter project's package.json or specify a version when running \`quire new\` with the \`--quire-version\` flag. You can run \`npm view @thegetty/quire-11ty versions\` to view all versions.`)
+  }
   return quireVersion
 }
 
@@ -314,16 +277,11 @@ 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')
-  }
   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)
 }
 
 /**
@@ -370,19 +328,6 @@ function symlinkLatest() {
   return fs.symlinkSync(target, source, type)
 }
 
-/**
- * Tests if a `quire-11ty` version is already installed
- * and installs the version if it is not already installed.
- *
- * @param  {String}  version  `quire-11ty` semantic version
- */
-function testVersion(version) {
-  version ||= getVersion()
-  if (!versions.includes(version)) {
-    install(version)
-  }
-}
-
 /**
  * Get an array of published `quire-11ty` package versions
  *
@@ -396,12 +341,10 @@ export const quire = {
   getPath,
   getVersion,
   initStarter,
-  install,
   installInProject,
   latest,
   list,
   remove,
   setVersion,
-  testVersion,
   versions,
 }

package/src/main.js

@@ -1,6 +1,9 @@
 import { Argument, Command, Option } from 'commander'
-import commands from './commands/index.js'
-import packageConfig from '../package.json' assert { type: 'json' }
+import commands from '#src/commands/index.js'
+import config from '#lib/conf/config.js'
+import packageConfig from '#src/packageConfig.js'
+
+const { version } = packageConfig
 
 /**
  * Quire CLI implements the command pattern.
@@ -12,9 +15,9 @@ import packageConfig from '../package.json' assert { type: 'json' }
 const program = new Command()
 
 program
-  .name('quire-cli')
+  .name('quire')
   .description('Quire command-line interface')
-  .version(packageConfig.version,  '-v, --version', 'output quire version number')
+  .version(version,  '-v, --version', 'output quire version number')
   .configureHelp({
     helpWidth: 80,
     sortOptions: false,
@@ -23,9 +26,12 @@ program
 
 /**
  * Register each command as a subcommand of this program
+ *
+ * @todo refactor command definition to allow for per-command custom help text
+ * @see https://github.com/tj/commander.js?tab=readme-ov-file#automated-help
  */
 commands.forEach((command) => {
-  const { action, aliases, args, description, name, options } = command
+  const { action, alias, aliases, args, description, name, options } = command
 
   const subCommand = program
     .command(name)
@@ -33,8 +39,12 @@ commands.forEach((command) => {
     .addHelpCommand()
     .showHelpAfterError()
 
+  if (alias instanceof String) {
+    subCommand.alias(alias)
+  }
+
   if (Array.isArray(aliases)) {
-    aliases.forEach((alias) => subCommand.alias(alias))
+    subCommand.aliases(aliases)
   }
 
   /**
@@ -103,6 +113,11 @@ commands.forEach((command) => {
 
   // subCommand.action((args) => action.apply(command, args))
   subCommand.action(action)
+
+  /**
+   * Inject the CLI configuration into commands
+   */
+  subCommand.config = config
 })
 
 /**

package/src/packageConfig.js

@@ -0,0 +1,15 @@
+import { dirname } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { readPackageUpSync } from 'read-package-up'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+
+/**
+ * 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 })
+
+export default packageJson

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/config/README.md

@@ -1,3 +0,0 @@
-## CLI Configuration Manager
-
-This `quire-cli/lib/config` module orchestrates creation of new projects and management of existing project configuration.

package/src/lib/config/index.js

@@ -1 +0,0 @@
-import semver from 'semver'

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 () {}