@thegetty/quire-cli 1.0.0-rc.37 → 1.0.0-rc.39

package/src/lib/conf/build-status.test.js

@@ -0,0 +1,247 @@
+import esmock from 'esmock'
+import sinon from 'sinon'
+import test from 'ava'
+
+/**
+ * Build Status Module Tests
+ *
+ * Tests the per-project build status persistence API.
+ * Mocks the config module with a simple in-memory store.
+ */
+
+test.beforeEach(async (t) => {
+  const sandbox = sinon.createSandbox()
+
+  // In-memory store that mimics config.get/set for 'projects'
+  const store = {}
+  const configMock = {
+    default: {
+      get: sandbox.stub().callsFake((key) => store[key]),
+      set: sandbox.stub().callsFake((key, value) => { store[key] = value }),
+    },
+  }
+
+  const mod = await esmock('./build-status.js', {
+    '#lib/conf/config.js': configMock,
+  })
+
+  t.context = { sandbox, store, configMock, ...mod }
+})
+
+test.afterEach.always((t) => {
+  t.context.sandbox.restore()
+})
+
+// ─────────────────────────────────────────────────────────────────────────────
+// projectKey
+// ─────────────────────────────────────────────────────────────────────────────
+
+test('projectKey returns a 12-character hex string', (t) => {
+  const { projectKey } = t.context
+  const key = projectKey('/Users/test/my-project')
+  t.is(key.length, 12)
+  t.regex(key, /^[0-9a-f]{12}$/)
+})
+
+test('projectKey returns the same key for the same path', (t) => {
+  const { projectKey } = t.context
+  const key1 = projectKey('/Users/test/my-project')
+  const key2 = projectKey('/Users/test/my-project')
+  t.is(key1, key2)
+})
+
+test('projectKey returns different keys for different paths', (t) => {
+  const { projectKey } = t.context
+  const key1 = projectKey('/Users/test/project-a')
+  const key2 = projectKey('/Users/test/project-b')
+  t.not(key1, key2)
+})
+
+// ─────────────────────────────────────────────────────────────────────────────
+// recordStatus
+// ─────────────────────────────────────────────────────────────────────────────
+
+test('recordStatus writes status with timestamp to config', (t) => {
+  const { recordStatus, projectKey, configMock } = t.context
+  const projectPath = '/Users/test/my-project'
+
+  recordStatus(projectPath, 'build', 'ok')
+
+  t.true(configMock.default.set.calledOnce)
+  const [setKey, setValue] = configMock.default.set.firstCall.args
+  t.is(setKey, 'projects')
+
+  const key = projectKey(projectPath)
+  const entry = setValue[key]
+  t.is(entry.projectPath, projectPath)
+  t.is(entry.buildStatus.build.status, 'ok')
+  t.is(typeof entry.buildStatus.build.timestamp, 'number')
+})
+
+test('recordStatus records failed status', (t) => {
+  const { recordStatus, projectKey, configMock } = t.context
+  const projectPath = '/Users/test/my-project'
+
+  recordStatus(projectPath, 'pdf', 'failed')
+
+  const [, setValue] = configMock.default.set.firstCall.args
+  const key = projectKey(projectPath)
+  t.is(setValue[key].buildStatus.pdf.status, 'failed')
+})
+
+test('recordStatus silently ignores untracked commands', (t) => {
+  const { recordStatus, configMock } = t.context
+
+  recordStatus('/Users/test/my-project', 'preview', 'ok')
+
+  t.false(configMock.default.set.called)
+})
+
+test('recordStatus preserves existing command entries', (t) => {
+  const { recordStatus, projectKey, store } = t.context
+  const projectPath = '/Users/test/my-project'
+  const key = projectKey(projectPath)
+
+  // Pre-populate with a build entry
+  store.projects = {
+    [key]: {
+      projectPath,
+      buildStatus: {
+        build: { status: 'ok', timestamp: 1000 },
+      },
+    },
+  }
+
+  recordStatus(projectPath, 'pdf', 'failed')
+
+  const entry = store.projects[key]
+  t.is(entry.buildStatus.build.status, 'ok')
+  t.is(entry.buildStatus.build.timestamp, 1000)
+  t.is(entry.buildStatus.pdf.status, 'failed')
+})
+
+// ─────────────────────────────────────────────────────────────────────────────
+// getStatus
+// ─────────────────────────────────────────────────────────────────────────────
+
+test('getStatus returns stored status entry', (t) => {
+  const { getStatus, projectKey, store } = t.context
+  const projectPath = '/Users/test/my-project'
+  const key = projectKey(projectPath)
+
+  store.projects = {
+    [key]: {
+      projectPath,
+      buildStatus: {
+        build: { status: 'ok', timestamp: 1000 },
+      },
+    },
+  }
+
+  const result = getStatus(projectPath, 'build')
+  t.deepEqual(result, { status: 'ok', timestamp: 1000 })
+})
+
+test('getStatus returns undefined for unknown project', (t) => {
+  const { getStatus } = t.context
+
+  const result = getStatus('/Users/test/unknown-project', 'build')
+  t.is(result, undefined)
+})
+
+test('getStatus returns undefined for unrecorded command', (t) => {
+  const { getStatus, projectKey, store } = t.context
+  const projectPath = '/Users/test/my-project'
+  const key = projectKey(projectPath)
+
+  store.projects = {
+    [key]: {
+      projectPath,
+      buildStatus: {
+        build: { status: 'ok', timestamp: 1000 },
+      },
+    },
+  }
+
+  const result = getStatus(projectPath, 'epub')
+  t.is(result, undefined)
+})
+
+// ─────────────────────────────────────────────────────────────────────────────
+// clearStatus
+// ─────────────────────────────────────────────────────────────────────────────
+
+test('clearStatus removes project entry', (t) => {
+  const { clearStatus, projectKey, store, configMock } = t.context
+  const projectPath = '/Users/test/my-project'
+  const key = projectKey(projectPath)
+
+  store.projects = {
+    [key]: {
+      projectPath,
+      buildStatus: {
+        build: { status: 'ok', timestamp: 1000 },
+      },
+    },
+  }
+
+  clearStatus(projectPath)
+
+  const [, setValue] = configMock.default.set.firstCall.args
+  t.truthy(setValue[key], 'project entry should still exist')
+  t.is(setValue[key].projectPath, projectPath, 'projectPath should be preserved')
+  t.is(setValue[key].buildStatus, undefined, 'buildStatus should be removed')
+})
+
+test('clearStatus is a no-op for unknown project', (t) => {
+  const { clearStatus, configMock, store } = t.context
+
+  store.projects = {}
+  clearStatus('/Users/test/unknown-project')
+
+  t.false(configMock.default.set.called)
+})
+
+test('clearStatus is a no-op when project has no buildStatus', (t) => {
+  const { clearStatus, projectKey, configMock, store } = t.context
+  const projectPath = '/Users/test/my-project'
+  const key = projectKey(projectPath)
+
+  store.projects = {
+    [key]: { projectPath },
+  }
+
+  clearStatus(projectPath)
+
+  t.false(configMock.default.set.called)
+})
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Multiple projects
+// ─────────────────────────────────────────────────────────────────────────────
+
+test('multiple projects are tracked independently', (t) => {
+  const { recordStatus, getStatus } = t.context
+  const projectA = '/Users/test/project-a'
+  const projectB = '/Users/test/project-b'
+
+  recordStatus(projectA, 'build', 'ok')
+  recordStatus(projectB, 'build', 'failed')
+
+  t.is(getStatus(projectA, 'build').status, 'ok')
+  t.is(getStatus(projectB, 'build').status, 'failed')
+})
+
+// ─────────────────────────────────────────────────────────────────────────────
+// TRACKED_COMMANDS
+// ─────────────────────────────────────────────────────────────────────────────
+
+test('TRACKED_COMMANDS contains build, pdf, and epub', (t) => {
+  const { TRACKED_COMMANDS } = t.context
+  t.deepEqual([...TRACKED_COMMANDS], ['build', 'pdf', 'epub'])
+})
+
+test('TRACKED_COMMANDS is frozen', (t) => {
+  const { TRACKED_COMMANDS } = t.context
+  t.true(Object.isFrozen(TRACKED_COMMANDS))
+})

package/src/lib/conf/defaults.js

@@ -56,6 +56,15 @@ export default {
    * Relative path to quire-11ty installed in the project directory.
    */
   quire11tyPath: '.',
+  /**
+   * How stale an output must be before `quire doctor` warns.
+   * - 'ZERO': any time difference (0 minutes)
+   * - 'SHORT': 5 minutes
+   * - 'HOURLY': 60 minutes (default)
+   * - 'DAILY': 12 hours
+   * - 'NEVER': disable stale output warnings
+   */
+  staleThreshold: 'HOURLY',
   /**
    * Version of quire-11ty to install when creating new projects.
    */
@@ -78,4 +87,9 @@ export default {
    * File name for the quire-11ty version file.
    */
   versionFile: '.quire',
+  /**
+   * Per-project data (internal).
+   * Keyed by SHA-256 hash of the project's absolute path.
+   */
+  projects: {},
 }

package/src/lib/conf/format.js

@@ -45,7 +45,7 @@ export function formatSettings(store, { configPath, showInternal = false, useCol
   lines.push('')
 
   for (const [key, value] of Object.entries(store)) {
-    if (key.startsWith('__internal__') && !showInternal) continue
+    if ((key.startsWith('__internal__') || key === 'projects') && !showInternal) continue
     const description = getKeyDescription(key)
     lines.push(`  ${style.cyan(key)}: ${JSON.stringify(value)}`)
     if (description) {

package/src/lib/conf/schema.js

@@ -50,6 +50,11 @@ export default {
     type: 'string',
     description: 'Path to the quire-11ty package (use "." for local development)'
   },
+  staleThreshold: {
+    type: 'string',
+    enum: ['ZERO', 'SHORT', 'HOURLY', 'DAILY', 'NEVER'],
+    description: 'How stale an output must be before doctor warns (ZERO=0m, SHORT=5m, HOURLY=60m, DAILY=12h, NEVER=disabled)'
+  },
   quireVersion: {
     type: 'string',
     description: 'Version of quire-11ty to use ("latest" or specific version)'
@@ -71,5 +76,45 @@ export default {
   versionFile: {
     type: 'string',
     description: 'Filename used to identify Quire projects'
-  }
+  },
+  projects: {
+    type: 'object',
+    description: 'Per-project data keyed by hashed project path (internal)',
+    additionalProperties: {
+      type: 'object',
+      properties: {
+        projectPath: { type: 'string' },
+        buildStatus: {
+          type: 'object',
+          properties: {
+            build: {
+              type: 'object',
+              properties: {
+                status: { type: 'string', enum: ['ok', 'failed'] },
+                timestamp: { type: 'number' },
+              },
+              required: ['status', 'timestamp'],
+            },
+            pdf: {
+              type: 'object',
+              properties: {
+                status: { type: 'string', enum: ['ok', 'failed'] },
+                timestamp: { type: 'number' },
+              },
+              required: ['status', 'timestamp'],
+            },
+            epub: {
+              type: 'object',
+              properties: {
+                status: { type: 'string', enum: ['ok', 'failed'] },
+                timestamp: { type: 'number' },
+              },
+              required: ['status', 'timestamp'],
+            },
+          },
+        },
+      },
+      required: ['projectPath'],
+    },
+  },
 }

package/src/lib/constants.js

@@ -0,0 +1,28 @@
+/**
+ * Shared CLI constants
+ *
+ * Centralized constants used across the CLI to avoid duplication
+ * and ensure consistency.
+ *
+ * @module lib/constants
+ */
+
+/**
+ * Base URL for Quire documentation (without trailing slash)
+ *
+ * Use with URL constructor for path joining:
+ * @example
+ * new URL('install-uninstall/', DOCS_BASE_URL).href
+ * // => 'https://quire.getty.edu/docs-v1/install-uninstall/'
+ */
+export const DOCS_BASE_URL = 'https://quire.getty.edu/docs-v1'
+
+/**
+ * Package name for quire-11ty
+ */
+export const QUIRE_11TY_PACKAGE = '@thegetty/quire-11ty'
+
+/**
+ * Minimum required Node.js major version
+ */
+export const REQUIRED_NODE_VERSION = 22