optionator 0.9.4

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 pkg:npm/optionator@0.9.4
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/optionator@0.9.4

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:6685bf5ea0fb95b92859e7898264ea7ac484f095aadf19baed4f487260dd338d","constraints":{"executionContext":"node"},"contract":["optionator parses command-line arguments and applies default values","optionator parses typed options and aliases into structured output","optionator generates formatted help text containing option definitions","optionator generates option-specific help text","optionator parseArgv handles process.argv style array"],"goal":"verify pkg:npm/optionator@0.9.4","kind":"HOW","packages":["pkg:npm/optionator@0.9.4"],"schemaVersion":1},"contractCommand":["node","test/contract.cjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/optionator@0.9.4"],"schemaVersion":1,"subject":"pkg:npm/optionator@0.9.4","verifierAdapter":"node-typescript@1"}

const optionator = require('optionator');

function createParser(customConfig = {}) {
  const defaultOptions = [
    {
      heading: 'Basic Options'
    },
    {
      option: 'help',
      alias: 'h',
      type: 'Boolean',
      description: 'displays help'
    },
    {
      option: 'port',
      alias: 'p',
      type: 'Int',
      description: 'port number to listen on',
      default: '8080'
    },
    {
      option: 'verbose',
      alias: 'v',
      type: 'Boolean',
      description: 'enable verbose logging'
    },
    {
      option: 'tags',
      alias: 't',
      type: '[String]',
      description: 'tag list',
      concatRepeatedArrays: true
    },
    {
      option: 'mode',
      alias: 'm',
      type: 'String',
      description: 'execution mode',
      enum: ['sync', 'async'],
      default: 'sync'
    }
  ];

  return optionator({
    prepend: customConfig.prepend || 'Usage: cli [options]',
    append: customConfig.append || 'Version: 1.0.0',
    options: customConfig.options || defaultOptions
  });
}

function parseCommandLine(args, customConfig) {
  const parser = createParser(customConfig);
  return parser.parse(args);
}

function parseArgv(argv, customConfig) {
  const parser = createParser(customConfig);
  return parser.parseArgv(argv);
}

function getHelpText(customConfig) {
  const parser = createParser(customConfig);
  return parser.generateHelp();
}

function getHelpForOption(optionName, customConfig) {
  const parser = createParser(customConfig);
  return parser.generateHelpForOption(optionName);
}

module.exports = {
  createParser,
  parseCommandLine,
  parseArgv,
  getHelpText,
  getHelpForOption
};

{
  "name": "verify-optionator",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "verify-optionator",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "optionator": "0.9.4"
      }
    },
    "node_modules/deep-is": {
      "version": "0.1.4",
      "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz",
      "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==",
      "license": "MIT"
    },
    "node_modules/fast-levenshtein": {
      "version": "2.0.6",
      "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz",
      "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==",
      "license": "MIT"
    },
    "node_modules/levn": {
      "version": "0.4.1",
      "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz",
      "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==",
      "license": "MIT",
      "dependencies": {
        "prelude-ls": "^1.2.1",
        "type-check": "~0.4.0"
      },
      "engines": {
        "node": ">= 0.8.0"
      }
    },
    "node_modules/optionator": {
      "version": "0.9.4",
      "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz",
      "integrity": "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==",
      "license": "MIT",
      "dependencies": {
        "deep-is": "^0.1.3",
        "fast-levenshtein": "^2.0.6",
        "levn": "^0.4.1",
        "prelude-ls": "^1.2.1",
        "type-check": "^0.4.0",
        "word-wrap": "^1.2.5"
      },
      "engines": {
        "node": ">= 0.8.0"
      }
    },
    "node_modules/prelude-ls": {
      "version": "1.2.1",
      "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz",
      "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==",
      "license": "MIT",
      "engines": {
        "node": ">= 0.8.0"
      }
    },
    "node_modules/type-check": {
      "version": "0.4.0",
      "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz",
      "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==",
      "license": "MIT",
      "dependencies": {
        "prelude-ls": "^1.2.1"
      },
      "engines": {
        "node": ">= 0.8.0"
      }
    },
    "node_modules/word-wrap": {
      "version": "1.2.5",
      "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz",
      "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==",
      "license": "MIT",
      "engines": {
        "node": ">=0.10.0"
      }
    }
  }
}

{
  "name": "verify-optionator",
  "version": "1.0.0",
  "description": "Verification sample for optionator",
  "main": "index.js",
  "license": "MIT-0",
  "scripts": {
    "test": "node test/contract.cjs"
  },
  "dependencies": {
    "optionator": "0.9.4"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/optionator@0.9.4",
  "kind": "HOW",
  "packages": [
    "pkg:npm/optionator@0.9.4"
  ]
}

const assert = require('node:assert');
const {
  createParser,
  parseCommandLine,
  parseArgv,
  getHelpText,
  getHelpForOption
} = require('../index.js');

// Contract 1: optionator parses command-line arguments and applies default values
const defaultParsed = parseCommandLine('');
assert.strictEqual(defaultParsed.port, 8080, 'Default port should be 8080');
assert.strictEqual(defaultParsed.mode, 'sync', 'Default mode should be sync');
assert.strictEqual(defaultParsed.verbose, undefined, 'Verbose flag should be undefined by default');
assert.strictEqual(defaultParsed.help, undefined, 'Help flag should be undefined by default');

// Contract 2: optionator parses typed options and aliases into structured output
const parsed = parseCommandLine('-p 3000 -v -t web,cli --mode async');
assert.strictEqual(parsed.port, 3000, 'Port option should be parsed as integer 3000');
assert.strictEqual(parsed.verbose, true, 'Verbose alias -v should parse as boolean true');
assert.deepStrictEqual(parsed.tags, ['web', 'cli'], 'Tags alias -t should parse as string array');
assert.strictEqual(parsed.mode, 'async', 'Mode option should parse as string async');

// Contract 3: optionator generates formatted help text containing option definitions
const helpText = getHelpText();
assert.ok(typeof helpText === 'string', 'Help text should be a string');
assert.ok(helpText.includes('Usage: cli [options]'), 'Help text should include usage');
assert.ok(helpText.includes('Basic Options'), 'Help text should include heading');
assert.ok(helpText.includes('-h, --help'), 'Help text should list help flag');
assert.ok(helpText.includes('-p, --port Int'), 'Help text should list port option with type Int');
assert.ok(helpText.includes('-v, --verbose'), 'Help text should list verbose option');
assert.ok(helpText.includes('-t, --tags [String]'), 'Help text should list tags option with type [String]');
assert.ok(helpText.includes('-m, --mode String'), 'Help text should list mode option with type String');
assert.ok(helpText.includes('Version: 1.0.0'), 'Help text should include version footer');

// Contract 4: optionator generates option-specific help text
const portHelp = getHelpForOption('port');
assert.ok(typeof portHelp === 'string', 'Option help should be a string');
assert.ok(portHelp.includes('-p, --port Int'), 'Option help should include alias and type');
assert.ok(portHelp.toLowerCase().includes('port number to listen on'), 'Option help should include description');

// Contract 5: optionator parseArgv handles process.argv style array
const argvParsed = parseArgv(['node', 'cli.js', '--port', '9090', '-v']);
assert.strictEqual(argvParsed.port, 9090, 'parseArgv should extract port 9090 from argv array');
assert.strictEqual(argvParsed.verbose, true, 'parseArgv should extract verbose flag from argv array');

console.log('Contract tests passed successfully.');