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

package/src/commands/preview.test.js

@@ -1,250 +0,0 @@
-import test from 'ava'
-import { Volume, createFsFromVolume } from 'memfs'
-import sinon from 'sinon'
-import esmock from 'esmock'
-
-test.beforeEach((t) => {
-  // Create sinon sandbox for mocking
-  t.context.sandbox = sinon.createSandbox()
-
-  // Create in-memory file system
-  t.context.vol = new Volume()
-  t.context.fs = createFsFromVolume(t.context.vol)
-
-  // Setup mock directory structure
-  t.context.vol.fromJSON({
-    '/project/content/_data/config.yaml': 'title: Test Project',
-    '/project/content/index.md': '# Welcome',
-    '/project/package.json': JSON.stringify({ name: 'test-project' })
-  })
-
-  t.context.projectRoot = '/project'
-
-  // Stub console methods to suppress output during tests
-  // Create mock logger (no global console stubbing needed!)
-  t.context.mockLogger = {
-    info: t.context.sandbox.stub(),
-    error: t.context.sandbox.stub(),
-    debug: t.context.sandbox.stub(),
-    log: t.context.sandbox.stub(),
-    warn: t.context.sandbox.stub()
-  }
-})
-
-test.afterEach.always((t) => {
-  // Restore all mocks
-  t.context.sandbox.restore()
-
-  // Clear in-memory file system
-  t.context.vol.reset()
-})
-
-test('preview command should call eleventy CLI serve with default options', async (t) => {
-  const { sandbox, fs, mockLogger } = t.context
-
-  // Mock eleventy CLI module
-  const mockEleventyCli = {
-    serve: sandbox.stub().resolves({ exitCode: 0 })
-  }
-
-  // Mock eleventy API module
-  const mockEleventyApi = {
-    serve: sandbox.stub().resolves()
-  }
-
-  // Mock testcwd helper
-  const mockTestcwd = sandbox.stub()
-
-  // Use esmock to replace imports
-  const PreviewCommand = await esmock('./preview.js', {
-    '#lib/11ty/index.js': {
-      api: mockEleventyApi,
-      cli: mockEleventyCli
-    },
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/logger/index.js': {
-      logger: mockLogger
-    },
-    'fs-extra': fs
-  })
-
-  const command = new PreviewCommand()
-  command.name = sandbox.stub().returns('preview')
-
-  // Run preAction
-  command.preAction(command)
-
-  // Run action with default options (uses cli by default)
-  await command.action({ '11ty': 'cli', port: 8080 }, command)
-
-  t.true(mockTestcwd.called, 'testcwd should be called in preAction')
-  t.true(mockEleventyCli.serve.called, 'eleventy CLI serve should be called')
-  t.false(mockEleventyApi.serve.called, 'eleventy API serve should not be called')
-})
-
-test('preview command should call eleventy API when 11ty option is "api"', async (t) => {
-  const { sandbox, fs, mockLogger } = t.context
-
-  // Mock eleventy CLI module
-  const mockEleventyCli = {
-    serve: sandbox.stub().resolves({ exitCode: 0 })
-  }
-
-  // Mock eleventy API module
-  const mockEleventyApi = {
-    serve: sandbox.stub().resolves()
-  }
-
-  // Mock testcwd helper
-  const mockTestcwd = sandbox.stub()
-
-  // Use esmock to replace imports
-  const PreviewCommand = await esmock('./preview.js', {
-    '#lib/11ty/index.js': {
-      api: mockEleventyApi,
-      cli: mockEleventyCli
-    },
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/logger/index.js': {
-      logger: mockLogger
-    },
-    'fs-extra': fs
-  })
-
-  const command = new PreviewCommand()
-  command.name = sandbox.stub().returns('preview')
-
-  // Run action with api option
-  await command.action({ '11ty': 'api', port: 8080 }, command)
-
-  t.false(mockEleventyCli.serve.called, 'eleventy CLI serve should not be called')
-  t.true(mockEleventyApi.serve.called, 'eleventy API serve should be called')
-})
-
-test('preview command should pass port option to eleventy serve', async (t) => {
-  const { sandbox, fs, mockLogger } = t.context
-
-  // Mock eleventy CLI module
-  const mockEleventyCli = {
-    serve: sandbox.stub().resolves({ exitCode: 0 })
-  }
-
-  // Mock eleventy API module
-  const mockEleventyApi = {
-    serve: sandbox.stub().resolves()
-  }
-
-  // Mock testcwd helper
-  const mockTestcwd = sandbox.stub()
-
-  // Use esmock to replace imports
-  const PreviewCommand = await esmock('./preview.js', {
-    '#lib/11ty/index.js': {
-      api: mockEleventyApi,
-      cli: mockEleventyCli
-    },
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/logger/index.js': {
-      logger: mockLogger
-    },
-    'fs-extra': fs
-  })
-
-  const command = new PreviewCommand()
-  command.name = sandbox.stub().returns('preview')
-
-  const options = { '11ty': 'cli', port: 3000 }
-
-  // Run action with custom port
-  await command.action(options, command)
-
-  t.true(mockEleventyCli.serve.calledWith(options), 'eleventy CLI serve should be called with port option')
-})
-
-test('preview command should pass quiet and verbose options', async (t) => {
-  const { sandbox, fs, mockLogger } = t.context
-
-  // Mock eleventy CLI module
-  const mockEleventyCli = {
-    serve: sandbox.stub().resolves({ exitCode: 0 })
-  }
-
-  // Mock eleventy API module
-  const mockEleventyApi = {
-    serve: sandbox.stub().resolves()
-  }
-
-  // Mock testcwd helper
-  const mockTestcwd = sandbox.stub()
-
-  // Use esmock to replace imports
-  const PreviewCommand = await esmock('./preview.js', {
-    '#lib/11ty/index.js': {
-      api: mockEleventyApi,
-      cli: mockEleventyCli
-    },
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/logger/index.js': {
-      logger: mockLogger
-    },
-    'fs-extra': fs
-  })
-
-  const command = new PreviewCommand()
-  command.name = sandbox.stub().returns('preview')
-
-  const options = { '11ty': 'cli', quiet: true, verbose: false, port: 8080 }
-
-  // Run action with quiet and verbose options
-  await command.action(options, command)
-
-  t.true(mockEleventyCli.serve.calledWith(options), 'eleventy CLI serve should be called with all options')
-})
-
-test('preview command should call testcwd in preAction', async (t) => {
-  const { sandbox, fs, mockLogger } = t.context
-
-  // Mock eleventy modules
-  const mockEleventyCli = {
-    serve: sandbox.stub().resolves({ exitCode: 0 })
-  }
-
-  const mockEleventyApi = {
-    serve: sandbox.stub().resolves()
-  }
-
-  // Mock testcwd helper
-  const mockTestcwd = sandbox.stub()
-
-  // Use esmock to replace imports
-  const PreviewCommand = await esmock('./preview.js', {
-    '#lib/11ty/index.js': {
-      api: mockEleventyApi,
-      cli: mockEleventyCli
-    },
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/logger/index.js': {
-      logger: mockLogger
-    },
-    'fs-extra': fs
-  })
-
-  const command = new PreviewCommand()
-  command.name = sandbox.stub().returns('preview')
-
-  // Run preAction
-  command.preAction(command)
-
-  t.true(mockTestcwd.called, 'testcwd should be called in preAction')
-  t.true(mockTestcwd.calledWith(command), 'testcwd should be called with command object')
-})

package/src/commands/use.js

@@ -1,56 +0,0 @@
-import Command from '#src/Command.js'
-import { setVersion } from '#lib/project/index.js'
-import { latest } from '#lib/installer/index.js'
-import testcwd from '#helpers/test-cwd.js'
-
-/**
- * Quire CLI `use` Command
- *
- * Running `quire use` sets the `quire-11ty` version for a project.
- * The version is written to a `.quire` file in the project directory.
- *
- * @class      UseCommand
- * @extends    {Command}
- */
-export default class UseCommand extends Command {
-  static definition = {
-    name: 'use',
-    aliases: ['version'],
-    hidden: true,  // hide command (incomplete functionality; possible Quire v2)
-    description: 'Sets the Quire version to use when running commands on the project.',
-    summary: 'set project quire-11ty version',
-    docsLink: 'quire-commands/',
-    version: '1.0.0',
-    args: [
-      [ '<version>', 'quire-11ty version to use' ],
-    ],
-    options: [
-      // [ '-g', '--global', 'set the quire version globally' ],
-    ],
-  }
-
-  constructor() {
-    super(UseCommand.definition)
-  }
-
-  /**
-   * Set the quire-11ty version for the current project
-   *
-   * Validates the version against npm registry before setting.
-   * Supports exact versions, semver ranges, and 'latest'.
-   *
-   * @param {string} version - The quire-11ty version to use
-   * @param {Object} options - Command options
-   */
-  async action(version, options = {}) {
-    this.debug('called with options %O', options)
-
-    // Validate and resolve the version against npm registry
-    const resolvedVersion = await latest(version)
-    setVersion(resolvedVersion)
-  }
-
-  preAction(thisCommand, actionCommand) {
-    testcwd(thisCommand)
-  }
-}

package/src/commands/use.spec.js

@@ -1,61 +0,0 @@
-import { Argument, Command, Option } from 'commander'
-import program from '#src/main.js'
-import test from 'ava'
-
-/**
- * Command Contract/Interface Tests
- *
- * Verifies the command's public API and Commander.js integration.
- * @see docs/testing-commands.md
- */
-
-test.before((t) => {
-  // Get the registered command (from program.commands) once and share across all tests
-  t.context.command = program.commands.find((cmd) => cmd.name() === 'use')
-})
-
-test('command is registered in CLI program', (t) => {
-  const { command } = t.context
-
-  t.truthy(command, 'command "use" should be registered in program')
-  t.true(command instanceof Command, 'registered command should be Commander.js Command instance')
-})
-
-test('registered command has correct metadata', (t) => {
-  const { command } = t.context
-
-  t.is(command.name(), 'use')
-  t.truthy(command.description())
-  t.is(typeof command._actionHandler, 'function', 'command should have action handler')
-})
-
-test('registered command has correct arguments', (t) => {
-  const { command } = t.context
-  const registeredArguments = command.registeredArguments
-
-  t.is(registeredArguments.length, 1, 'command should have 1 argument')
-
-  // First argument: version
-  const version = registeredArguments[0]
-  t.true(version instanceof Argument, 'version should be Argument instance')
-  t.is(version.name(), 'version', 'first argument should be version')
-  t.true(version.required, 'version should be required')
-  t.truthy(version.description)
-})
-
-test('registered command has no options', (t) => {
-  const { command } = t.context
-
-  // Use command should have no custom options (only inherited help options)
-  const options = command.options.filter((opt) => !opt.long.includes('help'))
-  t.is(options.length, 0, 'use command should have no custom options')
-})
-
-test('command arguments are accessible via public API', (t) => {
-  const { command } = t.context
-
-  // Test that arguments can be accessed the way Commander.js does
-  const argumentNames = command.registeredArguments.map((arg) => arg.name())
-
-  t.true(argumentNames.includes('version'))
-})

package/src/commands/use.test.js

@@ -1,280 +0,0 @@
-import test from 'ava'
-import { Volume, createFsFromVolume } from 'memfs'
-import sinon from 'sinon'
-import esmock from 'esmock'
-
-test.beforeEach((t) => {
-  // Create sinon sandbox for mocking
-  t.context.sandbox = sinon.createSandbox()
-
-  // Create in-memory file system
-  t.context.vol = new Volume()
-  t.context.fs = createFsFromVolume(t.context.vol)
-
-  // Setup mock Quire project directory structure
-  t.context.vol.fromJSON({
-    '/project/.quire': '',
-    '/project/content/_data/config.yaml': 'title: Test Project',
-    '/project/package.json': JSON.stringify({ name: 'test-project' })
-  })
-
-  t.context.projectRoot = '/project'
-
-  // Create mock logger
-  t.context.mockLogger = {
-    info: t.context.sandbox.stub(),
-    error: t.context.sandbox.stub(),
-    debug: t.context.sandbox.stub(),
-    log: t.context.sandbox.stub(),
-    warn: t.context.sandbox.stub()
-  }
-
-  // Mock testcwd helper (returns true for Quire projects)
-  t.context.mockTestcwd = t.context.sandbox.stub()
-})
-
-test.afterEach.always((t) => {
-  // Restore all mocks
-  t.context.sandbox.restore()
-
-  // Clear in-memory file system
-  t.context.vol.reset()
-})
-
-test('use command should validate Quire project in preAction', async (t) => {
-  const { sandbox, mockLogger, mockTestcwd } = t.context
-
-  const { default: UseCommand } = await esmock('./use.js', {
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    }
-  }, {
-    '#lib/logger/index.js': {
-      default: () => mockLogger
-    }
-  })
-
-  const command = new UseCommand()
-  command.logger = mockLogger
-  command.debug = sandbox.stub()
-
-  // Mock Commander.js command object
-  const mockCommand = {
-    name: () => 'use',
-    opts: () => ({})
-  }
-
-  // Call preAction
-  command.preAction(mockCommand)
-
-  t.true(mockTestcwd.called, 'testcwd should be called in preAction')
-  t.true(mockTestcwd.calledWith(mockCommand), 'testcwd should be called with command')
-})
-
-test('use command should accept version argument', async (t) => {
-  const { sandbox, mockLogger, mockTestcwd } = t.context
-
-  const mockLatest = sandbox.stub().resolves('1.0.0-rc.33')
-  const mockSetVersion = sandbox.stub()
-
-  const { default: UseCommand } = await esmock('./use.js', {
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/installer/index.js': {
-      latest: mockLatest
-    },
-    '#lib/project/index.js': {
-      setVersion: mockSetVersion
-    }
-  }, {
-    '#lib/logger/index.js': {
-      default: () => mockLogger
-    }
-  })
-
-  const command = new UseCommand()
-  command.logger = mockLogger
-  command.debug = sandbox.stub()
-
-  // Call action with version argument
-  await command.action('1.0.0-rc.33', {})
-
-  t.true(mockLatest.calledWith('1.0.0-rc.33'), 'latest should be called with version')
-  t.true(mockSetVersion.calledWith('1.0.0-rc.33'), 'setVersion should be called with resolved version')
-})
-
-test('use command should log debug information when debug flag is set', async (t) => {
-  const { sandbox, mockLogger, mockTestcwd } = t.context
-
-  const mockDebug = sandbox.stub()
-  const mockLatest = sandbox.stub().resolves('1.0.0-rc.33')
-  const mockSetVersion = sandbox.stub()
-
-  const { default: UseCommand } = await esmock('./use.js', {
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/installer/index.js': {
-      latest: mockLatest
-    },
-    '#lib/project/index.js': {
-      setVersion: mockSetVersion
-    }
-  }, {
-    '#lib/logger/index.js': {
-      default: () => mockLogger
-    }
-  })
-
-  const command = new UseCommand()
-  command.logger = mockLogger
-  command.debug = mockDebug
-
-  // Call action with debug flag
-  await command.action('1.0.0-rc.33', { debug: true })
-
-  // Verify debug was called
-  t.true(mockDebug.called, 'debug should be called with debug flag')
-  t.true(mockDebug.calledWith('called with options %O', { debug: true }))
-})
-
-test('use command should handle semver version strings', async (t) => {
-  const { sandbox, mockLogger, mockTestcwd } = t.context
-
-  // Mock the installer's latest function to return the version
-  const mockLatest = sandbox.stub().callsFake(async (version) => version)
-  const mockSetVersion = sandbox.stub()
-
-  const { default: UseCommand } = await esmock('./use.js', {
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/installer/index.js': {
-      latest: mockLatest
-    },
-    '#lib/project/index.js': {
-      setVersion: mockSetVersion
-    }
-  }, {
-    '#lib/logger/index.js': {
-      default: () => mockLogger
-    }
-  })
-
-  const command = new UseCommand()
-  command.logger = mockLogger
-  command.debug = sandbox.stub()
-
-  // Test various semver formats
-  const validVersions = [
-    '1.0.0',
-    '1.0.0-rc.1',
-    '1.0.0-beta.2',
-    '2.1.3',
-    '0.0.1'
-  ]
-
-  for (const version of validVersions) {
-    await command.action(version, {})
-    t.pass(`should accept valid semver: ${version}`)
-  }
-
-  t.is(mockLatest.callCount, validVersions.length, 'latest should be called for each version')
-  t.is(mockSetVersion.callCount, validVersions.length, 'setVersion should be called for each version')
-})
-
-test('use command should work with options object', async (t) => {
-  const { sandbox, mockLogger, mockTestcwd } = t.context
-
-  // Mock the installer's latest function to return the version
-  const mockLatest = sandbox.stub().callsFake(async (version) => version)
-  const mockSetVersion = sandbox.stub()
-
-  const { default: UseCommand } = await esmock('./use.js', {
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    },
-    '#lib/installer/index.js': {
-      latest: mockLatest
-    },
-    '#lib/project/index.js': {
-      setVersion: mockSetVersion
-    }
-  }, {
-    '#lib/logger/index.js': {
-      default: () => mockLogger
-    }
-  })
-
-  const command = new UseCommand()
-  command.logger = mockLogger
-  command.debug = sandbox.stub()
-
-  // Test with various options
-  await command.action('1.0.0', { debug: false })
-  await command.action('1.0.0', { debug: true })
-  await command.action('1.0.0', {})
-
-  t.is(mockLatest.callCount, 3, 'latest should be called for each action')
-  t.is(mockSetVersion.callCount, 3, 'setVersion should be called for each action')
-  t.pass('command should handle various option combinations')
-})
-
-test('use command preAction should be called before action', async (t) => {
-  const { sandbox, mockLogger, mockTestcwd } = t.context
-
-  const { default: UseCommand } = await esmock('./use.js', {
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    }
-  }, {
-    '#lib/logger/index.js': {
-      default: () => mockLogger
-    }
-  })
-
-  const command = new UseCommand()
-  command.logger = mockLogger
-  command.debug = sandbox.stub()
-
-  // Mock Commander.js command object
-  const mockCommand = {
-    name: () => 'use',
-    opts: () => ({})
-  }
-
-  // Verify preAction exists and can be called
-  t.is(typeof command.preAction, 'function', 'preAction should be a function')
-
-  // Call preAction (would be called by Commander.js before action)
-  command.preAction(mockCommand)
-
-  // Verify testcwd was called
-  t.true(mockTestcwd.called, 'testcwd should validate project directory')
-})
-
-test('use command should have correct command definition', async (t) => {
-  const { sandbox, mockLogger, mockTestcwd } = t.context
-
-  const { default: UseCommand } = await esmock('./use.js', {
-    '#helpers/test-cwd.js': {
-      default: mockTestcwd
-    }
-  }, {
-    '#lib/logger/index.js': {
-      default: () => mockLogger
-    }
-  })
-
-  const command = new UseCommand()
-  command.logger = mockLogger
-  command.debug = sandbox.stub()
-
-  t.is(command.name, 'use', 'command name should be "use"')
-  t.truthy(command.description, 'command should have description')
-  t.truthy(command.summary, 'command should have summary')
-  t.truthy(command.version, 'command should have version')
-  t.true(Array.isArray(command.args), 'command should have args array')
-  t.is(command.args.length, 1, 'command should have 1 argument')
-})