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

package/src/lib/doctor/checks/outputs/stale-build.test.js

@@ -1,282 +0,0 @@
-import test from 'ava'
-import sinon from 'sinon'
-import esmock from 'esmock'
-import path from 'node:path'
-
-const TWO_MINUTES = 120000
-const TEN_MINUTES = 600000
-const ONE_HOUR = 3600000
-const TWO_HOURS = 7200000
-
-const configMock = { default: { get: () => 'HOURLY' } }
-const buildStatusMock = { getStatus: () => undefined }
-
-test.beforeEach((t) => {
-  t.context.sandbox = sinon.createSandbox()
-})
-
-test.afterEach.always((t) => {
-  t.context.sandbox.restore()
-})
-
-test('checkStaleBuild returns N/A when no _site directory exists', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkStaleBuild } = await esmock('./stale-build.js', {
-    'node:fs': {
-      existsSync: sandbox.stub().returns(false),
-    },
-    '#lib/conf/config.js': configMock,
-    '#lib/conf/build-status.js': buildStatusMock,
-  })
-
-  const result = checkStaleBuild()
-
-  t.true(result.ok)
-  t.is(result.level, 'na', 'should return N/A level when no build output')
-  t.regex(result.message, /No build output found/)
-  t.truthy(result.remediation)
-  t.regex(result.remediation, /quire build/)
-  t.regex(result.remediation, /failed/)
-  t.truthy(result.docsUrl)
-})
-
-test('checkStaleBuild returns failure when last build failed and no _site exists', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkStaleBuild } = await esmock('./stale-build.js', {
-    'node:fs': {
-      existsSync: sandbox.stub().returns(false),
-    },
-    '#lib/conf/config.js': configMock,
-    '#lib/conf/build-status.js': {
-      getStatus: () => ({ status: 'failed', timestamp: Date.now() }),
-    },
-  })
-
-  const result = checkStaleBuild()
-
-  t.false(result.ok)
-  t.is(result.level, undefined)
-  t.regex(result.message, /Last build failed/)
-  t.truthy(result.remediation)
-  t.regex(result.remediation, /quire build --debug/)
-  t.truthy(result.docsUrl)
-})
-
-test('checkStaleBuild returns ok when build is up to date', async (t) => {
-  const { sandbox } = t.context
-
-  const now = Date.now()
-  const existsSync = sandbox.stub()
-  existsSync.withArgs('_site').returns(true)
-  existsSync.returns(false) // source directories don't exist
-
-  const { checkStaleBuild } = await esmock('./stale-build.js', {
-    'node:fs': {
-      existsSync,
-      statSync: sandbox.stub().returns({ mtimeMs: now }),
-      readdirSync: sandbox.stub().returns([]),
-    },
-    '#lib/project/index.js': {
-      SOURCE_DIRECTORIES: ['content'],
-    },
-    '#lib/conf/config.js': configMock,
-  })
-
-  const result = checkStaleBuild()
-
-  t.true(result.ok)
-  t.regex(result.message, /up to date/)
-})
-
-test('checkStaleBuild returns warning when source is newer than build beyond threshold', async (t) => {
-  const { sandbox } = t.context
-
-  const buildTime = Date.now() - TWO_HOURS
-  const sourceTime = Date.now()
-
-  const existsSync = sandbox.stub()
-  existsSync.withArgs('_site').returns(true)
-  existsSync.withArgs('content').returns(true)
-  existsSync.returns(false)
-
-  // Use path.join for cross-platform compatibility
-  const filePath = path.join('content', 'file.md')
-  const statSync = sandbox.stub()
-  statSync.withArgs('_site').returns({ mtimeMs: buildTime })
-  statSync.withArgs(filePath).returns({ mtimeMs: sourceTime })
-
-  const { checkStaleBuild } = await esmock('./stale-build.js', {
-    'node:fs': {
-      existsSync,
-      statSync,
-      readdirSync: sandbox.stub().returns([
-        { name: 'file.md', isDirectory: () => false },
-      ]),
-    },
-    '#lib/project/index.js': {
-      SOURCE_DIRECTORIES: ['content'],
-    },
-    '#lib/conf/config.js': configMock,
-  })
-
-  const result = checkStaleBuild()
-
-  t.false(result.ok)
-  t.is(result.level, 'warn')
-  t.regex(result.message, /older than source files/)
-  t.truthy(result.remediation)
-  t.truthy(result.docsUrl)
-})
-
-test('checkStaleBuild returns ok when source is newer but within threshold', async (t) => {
-  const { sandbox } = t.context
-
-  const buildTime = Date.now() - TEN_MINUTES
-  const sourceTime = Date.now()
-
-  const existsSync = sandbox.stub()
-  existsSync.withArgs('_site').returns(true)
-  existsSync.withArgs('content').returns(true)
-  existsSync.returns(false)
-
-  const filePath = path.join('content', 'file.md')
-  const statSync = sandbox.stub()
-  statSync.withArgs('_site').returns({ mtimeMs: buildTime })
-  statSync.withArgs(filePath).returns({ mtimeMs: sourceTime })
-
-  const { checkStaleBuild } = await esmock('./stale-build.js', {
-    'node:fs': {
-      existsSync,
-      statSync,
-      readdirSync: sandbox.stub().returns([
-        { name: 'file.md', isDirectory: () => false },
-      ]),
-    },
-    '#lib/project/index.js': {
-      SOURCE_DIRECTORIES: ['content'],
-    },
-    '#lib/conf/config.js': configMock,
-  })
-
-  const result = checkStaleBuild()
-
-  t.true(result.ok)
-  t.regex(result.message, /up to date/)
-})
-
-test('checkStaleBuild respects ZERO threshold setting', async (t) => {
-  const { sandbox } = t.context
-
-  const buildTime = Date.now() - TWO_MINUTES
-  const sourceTime = Date.now()
-
-  const existsSync = sandbox.stub()
-  existsSync.withArgs('_site').returns(true)
-  existsSync.withArgs('content').returns(true)
-  existsSync.returns(false)
-
-  const filePath = path.join('content', 'file.md')
-  const statSync = sandbox.stub()
-  statSync.withArgs('_site').returns({ mtimeMs: buildTime })
-  statSync.withArgs(filePath).returns({ mtimeMs: sourceTime })
-
-  // ZERO = 0ms threshold — any difference triggers warning
-  const { checkStaleBuild } = await esmock('./stale-build.js', {
-    'node:fs': {
-      existsSync,
-      statSync,
-      readdirSync: sandbox.stub().returns([
-        { name: 'file.md', isDirectory: () => false },
-      ]),
-    },
-    '#lib/project/index.js': {
-      SOURCE_DIRECTORIES: ['content'],
-    },
-    '#lib/conf/config.js': {
-      default: { get: () => 'ZERO' },
-    },
-  })
-
-  const result = checkStaleBuild()
-
-  t.false(result.ok)
-  t.is(result.level, 'warn')
-})
-
-test('checkStaleBuild NEVER threshold disables stale warnings', async (t) => {
-  const { sandbox } = t.context
-
-  const buildTime = Date.now() - ONE_HOUR
-  const sourceTime = Date.now()
-
-  const existsSync = sandbox.stub()
-  existsSync.withArgs('_site').returns(true)
-  existsSync.withArgs('content').returns(true)
-  existsSync.returns(false)
-
-  const filePath = path.join('content', 'file.md')
-  const statSync = sandbox.stub()
-  statSync.withArgs('_site').returns({ mtimeMs: buildTime })
-  statSync.withArgs(filePath).returns({ mtimeMs: sourceTime })
-
-  const { checkStaleBuild } = await esmock('./stale-build.js', {
-    'node:fs': {
-      existsSync,
-      statSync,
-      readdirSync: sandbox.stub().returns([
-        { name: 'file.md', isDirectory: () => false },
-      ]),
-    },
-    '#lib/project/index.js': {
-      SOURCE_DIRECTORIES: ['content'],
-    },
-    '#lib/conf/config.js': {
-      default: { get: () => 'NEVER' },
-    },
-  })
-
-  const result = checkStaleBuild()
-
-  t.true(result.ok)
-  t.regex(result.message, /up to date/)
-})
-
-test('checkStaleBuild includes remediation with build commands', async (t) => {
-  const { sandbox } = t.context
-
-  const buildTime = Date.now() - TWO_HOURS
-  const sourceTime = Date.now()
-
-  const existsSync = sandbox.stub()
-  existsSync.withArgs('_site').returns(true)
-  existsSync.withArgs('content').returns(true)
-  existsSync.returns(false)
-
-  // Use path.join for cross-platform compatibility
-  const filePath = path.join('content', 'page.md')
-  const statSync = sandbox.stub()
-  statSync.withArgs('_site').returns({ mtimeMs: buildTime })
-  statSync.withArgs(filePath).returns({ mtimeMs: sourceTime })
-
-  const { checkStaleBuild } = await esmock('./stale-build.js', {
-    'node:fs': {
-      existsSync,
-      statSync,
-      readdirSync: sandbox.stub().returns([
-        { name: 'page.md', isDirectory: () => false },
-      ]),
-    },
-    '#lib/project/index.js': {
-      SOURCE_DIRECTORIES: ['content'],
-    },
-    '#lib/conf/config.js': configMock,
-  })
-
-  const result = checkStaleBuild()
-
-  t.false(result.ok)
-  t.regex(result.remediation, /quire build/)
-  t.regex(result.remediation, /quire preview/)
-})

package/src/lib/doctor/checks/project/data-files.js

@@ -1,56 +0,0 @@
-/**
- * Data files validation check
- *
- * @module lib/doctor/checks/project/data-files
- */
-import { DATA_DIR } from '#lib/project/index.js'
-import { validateDataFiles } from '#src/validators/validate-data-files.js'
-import createDebug from '#debug'
-import { DOCS_BASE_URL } from '#lib/doctor/constants.js'
-
-const debug = createDebug('lib:doctor:data-files')
-
-/**
- * Check data files in content/_data/ for YAML syntax and schema validation
- *
- * Validates:
- * - Required files exist (publication.yaml)
- * - YAML syntax is correct
- * - Files conform to their JSON schemas (when schema exists)
- * - No duplicate IDs in arrays
- *
- * @returns {import('../../index.js').CheckResult}
- */
-export function checkDataFiles() {
-  const result = validateDataFiles()
-
-  // Not in a project directory
-  if (result.notInProject) {
-    debug('No %s directory found, skipping data files check', DATA_DIR)
-    return {
-      ok: true,
-      level: 'na',
-      message: `No ${DATA_DIR} directory (not in project)`,
-    }
-  }
-
-  debug('Found %d YAML files in %s', result.fileCount, DATA_DIR)
-
-  if (!result.valid) {
-    const issueCount = result.errors.length === 1 ? '1 issue' : `${result.errors.length} issues`
-    return {
-      ok: false,
-      level: 'warn',
-      message: `${issueCount} in data files`,
-      remediation: `Fix the following issues in ${DATA_DIR}:\n    • ${result.errors.join('\n    • ')}`,
-      docsUrl: `${DOCS_BASE_URL}/metadata-configuration/`,
-    }
-  }
-
-  return {
-    ok: true,
-    message: `${result.fileCount} files validated`,
-  }
-}
-
-export default checkDataFiles

package/src/lib/doctor/checks/project/data-files.test.js

@@ -1,125 +0,0 @@
-import test from 'ava'
-import sinon from 'sinon'
-import esmock from 'esmock'
-
-test.beforeEach((t) => {
-  t.context.sandbox = sinon.createSandbox()
-})
-
-test.afterEach.always((t) => {
-  t.context.sandbox.restore()
-})
-
-test('checkDataFiles returns N/A when no data directory exists', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkDataFiles } = await esmock('./data-files.js', {
-    '#src/validators/validate-data-files.js': {
-      validateDataFiles: sandbox.stub().returns({
-        valid: true,
-        errors: [],
-        fileCount: 0,
-        files: [],
-        notInProject: true,
-      }),
-    },
-  })
-
-  const result = checkDataFiles()
-
-  t.true(result.ok)
-  t.is(result.level, 'na')
-  t.regex(result.message, /No content\/_data directory/)
-})
-
-test('checkDataFiles returns ok when all YAML files are valid', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkDataFiles } = await esmock('./data-files.js', {
-    '#src/validators/validate-data-files.js': {
-      validateDataFiles: sandbox.stub().returns({
-        valid: true,
-        errors: [],
-        fileCount: 1,
-        files: [{ file: 'publication.yaml', valid: true, errors: [] }],
-      }),
-    },
-  })
-
-  const result = checkDataFiles()
-
-  t.true(result.ok)
-  t.regex(result.message, /1 files validated/)
-})
-
-test('checkDataFiles returns warning when required file is missing', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkDataFiles } = await esmock('./data-files.js', {
-    '#src/validators/validate-data-files.js': {
-      validateDataFiles: sandbox.stub().returns({
-        valid: false,
-        errors: ['Required file missing: publication.yaml'],
-        fileCount: 0,
-        files: [],
-      }),
-    },
-  })
-
-  const result = checkDataFiles()
-
-  t.false(result.ok)
-  t.is(result.level, 'warn')
-  t.regex(result.message, /1 issue/)
-  t.regex(result.remediation, /publication\.yaml/)
-})
-
-test('checkDataFiles returns warning when YAML has syntax error', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkDataFiles } = await esmock('./data-files.js', {
-    '#src/validators/validate-data-files.js': {
-      validateDataFiles: sandbox.stub().returns({
-        valid: false,
-        errors: ['invalid.yaml: YAML syntax error at line 1 - unexpected end of stream'],
-        fileCount: 2,
-        files: [
-          { file: 'publication.yaml', valid: true, errors: [] },
-          { file: 'invalid.yaml', valid: false, errors: ['invalid.yaml: YAML syntax error at line 1 - unexpected end of stream'] },
-        ],
-      }),
-    },
-  })
-
-  const result = checkDataFiles()
-
-  t.false(result.ok)
-  t.is(result.level, 'warn')
-  t.regex(result.remediation, /invalid\.yaml/)
-  t.regex(result.remediation, /YAML syntax error/)
-})
-
-test('checkDataFiles returns warning when duplicate IDs exist', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkDataFiles } = await esmock('./data-files.js', {
-    '#src/validators/validate-data-files.js': {
-      validateDataFiles: sandbox.stub().returns({
-        valid: false,
-        errors: ['figures.yaml: duplicate IDs found: fig-1'],
-        fileCount: 2,
-        files: [
-          { file: 'publication.yaml', valid: true, errors: [] },
-          { file: 'figures.yaml', valid: false, errors: ['figures.yaml: duplicate IDs found: fig-1'] },
-        ],
-      }),
-    },
-  })
-
-  const result = checkDataFiles()
-
-  t.false(result.ok)
-  t.is(result.level, 'warn')
-  t.regex(result.remediation, /duplicate IDs/)
-  t.regex(result.remediation, /fig-1/)
-})

package/src/lib/doctor/checks/project/dependencies.js

@@ -1,53 +0,0 @@
-/**
- * Dependencies check
- *
- * @module lib/doctor/checks/project/dependencies
- */
-import fs from 'node:fs'
-import path from 'node:path'
-import createDebug from '#debug'
-import { DOCS_BASE_URL } from '#lib/doctor/constants.js'
-
-const debug = createDebug('lib:doctor:dependencies')
-
-/**
- * Check if dependencies are installed
- * @returns {import('../../index.js').CheckResult}
- */
-export function checkDependencies() {
-  const hasPackageJson = fs.existsSync('package.json')
-  const hasNodeModules = fs.existsSync('node_modules')
-
-  debug('package.json exists: %s, node_modules exists: %s', hasPackageJson, hasNodeModules)
-
-  if (!hasPackageJson) {
-    return {
-      ok: true,
-      level: 'na',
-      message: 'No package.json (not in project directory)',
-    }
-  }
-
-  if (!hasNodeModules) {
-    return {
-      ok: false,
-      message: 'node_modules not found',
-      remediation: `Install project dependencies by running:
-    • npm install
-
-    If you continue to have issues:
-    • Delete node_modules folder and package-lock.json, then run npm install again
-    • Ensure you have write permissions in the project directory`,
-      docsUrl: `${DOCS_BASE_URL}/quire-commands/#install-dependencies`,
-    }
-  }
-
-  const nodeModulesPath = path.resolve('node_modules')
-  return {
-    ok: true,
-    message: 'installed',
-    details: nodeModulesPath,
-  }
-}
-
-export default checkDependencies

package/src/lib/doctor/checks/project/dependencies.test.js

@@ -1,71 +0,0 @@
-import test from 'ava'
-import sinon from 'sinon'
-import esmock from 'esmock'
-
-test.beforeEach((t) => {
-  t.context.sandbox = sinon.createSandbox()
-})
-
-test.afterEach.always((t) => {
-  t.context.sandbox.restore()
-})
-
-test('checkDependencies returns ok when node_modules exists', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkDependencies } = await esmock('./dependencies.js', {
-    'node:fs': {
-      default: {
-        existsSync: sandbox.stub().returns(true),
-      },
-    },
-    'node:path': {
-      default: {
-        resolve: sandbox.stub().callsFake((p) => `/test/project/${p}`),
-      },
-    },
-  })
-
-  const result = checkDependencies()
-
-  t.true(result.ok)
-  t.is(result.message, 'installed')
-  t.is(result.details, '/test/project/node_modules')
-})
-
-test('checkDependencies returns not ok when node_modules missing', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkDependencies } = await esmock('./dependencies.js', {
-    'node:fs': {
-      default: {
-        existsSync: sandbox.stub().callsFake((path) => path === 'package.json'),
-      },
-    },
-  })
-
-  const result = checkDependencies()
-
-  t.false(result.ok)
-  t.regex(result.message, /node_modules not found/)
-  t.truthy(result.remediation, 'should include remediation guidance')
-  t.truthy(result.docsUrl, 'should include documentation link')
-})
-
-test('checkDependencies returns N/A when no package.json (not in project)', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkDependencies } = await esmock('./dependencies.js', {
-    'node:fs': {
-      default: {
-        existsSync: sandbox.stub().returns(false),
-      },
-    },
-  })
-
-  const result = checkDependencies()
-
-  t.true(result.ok)
-  t.is(result.level, 'na', 'should return N/A level when not in project')
-  t.regex(result.message, /No package\.json/)
-})

package/src/lib/doctor/checks/project/index.js

@@ -1,11 +0,0 @@
-/**
- * Project checks
- *
- * Checks for project structure and configuration.
- *
- * @module lib/doctor/checks/project
- */
-export { checkQuireProject } from './quire-project.js'
-export { checkDependencies } from './dependencies.js'
-export { checkOutdatedQuire11ty } from './quire-11ty.js'
-export { checkDataFiles } from './data-files.js'

package/src/lib/doctor/checks/project/quire-11ty.js

@@ -1,98 +0,0 @@
-/**
- * quire-11ty version check
- *
- * @module lib/doctor/checks/project/quire-11ty
- */
-import fs from 'node:fs'
-import semver from 'semver'
-import npm from '#lib/npm/index.js'
-import config from '#lib/conf/config.js'
-import createDebug from '#debug'
-import { DOCS_BASE_URL, QUIRE_11TY_PACKAGE } from '#lib/doctor/constants.js'
-
-const debug = createDebug('lib:doctor:quire-11ty')
-
-/**
- * Check if quire-11ty is outdated compared to the latest available version
- *
- * Compares the installed version of @thegetty/quire-11ty against the latest
- * version available on npm (using the configured updateChannel, e.g., 'rc').
- *
- * @returns {Promise<import('../../index.js').CheckResult>}
- */
-export async function checkOutdatedQuire11ty() {
-  const packagePath = 'package.json'
-
-  // Skip if not in a project directory
-  if (!fs.existsSync(packagePath)) {
-    debug('package.json not found, skipping outdated check')
-    return {
-      ok: true,
-      level: 'na',
-      message: 'quire-11ty not installed (not in project)',
-    }
-  }
-
-  // Read installed version from the project's own package.json
-  // Nota bene: in Quire projects, quire-11ty IS the project itself
-  // (its files are copied into the project root by `quire new`)
-  let installedVersion
-  try {
-    const packageJson = JSON.parse(fs.readFileSync(packagePath, 'utf8'))
-    if (packageJson.name !== QUIRE_11TY_PACKAGE) {
-      debug('package.json is not a quire-11ty project: %s', packageJson.name)
-      return {
-        ok: true,
-        level: 'na',
-        message: 'quire-11ty not installed (not in project)',
-      }
-    }
-    installedVersion = packageJson.version
-    debug('Installed quire-11ty version: %s', installedVersion)
-  } catch (error) {
-    debug('Failed to read installed quire-11ty version: %s', error.message)
-    return {
-      ok: false,
-      level: 'warn',
-      message: 'Could not read installed quire-11ty version',
-      remediation: `Check that ${QUIRE_11TY_PACKAGE} is properly installed:
-    • Run "npm install" to reinstall dependencies
-    • If the issue persists, delete node_modules and reinstall`,
-      docsUrl: `${DOCS_BASE_URL}/quire-commands/#install-dependencies`,
-    }
-  }
-
-  // Fetch latest version from npm registry
-  const updateChannel = config.get('updateChannel') || 'rc'
-  let latestVersion
-  try {
-    latestVersion = await npm.view(QUIRE_11TY_PACKAGE, `dist-tags.${updateChannel}`)
-    debug('Latest quire-11ty version (%s channel): %s', updateChannel, latestVersion)
-  } catch (error) {
-    debug('Failed to fetch latest quire-11ty version: %s', error.message)
-    return {
-      ok: true,
-      message: `v${installedVersion} (could not check for updates)`,
-    }
-  }
-
-  // Compare versions
-  if (semver.lt(installedVersion, latestVersion)) {
-    return {
-      ok: false,
-      level: 'warn',
-      message: `v${installedVersion} installed, v${latestVersion} available`,
-      remediation: `Update quire-11ty to the latest version:
-    • Run "quire use ${latestVersion}" to update
-    • Then run "npm install" to install the new version`,
-      docsUrl: `${DOCS_BASE_URL}/quire-commands/#update-quire`,
-    }
-  }
-
-  return {
-    ok: true,
-    message: `v${installedVersion} (up to date)`,
-  }
-}
-
-export default checkOutdatedQuire11ty