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

package/src/lib/doctor/checks/environment/cli-version.js

@@ -1,62 +0,0 @@
-/**
- * Quire CLI version check
- *
- * @module lib/doctor/checks/environment/cli-version
- */
-import updateNotifier from 'update-notifier'
-import packageConfig from '#src/packageConfig.js'
-import config from '#lib/conf/config.js'
-import createDebug from '#debug'
-import { DOCS_BASE_URL } from '#lib/doctor/constants.js'
-
-const debug = createDebug('lib:doctor:cli-version')
-
-/**
- * Check Quire CLI version and report if an update is available
- *
- * Uses the cached update info from update-notifier (which checks in background
- * on CLI startup) to avoid blocking the doctor command with network requests.
- *
- * @returns {import('../../index.js').CheckResult}
- */
-export function checkCliVersion() {
-  const current = packageConfig.version
-  debug('Current CLI version: %s', current)
-
-  // Access cached update info from update-notifier
-  // Using a high updateCheckInterval prevents triggering a new check,
-  // we just want to read the cached result from the CLI startup check
-  const updateChannel = config.get('updateChannel') || 'rc'
-  const notifier = updateNotifier({
-    pkg: packageConfig,
-    distTag: updateChannel,
-    updateCheckInterval: Number.MAX_SAFE_INTEGER, // Don't trigger new check
-  })
-
-  debug('Cached update info: %o', notifier.update)
-
-  // Check if an update is available
-  if (notifier.update && notifier.update.latest !== current) {
-    const { latest } = notifier.update
-    debug('Update available: %s -> %s', current, latest)
-
-    return {
-      ok: false,
-      level: 'warn',
-      message: `v${current} installed, v${latest} available`,
-      remediation: `Update Quire CLI to the latest version:
-    • npm install -g @thegetty/quire-cli@${latest}
-    • Or update via your package manager if installed differently`,
-      docsUrl: `${DOCS_BASE_URL}/install-uninstall/`,
-    }
-  }
-
-  // No update info or already up to date
-  const upToDateSuffix = notifier.update ? ' (up to date)' : ''
-  return {
-    ok: true,
-    message: `v${current}${upToDateSuffix}`,
-  }
-}
-
-export default checkCliVersion

package/src/lib/doctor/checks/environment/cli-version.test.js

@@ -1,132 +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('checkCliVersion returns ok with version when up to date', async (t) => {
-  const { sandbox } = t.context
-
-  const mockUpdateNotifier = sandbox.stub().returns({
-    update: { current: '1.0.0-rc.33', latest: '1.0.0-rc.33', type: 'latest' },
-  })
-
-  const { checkCliVersion } = await esmock('./cli-version.js', {
-    'update-notifier': { default: mockUpdateNotifier },
-    '#src/packageConfig.js': { default: { name: '@thegetty/quire-cli', version: '1.0.0-rc.33' } },
-    '#lib/conf/config.js': { default: { get: sandbox.stub().returns('rc') } },
-  })
-
-  const result = checkCliVersion()
-
-  t.true(result.ok)
-  t.regex(result.message, /v1\.0\.0-rc\.33/)
-  t.regex(result.message, /up to date/)
-})
-
-test('checkCliVersion returns warning when update is available', async (t) => {
-  const { sandbox } = t.context
-
-  const mockUpdateNotifier = sandbox.stub().returns({
-    update: { current: '1.0.0-rc.30', latest: '1.0.0-rc.33', type: 'prerelease' },
-  })
-
-  const { checkCliVersion } = await esmock('./cli-version.js', {
-    'update-notifier': { default: mockUpdateNotifier },
-    '#src/packageConfig.js': { default: { name: '@thegetty/quire-cli', version: '1.0.0-rc.30' } },
-    '#lib/conf/config.js': { default: { get: sandbox.stub().returns('rc') } },
-  })
-
-  const result = checkCliVersion()
-
-  t.false(result.ok)
-  t.is(result.level, 'warn')
-  t.regex(result.message, /v1\.0\.0-rc\.30 installed/)
-  t.regex(result.message, /v1\.0\.0-rc\.33 available/)
-  t.truthy(result.remediation)
-  t.regex(result.remediation, /npm install/)
-  t.truthy(result.docsUrl)
-})
-
-test('checkCliVersion returns ok without "up to date" when no cached update info', async (t) => {
-  const { sandbox } = t.context
-
-  // No cached update info (first run or cache cleared)
-  const mockUpdateNotifier = sandbox.stub().returns({
-    update: undefined,
-  })
-
-  const { checkCliVersion } = await esmock('./cli-version.js', {
-    'update-notifier': { default: mockUpdateNotifier },
-    '#src/packageConfig.js': { default: { name: '@thegetty/quire-cli', version: '1.0.0-rc.33' } },
-    '#lib/conf/config.js': { default: { get: sandbox.stub().returns('rc') } },
-  })
-
-  const result = checkCliVersion()
-
-  t.true(result.ok)
-  t.is(result.message, 'v1.0.0-rc.33')
-  t.notRegex(result.message, /up to date/)
-})
-
-test('checkCliVersion uses configured updateChannel', async (t) => {
-  const { sandbox } = t.context
-
-  const mockUpdateNotifier = sandbox.stub().returns({ update: undefined })
-  const mockConfigGet = sandbox.stub().returns('latest')
-
-  const { checkCliVersion } = await esmock('./cli-version.js', {
-    'update-notifier': { default: mockUpdateNotifier },
-    '#src/packageConfig.js': { default: { name: '@thegetty/quire-cli', version: '1.0.0' } },
-    '#lib/conf/config.js': { default: { get: mockConfigGet } },
-  })
-
-  checkCliVersion()
-
-  t.true(mockUpdateNotifier.calledOnce)
-  const callArgs = mockUpdateNotifier.firstCall.args[0]
-  t.is(callArgs.distTag, 'latest')
-})
-
-test('checkCliVersion defaults to rc channel when config returns undefined', async (t) => {
-  const { sandbox } = t.context
-
-  const mockUpdateNotifier = sandbox.stub().returns({ update: undefined })
-  const mockConfigGet = sandbox.stub().returns(undefined)
-
-  const { checkCliVersion } = await esmock('./cli-version.js', {
-    'update-notifier': { default: mockUpdateNotifier },
-    '#src/packageConfig.js': { default: { name: '@thegetty/quire-cli', version: '1.0.0' } },
-    '#lib/conf/config.js': { default: { get: mockConfigGet } },
-  })
-
-  checkCliVersion()
-
-  t.true(mockUpdateNotifier.calledOnce)
-  const callArgs = mockUpdateNotifier.firstCall.args[0]
-  t.is(callArgs.distTag, 'rc')
-})
-
-test('checkCliVersion remediation includes latest version number', async (t) => {
-  const { sandbox } = t.context
-
-  const mockUpdateNotifier = sandbox.stub().returns({
-    update: { current: '1.0.0-rc.30', latest: '1.0.0-rc.35', type: 'prerelease' },
-  })
-
-  const { checkCliVersion } = await esmock('./cli-version.js', {
-    'update-notifier': { default: mockUpdateNotifier },
-    '#src/packageConfig.js': { default: { name: '@thegetty/quire-cli', version: '1.0.0-rc.30' } },
-    '#lib/conf/config.js': { default: { get: sandbox.stub().returns('rc') } },
-  })
-
-  const result = checkCliVersion()
-
-  t.regex(result.remediation, /@thegetty\/quire-cli@1\.0\.0-rc\.35/)
-})

package/src/lib/doctor/checks/environment/git-available.js

@@ -1,77 +0,0 @@
-/**
- * Git availability check
- *
- * @module lib/doctor/checks/environment/git-available
- */
-import git from '#lib/git/index.js'
-import which from 'which'
-import createDebug from '#debug'
-import { getPlatform, Platform } from '#lib/platform.js'
-import { DOCS_BASE_URL } from '#lib/doctor/constants.js'
-
-const debug = createDebug('lib:doctor:git-available')
-
-/**
- * Get OS-specific Git installation instructions and docs URL
- * @returns {{ remediation: string, docsUrl: string }}
- */
-function getRemediationAndDocs() {
-  const platform = getPlatform()
-
-  switch (platform) {
-    case Platform.MACOS:
-      return {
-        remediation: `Install Git:
-    • Run: xcode-select --install
-    • Or using Homebrew: brew install git`,
-        docsUrl: `${DOCS_BASE_URL}/install-uninstall/#mac-os-installation`,
-      }
-    case Platform.WINDOWS:
-      return {
-        remediation: `Install Git for Windows:
-    • Download from: https://git-scm.com/download/win
-    • Or using winget: winget install Git.Git
-    • Restart your terminal after installation`,
-        docsUrl: `${DOCS_BASE_URL}/install-uninstall/#windows-installation`,
-      }
-    case Platform.LINUX:
-      return {
-        remediation: `Install Git:
-    • Debian/Ubuntu: sudo apt-get install git
-    • Fedora: sudo dnf install git
-    • Arch: sudo pacman -S git`,
-        docsUrl: `${DOCS_BASE_URL}/install-uninstall/#1-install-nodejs`,
-      }
-    default:
-      return {
-        remediation: 'Install Git from https://git-scm.com/',
-        docsUrl: `${DOCS_BASE_URL}/install-uninstall/`,
-      }
-  }
-}
-
-/**
- * Check Git is available in PATH
- * @returns {Promise<import('../../index.js').CheckResult>}
- */
-export async function checkGitAvailable() {
-  const ok = await git.isAvailable()
-  debug('git available: %s', ok)
-
-  if (ok) {
-    const version = await git.version()
-    const gitPath = which.sync('git', { nothrow: true })
-    return { ok: true, message: version, details: gitPath }
-  }
-
-  const { remediation, docsUrl } = getRemediationAndDocs()
-
-  return {
-    ok: false,
-    message: 'not found in PATH',
-    remediation,
-    docsUrl,
-  }
-}
-
-export default checkGitAvailable

package/src/lib/doctor/checks/environment/git-available.test.js

@@ -1,52 +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('checkGitAvailable returns ok when git is available', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkGitAvailable } = await esmock('./git-available.js', {
-    '#lib/git/index.js': {
-      default: {
-        isAvailable: sandbox.stub().resolves(true),
-        version: sandbox.stub().resolves('2.43.0'),
-      },
-    },
-    which: {
-      sync: sandbox.stub().returns('/usr/bin/git'),
-    },
-  })
-
-  const result = await checkGitAvailable()
-
-  t.true(result.ok)
-  t.is(result.message, '2.43.0')
-  t.is(result.details, '/usr/bin/git')
-})
-
-test('checkGitAvailable returns not ok when git is missing', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkGitAvailable } = await esmock('./git-available.js', {
-    '#lib/git/index.js': {
-      default: {
-        isAvailable: sandbox.stub().resolves(false),
-      },
-    },
-  })
-
-  const result = await checkGitAvailable()
-
-  t.false(result.ok)
-  t.is(result.message, 'not found in PATH')
-  t.truthy(result.remediation, 'should include remediation guidance')
-  t.truthy(result.docsUrl, 'should include documentation link')
-})

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

@@ -1,13 +0,0 @@
-/**
- * Environment checks
- *
- * System prerequisites that must exist for Quire to function.
- *
- * @module lib/doctor/checks/environment
- */
-export { checkOsInfo } from './os-info.js'
-export { checkCliVersion } from './cli-version.js'
-export { checkNodeVersion } from './node-version.js'
-export { checkRuntimeInfo } from './runtime-info.js'
-export { checkNpmAvailable } from './npm-available.js'
-export { checkGitAvailable } from './git-available.js'

package/src/lib/doctor/checks/environment/node-version.js

@@ -1,66 +0,0 @@
-/**
- * Node.js version check
- *
- * @module lib/doctor/checks/environment/node-version
- */
-import createDebug from '#debug'
-import { getPlatform, Platform } from '#lib/platform.js'
-import { DOCS_BASE_URL, REQUIRED_NODE_VERSION } from '#lib/doctor/constants.js'
-
-const debug = createDebug('lib:doctor:node-version')
-
-/**
- * Get OS-specific Node.js installation instructions
- * @returns {string}
- */
-function getRemediation() {
-  const platform = getPlatform()
-  const version = REQUIRED_NODE_VERSION
-
-  switch (platform) {
-    case Platform.MACOS:
-      return `Install Node.js ${version} or later:
-    • Using nvm (recommended): nvm install ${version} && nvm use ${version}
-    • Using Homebrew: brew install node@${version}
-    • Download from: https://nodejs.org/`
-    case Platform.WINDOWS:
-      return `Install Node.js ${version} or later:
-    • Using nvm-windows: nvm install ${version} && nvm use ${version}
-    • Download installer from: https://nodejs.org/
-    • Using winget: winget install OpenJS.NodeJS.LTS`
-    case Platform.LINUX:
-      return `Install Node.js ${version} or later:
-    • Using nvm (recommended): nvm install ${version} && nvm use ${version}
-    • Using apt (Debian/Ubuntu): See https://nodejs.org/en/download/package-manager
-    • Download from: https://nodejs.org/`
-    default:
-      return `Install Node.js ${version} or later from https://nodejs.org/`
-  }
-}
-
-/**
- * Check Node.js version meets minimum requirement
- * @returns {import('../../index.js').CheckResult}
- */
-export function checkNodeVersion() {
-  const current = parseInt(process.version.slice(1), 10)
-  const ok = current >= REQUIRED_NODE_VERSION
-  debug('Node.js version check: %s (required >= %d)', process.version, REQUIRED_NODE_VERSION)
-
-  if (ok) {
-    return {
-      ok: true,
-      message: `v${process.version.slice(1)} (>= ${REQUIRED_NODE_VERSION} required)`,
-      details: process.execPath,
-    }
-  }
-
-  return {
-    ok: false,
-    message: `v${process.version.slice(1)} found, but >= ${REQUIRED_NODE_VERSION} required`,
-    remediation: getRemediation(),
-    docsUrl: `${DOCS_BASE_URL}/install-uninstall/#1-install-nodejs`,
-  }
-}
-
-export default checkNodeVersion

package/src/lib/doctor/checks/environment/node-version.test.js

@@ -1,17 +0,0 @@
-import test from 'ava'
-
-test('checkNodeVersion returns ok when version meets requirement', async (t) => {
-  const { checkNodeVersion } = await import('./node-version.js')
-
-  const result = checkNodeVersion()
-
-  // Current Node.js version should be >= 22 in dev environment
-  t.is(typeof result.ok, 'boolean')
-  t.is(typeof result.message, 'string')
-  t.regex(result.message, /v\d+/)
-
-  // When check passes, details should be the Node.js executable path
-  if (result.ok) {
-    t.is(result.details, process.execPath)
-  }
-})

package/src/lib/doctor/checks/environment/npm-available.js

@@ -1,66 +0,0 @@
-/**
- * npm availability check
- *
- * @module lib/doctor/checks/environment/npm-available
- */
-import npm from '#lib/npm/index.js'
-import which from 'which'
-import createDebug from '#debug'
-import { getPlatform, Platform } from '#lib/platform.js'
-import { DOCS_BASE_URL } from '#lib/doctor/constants.js'
-
-const debug = createDebug('lib:doctor:npm-available')
-
-/**
- * Get OS-specific npm troubleshooting instructions
- * @returns {string}
- */
-function getRemediation() {
-  const platform = getPlatform()
-  const commonSteps = `npm is included with Node.js. Ensure Node.js is properly installed:
-    • Verify installation: node --version`
-
-  switch (platform) {
-    case Platform.MACOS:
-      return `${commonSteps}
-    • If using nvm, run: nvm use default
-    • Reinstall Node.js: brew reinstall node (or download from nodejs.org)`
-    case Platform.WINDOWS:
-      return `${commonSteps}
-    • Restart your terminal after Node.js installation
-    • Check PATH includes: %APPDATA%\\npm
-    • Reinstall Node.js from: https://nodejs.org/`
-    case Platform.LINUX:
-      return `${commonSteps}
-    • If using nvm, run: nvm use default
-    • Check PATH includes Node.js bin directory
-    • Reinstall Node.js from: https://nodejs.org/`
-    default:
-      return `${commonSteps}
-    • Reinstall Node.js if needed: https://nodejs.org/`
-  }
-}
-
-/**
- * Check npm is available in PATH
- * @returns {Promise<import('../../index.js').CheckResult>}
- */
-export async function checkNpmAvailable() {
-  const ok = await npm.isAvailable()
-  debug('npm available: %s', ok)
-
-  if (ok) {
-    const version = await npm.version()
-    const npmPath = which.sync('npm', { nothrow: true })
-    return { ok: true, message: version, details: npmPath }
-  }
-
-  return {
-    ok: false,
-    message: 'not found in PATH',
-    remediation: getRemediation(),
-    docsUrl: `${DOCS_BASE_URL}/install-uninstall/#1-install-nodejs`,
-  }
-}
-
-export default checkNpmAvailable

package/src/lib/doctor/checks/environment/npm-available.test.js

@@ -1,52 +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('checkNpmAvailable returns ok when npm is available', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkNpmAvailable } = await esmock('./npm-available.js', {
-    '#lib/npm/index.js': {
-      default: {
-        isAvailable: sandbox.stub().resolves(true),
-        version: sandbox.stub().resolves('10.2.4'),
-      },
-    },
-    which: {
-      sync: sandbox.stub().returns('/usr/local/bin/npm'),
-    },
-  })
-
-  const result = await checkNpmAvailable()
-
-  t.true(result.ok)
-  t.is(result.message, '10.2.4')
-  t.is(result.details, '/usr/local/bin/npm')
-})
-
-test('checkNpmAvailable returns not ok when npm is missing', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkNpmAvailable } = await esmock('./npm-available.js', {
-    '#lib/npm/index.js': {
-      default: {
-        isAvailable: sandbox.stub().resolves(false),
-      },
-    },
-  })
-
-  const result = await checkNpmAvailable()
-
-  t.false(result.ok)
-  t.is(result.message, 'not found in PATH')
-  t.truthy(result.remediation, 'should include remediation guidance')
-  t.truthy(result.docsUrl, 'should include documentation link')
-})

package/src/lib/doctor/checks/environment/os-info.js

@@ -1,48 +0,0 @@
-/**
- * Operating system info check
- *
- * @module lib/doctor/checks/environment/os-info
- */
-import os from 'node:os'
-import { getPlatformName, getPlatform, Platform } from '#lib/platform.js'
-import createDebug from '#debug'
-
-const debug = createDebug('lib:doctor:os-info')
-
-/**
- * Report operating system information
- *
- * This is an informational check that always passes.
- * It provides context for other checks and helps with troubleshooting.
- *
- * @returns {import('../../index.js').CheckResult}
- */
-export function checkOsInfo() {
-  const platform = getPlatform()
-  const platformName = getPlatformName()
-
-  const arch = os.arch()
-  const cpuCount = os.cpus().length
-  const totalMem = os.totalmem()
-
-  debug('Platform: %s, Name: %s, Arch: %s', platform, platformName, arch)
-
-  // Build informational message
-  let message = `${platformName} (${arch})`
-
-  // Add platform-specific notes
-  if (platform === Platform.WINDOWS) {
-    message += ' - Git for Windows recommended'
-  }
-
-  const memGB = (totalMem / 1024 / 1024 / 1024).toFixed(1)
-  const details = `Memory: ${memGB} GB, CPUs: ${cpuCount}`
-
-  return {
-    ok: true,
-    message,
-    details,
-  }
-}
-
-export default checkOsInfo

package/src/lib/doctor/checks/environment/os-info.test.js

@@ -1,81 +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('checkOsInfo returns ok with platform info and details', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkOsInfo } = await esmock('./os-info.js', {
-    '#lib/platform.js': {
-      getPlatform: sandbox.stub().returns('macos'),
-      getPlatformName: sandbox.stub().returns('macOS 14'),
-      Platform: { MACOS: 'macos', WINDOWS: 'windows', LINUX: 'linux' },
-    },
-    'node:os': {
-      arch: sandbox.stub().returns('arm64'),
-      totalmem: sandbox.stub().returns(64 * 1024 * 1024 * 1024),
-      cpus: sandbox.stub().returns(new Array(12)),
-    },
-  })
-
-  const result = checkOsInfo()
-
-  t.true(result.ok)
-  t.regex(result.message, /macOS 14/)
-  t.regex(result.message, /arm64/)
-  t.is(result.details, 'Memory: 64.0 GB, CPUs: 12')
-})
-
-test('checkOsInfo adds Windows note on Windows', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkOsInfo } = await esmock('./os-info.js', {
-    '#lib/platform.js': {
-      getPlatform: sandbox.stub().returns('windows'),
-      getPlatformName: sandbox.stub().returns('Windows (10.0.22621)'),
-      Platform: { MACOS: 'macos', WINDOWS: 'windows', LINUX: 'linux' },
-    },
-    'node:os': {
-      arch: sandbox.stub().returns('x64'),
-      totalmem: sandbox.stub().returns(16 * 1024 * 1024 * 1024),
-      cpus: sandbox.stub().returns(new Array(8)),
-    },
-  })
-
-  const result = checkOsInfo()
-
-  t.true(result.ok)
-  t.regex(result.message, /Windows/)
-  t.regex(result.message, /Git for Windows/)
-})
-
-test('checkOsInfo works on Linux', async (t) => {
-  const { sandbox } = t.context
-
-  const { checkOsInfo } = await esmock('./os-info.js', {
-    '#lib/platform.js': {
-      getPlatform: sandbox.stub().returns('linux'),
-      getPlatformName: sandbox.stub().returns('Linux (5.15.0)'),
-      Platform: { MACOS: 'macos', WINDOWS: 'windows', LINUX: 'linux' },
-    },
-    'node:os': {
-      arch: sandbox.stub().returns('x64'),
-      totalmem: sandbox.stub().returns(32 * 1024 * 1024 * 1024),
-      cpus: sandbox.stub().returns(new Array(4)),
-    },
-  })
-
-  const result = checkOsInfo()
-
-  t.true(result.ok)
-  t.regex(result.message, /Linux/)
-  t.notRegex(result.message, /Git for Windows/)
-})