@thegetty/quire-cli 1.0.0-pre-release.4 → 1.0.0-pre-release.6

package/README.md

@@ -9,10 +9,3 @@ The `quire-cli` implements the [command pattern](https://en.wikipedia.org/wiki/C
 ```sh
 npx quire-cli --help
 ```
-
-
-#### Microsoft Windows
-
-https://learnshareit.com/how-to-solve-nodemon-ps1-cannot-be-loaded-because-running-scripts-is-disabled-on-this-system-in-nodejs/
-
-See [Microsoft About Execution Policies](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.3)

package/bin/cli.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node --no-warnings
+
 import cli from '#src/main.js'
 import packageConfig from '#root/package.json' assert { type: 'json' }
 import updateNotifier from 'update-notifier'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thegetty/quire-cli",
   "description": "Quire command-line interface",
-  "version": "1.0.0-pre-release.4",
+  "version": "1.0.0-pre-release.6",
   "author": "Getty Digital",
   "license": "J Paul Getty Trust",
   "bugs": {

package/src/commands/README.md

@@ -194,14 +194,6 @@ To reinstall a `quire-11ty` version run
 quire version install <version> --force
 ```
 
-#### `link`
-
-Link to a local `quire-11ty` package for development and testing.
-
-```sh
-quire version link [path]
-```
-
 #### `list`
 
 List installed versions of `quire-11ty`
@@ -218,20 +210,12 @@ Remove outdated versions of `quire-11ty`
 quire version prune
 ```
 
-#### `unlink`
-
-Unlink a local `quire-11ty` package
+#### `remove` (alias `uninstall`)
 
 ```sh
-quire version unlink
+quire version remove <version>
 ```
 
-#### `uninstall` (alias `remove`)
-
 ```sh
 quire version uninstall <version>
 ```
-
-```sh
-quire version remove <version>
-```

package/src/commands/create.js

@@ -23,6 +23,7 @@ export default class CreateCommand extends Command {
     ],
     options: [
       [ '--debug', 'debug the `quire new` command' ],
+      [ '--eject', 'install quire-11ty into the project directory', 'true' ],
     ],
   }
 
@@ -38,7 +39,7 @@ export default class CreateCommand extends Command {
    */
   async action(projectPath, starter, options = {}) {
     if (options.debug) {
-      console.info('Command \'%s\' called with options %o', this.name, options)
+      console.info('Command \'%s\' called with options %o', CreateCommand.name, options)
     }
 
     if (!projectPath && !starter) {
@@ -52,7 +53,14 @@ export default class CreateCommand extends Command {
       // `git clone starter path`
     } else {
       const version = await quire.initStarter(starter, projectPath)
-      await quire.install(version)
+      // @TODO we will want to abstract the test for emptiness to prevent further install steps on error
+      if (!version) return
+
+      if (options.eject) {
+        await quire.installInProject(projectPath, version, options)
+      } else {
+        await quire.install(version, options)
+      }
     }
   }
 }

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

@@ -1,4 +1,5 @@
 import { fileURLToPath } from 'node:url'
+import fs from 'fs-extra'
 import path from 'node:path'
 
 const __filename = fileURLToPath(import.meta.url)
@@ -19,13 +20,25 @@ const __dirname = path.dirname(__filename)
  *   and correctly resolve the path to the target of the 'latest' symlink
  */
 const cliRoot = path.resolve(__dirname, path.join('..', '..'))
+const eleventyConfig = '.eleventy.js'
 const version = 'latest'
 
-// Absolute path to the current version of quire-11ty
-export const eleventyRoot =
-  path.resolve(__dirname, path.join(cliRoot, 'lib', 'quire', 'versions', version))
+// Test project directory for an eleventy configuration file
+const hasEleventyConfig = (dir) => {
+  try {
+    return fs.readdirSync(dir).includes(eleventyConfig)
+  } catch (error) {
+    throw new Error(`[CLI:11ty] Unable to read project directory for eleventy config ${error}`)
+  }
+}
+
 export const projectRoot = process.cwd()
 
+// Absolute path to the current version of quire-11ty
+export const eleventyRoot = hasEleventyConfig(projectRoot)
+  ? projectRoot
+  : path.resolve(__dirname, path.join(cliRoot, 'lib', 'quire', 'versions', version))
+
 export default {
   config: path.join(eleventyRoot, '.eleventy.js'),
   input: path.relative(eleventyRoot, path.join(projectRoot, 'content')),

package/src/lib/quire/index.js

@@ -141,9 +141,8 @@ async function initStarter (starter, projectPath) {
 /**
  * Install a specific version of `quire-11ty`
  *
- * If a `version` argument is not given `latest` is assumed.
- *
  * @param  {String}  version  Quire-11ty semantic version
+ * @param  {Object}  options  options passed from `quire new` command
  * @return  {Promise}
  */
 async function install(version, options={}) {
@@ -157,7 +156,7 @@ async function install(version, options={}) {
    * @see https://github.com/scott-lin/install-npm-version
    */
   const installOptions = {
-    Destination: path.join('../', version),
+    Destination: path.join('..', version),
     Debug: false,
     Overwrite: options.force || options.overwrite || false,
     Verbosity: options.debug ? 'Debug' : 'Silent',
@@ -184,6 +183,82 @@ async function install(version, options={}) {
   await execaCommand('npm install --save-dev')
 }
 
+/**
+ * Install a specific version of `quire-11ty` directly into a quire project
+ *
+ * @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}`)
+
+  /**
+   * delete `package.json` from starter project, as it will be replaced with
+   * `package.json` from `@thegetty/quire-11ty`
+   * @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
+   */
+  await git
+    .cwd(projectPath)
+    .rm(['package.json'])
+    .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)
+
+  // delete empty `node_modules` directory that `install-npm-version` creates
+  const invNodeModulesDir = path.join(projectPath, 'node_modules')
+  if (fs.existsSync(invNodeModulesDir)) fs.rmdir(invNodeModulesDir)
+
+  // Copy all files installed in `.temp` to projectPath
+  fs.copySync(path.join(projectPath, '.temp'), projectPath)
+
+  console.debug('[CLI:quire] installing dev dependencies into quire project')
+  /**
+   * 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`
+   */
+  await execaCommand('npm cache clean --force', { cwd: projectPath })
+  try {
+    await execaCommand('npm install --save-dev', { cwd: projectPath })
+  } catch(error) {
+    console.warn(`[CLI:error]`, error)
+    fs.removeSync(projectPath)
+    return
+  }
+
+  const eleventyFilesToCommit = fs
+    .readdirSync(path.join(projectPath, temp11tyDirectory))
+    .filter((filePath) => filePath !== 'node_modules')
+
+  eleventyFilesToCommit.push('package-lock.json')
+
+  /**
+   * Create an additional commit of new `@thegetty/quire-11ty` files in repository
+   * @todo use a localized string for the commit message
+   */
+  await git.add(eleventyFilesToCommit).commit('Adds `@thegetty/quire-11ty` files')
+
+  // remove temporary 11ty install directory
+  fs.removeSync(path.join(projectPath, temp11tyDirectory))
+}
+
 /**
  * Retrieve latest published version of the `quire-11ty` package
  * Nota bene: `npm view [<@scope>/]<name>[@<version>] version`
@@ -317,6 +392,7 @@ export const quire = {
   getVersion,
   initStarter,
   install,
+  installInProject,
   latest,
   list,
   remove,

package/src/main.js

@@ -1,4 +1,3 @@
-#!/usr/bin/env node --no-warnings
 import { Command } from 'commander'
 import commands from './commands/index.js'
 import packageConfig from '../package.json' assert { type: 'json' }