cac 6.7.14: Command

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify cac.Command in pkg:npm/cac@6.7.14
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/cac@6.7.14
Demonstrate these symbols/APIs:
  - cac.Command
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:0b7c57f72cbb436a132403e3b4c71b8fe5eed19e60fb6e8e697417ce55476776","constraints":{"executionContext":"node"},"contract":["Command instances are instantiated by cac.command with parsed argument metadata","Command.prototype.alias registers alternate names matched by isMatched","Command.prototype.option registers flags queried by hasOption","Command.prototype.action registers handler executed with parsed arguments and options","Command.prototype.allowUnknownOptions allows arbitrary flags on the command"],"goal":"verify cac.Command in pkg:npm/cac@6.7.14","kind":"HOW","packages":["pkg:npm/cac@6.7.14"],"schemaVersion":1,"symbols":["cac.Command"]},"contractCommand":["node","test/contract.js"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/cac@6.7.14"],"schemaVersion":1,"subject":"pkg:npm/cac@6.7.14","symbols":["cac.Command"],"verifierAdapter":"node-typescript@1"}

const { cac, Command } = require('cac');

/**
 * Registers a deploy command on the given CLI instance.
 * @param {import('cac').CAC} cli
 * @returns {import('cac').Command}
 */
function registerDeployCommand(cli) {
  const cmd = cli
    .command('deploy <environment> [target]', 'Deploy project to target environment')
    .alias('d')
    .option('-f, --force', 'Force deployment without confirmation')
    .option('--retries <count>', 'Number of retries on failure', { default: 3 })
    .allowUnknownOptions();

  return cmd;
}

/**
 * Creates and configures a CLI instance with a deploy command and an optional action handler.
 * @param {Function} [actionHandler]
 * @returns {{ cli: import('cac').CAC, command: import('cac').Command }}
 */
function createDeployCli(actionHandler) {
  const cli = cac('deploy-tool');
  const command = registerDeployCommand(cli);
  if (actionHandler) {
    command.action(actionHandler);
  }
  return { cli, command };
}

module.exports = {
  Command,
  registerDeployCommand,
  createDeployCli,
};

{
  "name": "cac-command-sample",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "cac-command-sample",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "cac": "6.7.14"
      }
    },
    "node_modules/cac": {
      "version": "6.7.14",
      "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz",
      "integrity": "sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==",
      "license": "MIT",
      "engines": {
        "node": ">=8"
      }
    }
  }
}

{
  "name": "cac-command-sample",
  "version": "1.0.0",
  "description": "Verify cac.Command in cac",
  "main": "index.js",
  "scripts": {
    "test": "node test/contract.js"
  },
  "dependencies": {
    "cac": "6.7.14"
  },
  "private": true,
  "license": "MIT-0"
}

{
  "schemaVersion": 1,
  "goal": "verify cac.Command in pkg:npm/cac@6.7.14",
  "kind": "HOW",
  "packages": [
    "pkg:npm/cac@6.7.14"
  ],
  "symbols": [
    "cac.Command"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

const assert = require('assert');
const { cac, Command } = require('cac');
const { registerDeployCommand, createDeployCli } = require('../index.js');

// 1. Command instances are instantiated by cac.command with parsed argument metadata
const cli = cac('test-cli');
const cmd = registerDeployCommand(cli);
assert.strictEqual(cmd instanceof Command, true, 'cli.command should return an instance of Command');
assert.strictEqual(cmd.name, 'deploy', 'command name should be parsed from rawName');
assert.strictEqual(cmd.args.length, 2, 'command should have parsed two argument definitions');
assert.deepStrictEqual(
  cmd.args.map((a) => ({ required: a.required, value: a.value })),
  [
    { required: true, value: 'environment' },
    { required: false, value: 'target' },
  ],
  'command should correctly parse required and optional argument definitions'
);

// 2. Command.prototype.alias registers alternate names matched by isMatched
assert.strictEqual(cmd.isMatched('deploy'), true, 'command should match its primary name');
assert.strictEqual(cmd.isMatched('d'), true, 'command should match its registered alias');
assert.strictEqual(cmd.isMatched('other'), false, 'command should not match an unregistered name');

// 3. Command.prototype.option registers flags queried by hasOption
assert.ok(cmd.hasOption('f'), 'command should have registered short flag -f');
assert.ok(cmd.hasOption('force'), 'command should have registered long flag --force');
assert.ok(cmd.hasOption('retries'), 'command should have registered --retries');
assert.strictEqual(cmd.hasOption('nonexistent'), undefined, 'unregistered option should return undefined');

// 4. Command.prototype.action registers handler executed with parsed arguments and options
let handlerInvoked = false;
let capturedEnvironment = null;
let capturedTarget = null;
let capturedOptions = null;

const { cli: actionCli } = createDeployCli((env, target, opts) => {
  handlerInvoked = true;
  capturedEnvironment = env;
  capturedTarget = target;
  capturedOptions = opts;
});

actionCli.parse(['node', 'cli.js', 'd', 'staging', 'cluster-1', '--force', '--custom-meta', 'abc'], {
  run: true,
});

assert.strictEqual(handlerInvoked, true, 'command action callback should be called on parse');
assert.strictEqual(capturedEnvironment, 'staging', 'action should receive positional environment argument');
assert.strictEqual(capturedTarget, 'cluster-1', 'action should receive positional target argument');
assert.strictEqual(capturedOptions.force, true, 'action should receive parsed force option');
assert.strictEqual(capturedOptions.retries, 3, 'action should receive default retries option value');

// 5. Command.prototype.allowUnknownOptions allows arbitrary flags on the command
assert.strictEqual(cmd.config.allowUnknownOptions, true, 'allowUnknownOptions should configure command');
assert.strictEqual(
  capturedOptions['customMeta'],
  'abc',
  'allowUnknownOptions should preserve arbitrary extra flags in options'
);

console.log('Contract assertions passed.');