@thegetty/quire-cli 1.0.0-rc.44 → 1.0.0-rc.46

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

@@ -1,157 +0,0 @@
-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

@@ -1,56 +0,0 @@
-/**
- * Project module
- *
- * Provides project-level concerns including paths, detection, configuration,
- * build status, and version management.
- */
-import paths, { DATA_DIR, Paths, REQUIRED_DATA_FILES, SOURCE_DIRECTORIES } from './paths.js'
-import detect, { PROJECT_MARKERS } from './detect.js'
-import { loadProjectConfig } from './config.js'
-import {
-  getBuildInfo,
-  hasEpubOutput,
-  hasPdfOutput,
-  hasSiteOutput,
-  requireBuildOutput,
-} from './build.js'
-import {
-  getPdfOutputPaths,
-  getEpubOutputPaths,
-  getEpubBuildDir,
-  PDF_ENGINES,
-  EPUB_ENGINES,
-} from './output-paths.js'
-import {
-  getVersion,
-  setVersion,
-  getVersionsFromStarter,
-  readVersionFile,
-  writeVersionFile,
-} from './version.js'
-
-export {
-  DATA_DIR,
-  EPUB_ENGINES,
-  PDF_ENGINES,
-  PROJECT_MARKERS,
-  REQUIRED_DATA_FILES,
-  SOURCE_DIRECTORIES,
-  detect,
-  getBuildInfo,
-  getEpubBuildDir,
-  getEpubOutputPaths,
-  getPdfOutputPaths,
-  hasEpubOutput,
-  hasPdfOutput,
-  hasSiteOutput,
-  loadProjectConfig,
-  paths as default,
-  Paths,
-  requireBuildOutput,
-  getVersion,
-  setVersion,
-  getVersionsFromStarter,
-  readVersionFile,
-  writeVersionFile,
-}

package/src/lib/project/output-paths.js

@@ -1,87 +0,0 @@
-/**
- * Output path resolution module
- *
- * Centralizes knowledge of where PDF and EPUB output files are located.
- * Used by the doctor command and build detection to find output artifacts
- * using the same logic as the generation commands.
- *
- * @module lib/project/output-paths
- */
-import path from 'node:path'
-import { ENGINES as PDF_ENGINES } from '#lib/pdf/schema.js'
-import { ENGINES as EPUB_ENGINES } from '#lib/epub/schema.js'
-
-export { PDF_ENGINES, EPUB_ENGINES }
-
-/**
- * Get all possible PDF output file paths for a project
- *
- * PDF output paths depend on configuration:
- * - With config.pdf: `{outputDir}/{config.pdf.outputDir}/{config.pdf.filename}.pdf`
- * - Without config (default): `{projectRoot}/{engine}.pdf`
- *
- * This reuses the same resolution logic as `lib/pdf/index.js#getOutputPath`.
- *
- * @param {Object} [options]
- * @param {string} [options.projectRoot=process.cwd()] - Project root directory
- * @param {string} [options.outputDir='_site'] - Build output directory (relative)
- * @param {Object} [options.pdfConfig] - PDF config from config.yaml (config.pdf)
- * @param {string} [options.pdfConfig.outputDir] - PDF output subdirectory
- * @param {string} [options.pdfConfig.filename] - PDF filename (without extension)
- * @returns {string[]} Array of absolute paths to check for PDF output
- */
-export function getPdfOutputPaths(options = {}) {
-  const {
-    projectRoot = process.cwd(),
-    outputDir = '_site',
-    pdfConfig,
-  } = options
-
-  const paths = []
-
-  if (pdfConfig && pdfConfig.outputDir && pdfConfig.filename) {
-    // Config-aware path: matches lib/pdf/index.js getOutputPath()
-    paths.push(
-      path.join(projectRoot, outputDir, pdfConfig.outputDir, `${pdfConfig.filename}.pdf`)
-    )
-  }
-
-  // Default engine-named paths (always check these as fallback)
-  for (const engine of PDF_ENGINES) {
-    paths.push(path.join(projectRoot, `${engine}.pdf`))
-  }
-
-  return paths
-}
-
-/**
- * Get all possible EPUB output file paths for a project
- *
- * EPUB output is at `{projectRoot}/{engine}.epub` for each supported engine.
- * The `_epub` directory is an intermediate build artifact, not the final output.
- *
- * This reuses the same resolution logic as `commands/epub.js`.
- *
- * @param {Object} [options]
- * @param {string} [options.projectRoot=process.cwd()] - Project root directory
- * @returns {string[]} Array of absolute paths to check for EPUB output
- */
-export function getEpubOutputPaths(options = {}) {
-  const { projectRoot = process.cwd() } = options
-
-  return EPUB_ENGINES.map(
-    (engine) => path.join(projectRoot, `${engine}.epub`)
-  )
-}
-
-/**
- * Get the intermediate EPUB build directory path
- *
- * @param {Object} [options]
- * @param {string} [options.projectRoot=process.cwd()] - Project root directory
- * @returns {string} Absolute path to _epub directory
- */
-export function getEpubBuildDir(options = {}) {
-  const { projectRoot = process.cwd() } = options
-  return path.join(projectRoot, '_epub')
-}

package/src/lib/project/output-paths.test.js

@@ -1,66 +0,0 @@
-import test from 'ava'
-import path from 'node:path'
-import { getPdfOutputPaths, getEpubOutputPaths, getEpubBuildDir } from './output-paths.js'
-
-const projectRoot = '/test-project'
-
-test('getPdfOutputPaths returns default engine paths', (t) => {
-  const paths = getPdfOutputPaths({ projectRoot })
-
-  t.true(paths.includes(path.join(projectRoot, 'pagedjs.pdf')))
-  t.true(paths.includes(path.join(projectRoot, 'prince.pdf')))
-})
-
-test('getPdfOutputPaths includes config-aware path when pdfConfig provided', (t) => {
-  const pdfConfig = { outputDir: 'pdf', filename: 'my-publication' }
-  const paths = getPdfOutputPaths({ projectRoot, outputDir: '_site', pdfConfig })
-
-  // Config path should be first
-  t.is(paths[0], path.join(projectRoot, '_site', 'pdf', 'my-publication.pdf'))
-  // Default paths should still be present
-  t.true(paths.includes(path.join(projectRoot, 'pagedjs.pdf')))
-  t.true(paths.includes(path.join(projectRoot, 'prince.pdf')))
-})
-
-test('getPdfOutputPaths skips config path when pdfConfig is incomplete', (t) => {
-  // Missing filename
-  const paths = getPdfOutputPaths({ projectRoot, pdfConfig: { outputDir: 'pdf' } })
-
-  // Should only have default engine paths
-  t.is(paths.length, 2)
-  t.true(paths.includes(path.join(projectRoot, 'pagedjs.pdf')))
-  t.true(paths.includes(path.join(projectRoot, 'prince.pdf')))
-})
-
-test('getPdfOutputPaths uses cwd when no projectRoot provided', (t) => {
-  const paths = getPdfOutputPaths()
-
-  t.true(paths.includes(path.join(process.cwd(), 'pagedjs.pdf')))
-  t.true(paths.includes(path.join(process.cwd(), 'prince.pdf')))
-})
-
-test('getEpubOutputPaths returns default engine paths', (t) => {
-  const paths = getEpubOutputPaths({ projectRoot })
-
-  t.true(paths.includes(path.join(projectRoot, 'epubjs.epub')))
-  t.true(paths.includes(path.join(projectRoot, 'pandoc.epub')))
-})
-
-test('getEpubOutputPaths uses cwd when no projectRoot provided', (t) => {
-  const paths = getEpubOutputPaths()
-
-  t.true(paths.includes(path.join(process.cwd(), 'epubjs.epub')))
-  t.true(paths.includes(path.join(process.cwd(), 'pandoc.epub')))
-})
-
-test('getEpubBuildDir returns _epub path', (t) => {
-  const dir = getEpubBuildDir({ projectRoot })
-
-  t.is(dir, path.join(projectRoot, '_epub'))
-})
-
-test('getEpubBuildDir uses cwd when no projectRoot provided', (t) => {
-  const dir = getEpubBuildDir()
-
-  t.is(dir, path.join(process.cwd(), '_epub'))
-})

package/src/lib/project/paths.js

@@ -1,272 +0,0 @@
-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)
-
-/**
- * Source directories that contain content for building.
- *
- * These directories are monitored for changes during preview and are used
- * to determine if a build is stale. Changes to files in these directories
- * indicate the site needs to be rebuilt.
- *
- * @constant {ReadonlyArray<string>}
- *
- * @example
- * // Check all source directories for changes
- * for (const dir of SOURCE_DIRECTORIES) {
- *   const mtime = getLatestMtime(dir)
- *   // ...
- * }
- */
-export const SOURCE_DIRECTORIES = Object.freeze([
-  '_data',
-  '_includes',
-  '_layouts',
-  'content',
-  'static',
-])
-
-/**
- * Path to data files directory (relative to project root)
- *
- * Contains YAML configuration files for the publication:
- * - publication.yaml - Publication metadata
- * - config.yaml - Site configuration
- * - figures.yaml - Figure definitions
- * - objects.yaml - Object catalog entries
- * - references.yaml - Bibliography entries
- *
- * @constant {string}
- */
-export const DATA_DIR = 'content/_data'
-
-/**
- * Required data files that must exist in a Quire project.
- *
- * These files are validated by the doctor command and the validate command.
- * Missing required files will trigger a warning.
- *
- * @constant {ReadonlyArray<string>}
- */
-export const REQUIRED_DATA_FILES = Object.freeze(['publication.yaml'])
-
-/**
- * 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 }