@thegetty/quire-cli 1.0.0-rc.34 → 1.0.0-rc.36

package/src/lib/project/detect.test.js

@@ -0,0 +1,157 @@
+import test from 'ava'
+import { Volume, createFsFromVolume } from 'memfs'
+import esmock from 'esmock'
+
+test.beforeEach((t) => {
+  // Create in-memory file system
+  t.context.vol = new Volume()
+  t.context.fs = createFsFromVolume(t.context.vol)
+})
+
+test.afterEach.always((t) => {
+  // Clear in-memory file system
+  t.context.vol.reset()
+})
+
+test('detect should recognize .eleventy.js marker file', async (t) => {
+  const { fs, vol } = t.context
+
+  // Setup a Quire project directory with .eleventy.js
+  vol.fromJSON({
+    '/quire-project/.eleventy.js': 'module.exports = function() {}',
+    '/quire-project/content/_data/config.yaml': 'title: Test Project'
+  })
+
+  // Mock node:fs to use memfs
+  const detect = await esmock('./detect.js', {
+    'node:fs': fs
+  })
+
+  const result = detect('/quire-project')
+
+  t.truthy(result, 'should return truthy value for directory with .eleventy.js')
+  t.is(result, '.eleventy.js', 'should return the marker file name')
+})
+
+test('detect should recognize eleventy.config.js marker file', async (t) => {
+  const { fs, vol } = t.context
+
+  // Setup a Quire project directory with eleventy.config.js
+  vol.fromJSON({
+    '/quire-project/eleventy.config.js': 'module.exports = function() {}',
+    '/quire-project/content/_data/config.yaml': 'title: Test Project'
+  })
+
+  // Mock node:fs to use memfs
+  const detect = await esmock('./detect.js', {
+    'node:fs': fs
+  })
+
+  const result = detect('/quire-project')
+
+  t.truthy(result, 'should return truthy value for directory with eleventy.config.js')
+  t.is(result, 'eleventy.config.js', 'should return the marker file name')
+})
+
+test('detect should recognize .quire marker file', async (t) => {
+  const { fs, vol } = t.context
+
+  // Setup a Quire project directory with .quire marker
+  vol.fromJSON({
+    '/quire-project/.quire': '',
+    '/quire-project/content/index.md': '# Welcome'
+  })
+
+  // Mock node:fs to use memfs
+  const detect = await esmock('./detect.js', {
+    'node:fs': fs
+  })
+
+  const result = detect('/quire-project')
+
+  t.truthy(result, 'should return truthy value for directory with .quire')
+  t.is(result, '.quire', 'should return the marker file name')
+})
+
+test('detect should recognize .quire-11ty marker file', async (t) => {
+  const { fs, vol } = t.context
+
+  // Setup a Quire project directory with .quire-11ty marker
+  vol.fromJSON({
+    '/quire-project/.quire-11ty': '',
+    '/quire-project/content/index.md': '# Welcome'
+  })
+
+  // Mock node:fs to use memfs
+  const detect = await esmock('./detect.js', {
+    'node:fs': fs
+  })
+
+  const result = detect('/quire-project')
+
+  t.truthy(result, 'should return truthy value for directory with .quire-11ty')
+  t.is(result, '.quire-11ty', 'should return the marker file name')
+})
+
+test('detect should recognize .quire-version marker file', async (t) => {
+  const { fs, vol } = t.context
+
+  // Setup a Quire project directory with .quire-version marker
+  vol.fromJSON({
+    '/quire-project/.quire-version': '1.0.0',
+    '/quire-project/content/index.md': '# Welcome'
+  })
+
+  // Mock node:fs to use memfs
+  const detect = await esmock('./detect.js', {
+    'node:fs': fs
+  })
+
+  const result = detect('/quire-project')
+
+  t.truthy(result, 'should return truthy value for directory with .quire-version')
+  t.is(result, '.quire-version', 'should return the marker file name')
+})
+
+test('detect should return falsy for non-Quire directory', async (t) => {
+  const { fs, vol } = t.context
+
+  // Setup a non-Quire directory (no marker files)
+  vol.fromJSON({
+    '/non-quire-directory/some-file.txt': 'not a quire project',
+    '/non-quire-directory/package.json': JSON.stringify({ name: 'some-other-project' })
+  })
+
+  // Mock node:fs to use memfs
+  const detect = await esmock('./detect.js', {
+    'node:fs': fs
+  })
+
+  const result = detect('/non-quire-directory')
+
+  t.falsy(result, 'should return falsy value for directory without marker files')
+})
+
+test('detect should return first marker file found when multiple exist', async (t) => {
+  const { fs, vol } = t.context
+
+  // Setup a Quire project directory with multiple markers
+  vol.fromJSON({
+    '/quire-project/.eleventy.js': 'module.exports = function() {}',
+    '/quire-project/.quire': '',
+    '/quire-project/.quire-version': '1.0.0'
+  })
+
+  // Mock node:fs to use memfs
+  const detect = await esmock('./detect.js', {
+    'node:fs': fs
+  })
+
+  const result = detect('/quire-project')
+
+  t.truthy(result, 'should return truthy value for directory with multiple markers')
+  t.true(
+    ['.eleventy.js', '.quire', '.quire-11ty', '.quire-version', 'eleventy.config.js'].includes(result),
+    'should return one of the valid marker file names'
+  )
+})

package/src/lib/project/index.js

@@ -0,0 +1,40 @@
+/**
+ * Project module
+ *
+ * Provides project-level concerns including paths, detection, configuration,
+ * build status, and version management.
+ */
+import paths, { Paths } from './paths.js'
+import detect from './detect.js'
+import { loadProjectConfig } from './config.js'
+import {
+  getBuildInfo,
+  hasEpubOutput,
+  hasPdfOutput,
+  hasSiteOutput,
+  requireBuildOutput,
+} from './build.js'
+import {
+  getVersion,
+  setVersion,
+  getVersionsFromStarter,
+  readVersionFile,
+  writeVersionFile,
+} from './version.js'
+
+export {
+  detect,
+  getBuildInfo,
+  hasEpubOutput,
+  hasPdfOutput,
+  hasSiteOutput,
+  loadProjectConfig,
+  paths as default,
+  Paths,
+  requireBuildOutput,
+  getVersion,
+  setVersion,
+  getVersionsFromStarter,
+  readVersionFile,
+  writeVersionFile,
+}

package/src/lib/project/paths.js

@@ -0,0 +1,224 @@
+import { fileURLToPath } from 'node:url'
+import fs from 'fs-extra'
+import path from 'node:path'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+/**
+ * Project path configuration
+ *
+ * Provides accessor methods for project paths, computing values on access
+ * to ensure they reflect the current working directory state.
+ *
+ * Naming convention:
+ * - methods ending in `Path` or `Root` return absolute paths
+ * - methods ending in `Dir` return relative directory names
+ *
+ * @see https://www.11ty.dev/docs/config/#configuration-options
+ */
+class Paths {
+  /**
+   * @param {Object} options
+   * @param {string} [options.version='latest'] - quire-11ty version to use
+   */
+  constructor(options = {}) {
+    this.cliRoot = path.resolve(__dirname, '..')
+    this.eleventyConfig = '.eleventy.js'
+    this.version = options.version || 'latest'
+  }
+
+  // ─────────────────────────────────────────────────────────────────────────
+  // Implicit getters for domain-specific grouping of paths
+  // ─────────────────────────────────────────────────────────────────────────
+
+  /**
+   * Eleventy configuration paths
+   */
+  get eleventy() {
+    return {
+      config: this.getConfigPath(),
+      data: this.getDataDir(),
+      includes: this.getIncludesDir(),
+      input: this.getInputDir(),
+      layouts: this.getLayoutsDir(),
+      output: this.getOutputDir(),
+      root: this.getEleventyRoot(),
+    }
+  }
+
+  /**
+   * Output format-specific paths
+   */
+  get output() {
+    return {
+      site: this.getOutputDir(),
+      epub: this.getEpubDir(),
+      public: this.getPublicDir(),
+    }
+  }
+
+  /**
+   * Project root paths (general)
+   */
+  get project() {
+    return {
+      content: this.getInputPath(),
+      root: this.getProjectRoot(),
+    }
+  }
+
+  // ─────────────────────────────────────────────────────────────────────────
+  // Absolute paths (method names ends with Path or Root)
+  // ─────────────────────────────────────────────────────────────────────────
+
+  /**
+   * Get the absolute path to eleventy config module
+   * @returns {string} Absolute path to .eleventy.js
+   */
+  getConfigPath() {
+    return path.join(this.getEleventyRoot(), this.eleventyConfig)
+  }
+
+  /**
+   * Get the Eleventy root directory
+   *
+   * @todo refactor how and *when* the eleventyRoot is determined:
+   *  - we only need eleventyRoot for cli commands that run 11ty
+   *  - paths module is a concern of the `quire` module
+   *  - global quire-cli installation
+   *  - local quire-cli installation
+   *
+   * @returns {string} Absolute path to Eleventy root
+   */
+  getEleventyRoot() {
+    return this.getProjectRoot()
+  }
+
+  /**
+   * Get the absolute path to content input directory
+   * @returns {string} Absolute path to content directory
+   */
+  getInputPath() {
+    return path.join(this.getProjectRoot(), 'content')
+  }
+
+  /**
+   * Get the path to installed quire-11ty version
+   * @returns {string} Absolute path to quire-11ty installation
+   */
+  getLibQuirePath() {
+    return path.resolve(
+      __dirname,
+      path.join(this.cliRoot, 'lib', 'quire', 'versions', this.version)
+    )
+  }
+
+  /**
+   * Get the current project root directory
+   * @returns {string} Absolute path to project root
+   */
+  getProjectRoot() {
+    return process.cwd()
+  }
+
+  // ─────────────────────────────────────────────────────────────────────────
+  // Relative directory names (method names ends with Dir)
+  // ─────────────────────────────────────────────────────────────────────────
+
+  /**
+   * Get data directory relative to input
+   * @returns {string} Relative directory name for computed data
+   */
+  getDataDir() {
+    return '_computed'
+  }
+
+  /**
+   * Get epub output directory relative to eleventy config
+   * @returns {string} Relative directory name for epub output (_epub)
+   */
+  getEpubDir() {
+    return path.relative(
+      this.getEleventyRoot(),
+      path.join(this.getProjectRoot(), '_epub')
+    )
+  }
+
+  /**
+   * Get includes directory relative to input
+   * @returns {string} Relative directory name for _includes
+   */
+  getIncludesDir() {
+    return path.relative(
+      this.getInputPath(),
+      path.join(this.getEleventyRoot(), '_includes')
+    )
+  }
+
+  /**
+   * Get input directory relative to eleventy config
+   * @returns {string} Relative directory name for 11ty input
+   */
+  getInputDir() {
+    return path.relative(this.getEleventyRoot(), this.getInputPath())
+  }
+
+  /**
+   * Get layouts directory relative to input
+   * @returns {string} Relative directory name for _layouts
+   */
+  getLayoutsDir() {
+    return path.relative(
+      this.getInputPath(),
+      path.join(this.getEleventyRoot(), '_layouts')
+    )
+  }
+
+  /**
+   * Get output directory relative to eleventy config
+   * @returns {string} Relative directory name for 11ty output (_site)
+   */
+  getOutputDir() {
+    return path.relative(
+      this.getEleventyRoot(),
+      path.join(this.getProjectRoot(), '_site')
+    )
+  }
+
+  /**
+   * Get public assets directory
+   * @returns {string} Relative directory name for public assets
+   */
+  getPublicDir() {
+    return './public'
+  }
+
+  // ─────────────────────────────────────────────────────────────────────────
+  // Utility methods
+  // ─────────────────────────────────────────────────────────────────────────
+
+  /**
+   * Get all paths as an object (for backward compatibility and logging)
+   * @returns {Object} Object containing all path values
+   */
+  toObject() {
+    return {
+      config: this.getConfigPath(),
+      data: this.getDataDir(),
+      epub: this.getEpubDir(),
+      includes: this.getIncludesDir(),
+      input: this.getInputDir(),
+      layouts: this.getLayoutsDir(),
+      output: this.getOutputDir(),
+      public: this.getPublicDir(),
+    }
+  }
+}
+
+/**
+ * Default Paths instance
+ */
+const paths = new Paths()
+
+export { Paths, paths as default }

package/src/lib/project/version.js

@@ -0,0 +1,110 @@
+/**
+ * Project version module
+ *
+ * Manages quire-11ty version files in Quire projects.
+ *
+ * @module lib/project/version
+ */
+import fs from 'fs-extra'
+import path from 'node:path'
+import config from '#lib/conf/config.js'
+import paths from './paths.js'
+
+const PACKAGE_NAME = '@thegetty/quire-11ty'
+const VERSION_FILE = config.get('versionFile')
+
+/**
+ * Read the required quire-11ty version from the project version file
+ *
+ * @param {string} [projectPath] - Absolute system path to the project root
+ * @returns {string} Quire-11ty semantic version
+ */
+export function getVersion(projectPath) {
+  projectPath = projectPath || paths.getProjectRoot()
+  const version = fs.readFileSync(path.join(projectPath, VERSION_FILE), { encoding: 'utf8' })
+  const projectName = path.basename(projectPath)
+  console.debug(`${projectName} set to use quire-11ty@${version}`)
+  return version
+}
+
+/**
+ * Sets the quire-11ty version for a project
+ *
+ * Updates the version file with the new quire-11ty version while
+ * preserving other metadata (cli version, starter info).
+ *
+ * @param {string} version - A version identifier or distribution tag
+ * @param {string} [projectPath] - Absolute path to project root (defaults to cwd)
+ */
+export function setVersion(version, projectPath) {
+  projectPath = projectPath || paths.getProjectRoot()
+  const projectName = path.basename(projectPath)
+  const versionFilePath = path.join(projectPath, VERSION_FILE)
+
+  // Read existing version info or create new
+  let versionInfo = {}
+  if (fs.existsSync(versionFilePath)) {
+    const content = fs.readFileSync(versionFilePath, { encoding: 'utf8' })
+    try {
+      versionInfo = JSON.parse(content)
+    } catch {
+      // Legacy format or invalid JSON, start fresh
+      versionInfo = {}
+    }
+  }
+
+  // Update the quire-11ty version
+  versionInfo.quire11ty = version
+
+  // Write updated version info
+  fs.writeFileSync(versionFilePath, JSON.stringify(versionInfo, null, 2))
+  console.info(`${projectName} set to use quire-11ty@${version}`)
+}
+
+/**
+ * Read required quire-11ty and starter versions from starter peerDependencies
+ *
+ * @param {string} projectPath - Absolute system path to the project root
+ * @returns {Promise<Object>}
+ * @property {string} quire11tyVersion - Latest compatible Quire-11ty semantic version
+ * @property {string} starterVersion - Starter project version from package.json
+ */
+export 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 }
+}
+
+/**
+ * Write version info to the project version file
+ *
+ * @param {string} projectPath - Absolute system path to the project root
+ * @param {Object} versionInfo - Version information to write
+ */
+export function writeVersionFile(projectPath, versionInfo) {
+  fs.writeFileSync(path.join(projectPath, VERSION_FILE), JSON.stringify(versionInfo))
+}
+
+/**
+ * Read version info from the project version file
+ *
+ * @param {string} projectPath - Absolute system path to the project root
+ * @returns {Object|null} Parsed version info or null if file doesn't exist
+ */
+export function readVersionFile(projectPath) {
+  const versionFilePath = path.join(projectPath, VERSION_FILE)
+  if (!fs.existsSync(versionFilePath)) {
+    return null
+  }
+  const content = fs.readFileSync(versionFilePath, { encoding: 'utf8' })
+  try {
+    return JSON.parse(content)
+  } catch {
+    // Legacy format: plain version string
+    return { version: content.trim() }
+  }
+}