Skip to content

CHANGELOG.md

Latest commit

 

History

History
236 lines (128 loc) · 13.2 KB

CHANGELOG.md

File metadata and controls

236 lines (128 loc) · 13.2 KB

Changelog

4.1.0 (2026-02-03)

Features

  • add shell completion generation for bash, zsh, and fish (#32) (d651732)

Bug Fixes

  • show built-in options in help output (#33) (37c20e2)

4.0.1 (2026-02-01)

Bug Fixes

  • default color theme changes for popular schemes (c6198d5)

4.0.0 (2026-01-10)

⚠ BREAKING CHANGES

  • The .command(name, cliBuilder, options?) overload has been removed. Users must migrate to the factory pattern as detailed in README.md.

Features

  • docs: add custom mermaid diagram plugin for TypeDoc (9ef6cc6)
  • remove direct CliBuilder pattern for nested commands (88c0251)

Bug Fixes

  • throw when encountering a thenable in parse() (74ace9c)

3.6.2 (2026-01-09)

Bug Fixes

  • resolve symlinks when auto-detecting version from package.json (5cab7f3)

3.6.1 (2026-01-09)

Bug Fixes

  • auto-detect version from package.json when not provided (2ec0eb3)

3.6.0 (2026-01-09)

Features

3.5.2 (2026-01-07)

Bug Fixes

  • help: properly delegate --help to nested command builders (f05c30a)
  • require Node.js v20+ (6aa61e3)

3.5.1 (2026-01-07)

Bug Fixes

  • globals: merge globals instead of replacing when called multiple times (2aaa0a7)

3.5.0 (2026-01-07)

Features

3.4.0 (2026-01-07)

Features

  • add helper types for inferring parser values (24d145a)
  • nested: add factory pattern for nested commands with typed parent globals (#18) (c1514f9)

3.3.0 (2026-01-06)

Features

  • add automatic --no-<flag> support for boolean options (6dfa924)
  • add camelCaseValues transform for kebab-to-camel option keys (ed83b73)
  • alias bargs.create to bargs (or vice-versa) (d958763)

Bug Fixes

  • address PR review comments (aa94953)

3.2.0 (2026-01-06)

Features

  • add support for nested commands (subcommands) (85aa259)

Bug Fixes

  • types: export EnumArrayOption (5869e1e)

3.1.0 (2026-01-06)

Features

  • add enum array option type (bd797c9)

3.0.1 (2026-01-06)

Bug Fixes

  • preserve Parser/Command interface properties in build (259646f)

3.0.0 (2026-01-06)

⚠ BREAKING CHANGES

  • none, additive only
  • The pipe() function has been removed from the public API.
  • Complete API redesign

Features

  • add merge() combinator for combining parsers (7c2c1ca)
  • redesign API with fluent builder and combinator-style composition (d3688c8)

Code Refactoring

2.0.0 (2026-01-04)

⚠ BREAKING CHANGES

  • types: transforms must appear before handler in config object for TypeScript to infer transformed types in handler parameters

Features

  • types: add TGlobalTransforms type parameter to CommandConfig (f91683a)

Bug Fixes

  • type inference issues; inference no longer reliant on property ordering (43cb4fb)
  • types: improve type inference for transforms and command handlers (4516aa6)

1.0.0 (2026-01-02)

⚠ BREAKING CHANGES

  • types: Handler arrays are no longer supported. Use transforms for middleware-like sequential processing instead.

Features

  • bargs: execute transforms before handlers (06afa07)
  • opt: add transforms support to command builder (3d0f683)
  • parser: apply transforms in command parsing (cd2dcda)
  • parser: implement transform runner functions (f9d143a)
  • types: add transform type definitions (da7fcb2)
  • types: add transforms support to BargsConfig (d099aac)
  • types: add transforms support to CommandConfig (843c6bf)

Code Refactoring

  • types: remove handler array support in favor of transforms (2b3a6bd)

0.1.1 (2025-12-31)

Bug Fixes

  • rename package to @boneskull/bargs (3333794)

0.1.0 (2025-12-31)

Features

  • add ANSI color utilities (2461dd0)
  • add automatic version detection from package.json (095e3b9)
  • add command parsing support (de8d15c)
  • add core parser for simple CLI (8539504)
  • add core type definitions (7e869e6)
  • add enum validation and array option support (4a5f7d8)
  • add enumPos helper, sync/async API, and positional validations (dbbb0d2)
  • add epilog option with terminal hyperlink support (ea876aa)
  • add error formatting with colorful output (30abaa1)
  • add help generator without Zod introspection (0ce72c8)
  • add help text generation with grouping and colors (f430cc4)
  • add main bargs() entry point with help and version support (2a8647c)
  • add main bargs() entry point without Zod (4bf84ad)
  • add named positionals for help text display (7068779)
  • add namespaced opt builder with composition (ffa628d)
  • add new parseSimple without Zod (e68907e)
  • add new Zod-free type definitions (25ecf8f)
  • add opt.positionals() for positional schema composition (ce5f5f8)
  • add parseCommands for command-based CLIs (f551c85)
  • add schema introspection for parseArgs config extraction (8d5b7e7)
  • bargs: add options parameter to sync bargs function (1644fd3)
  • bargs: add second parameter for runtime options (53f2ddf)
  • exports: add theme utilities to public API (f6cf728)
  • help: add positional argument display with theming (2711376)
  • help: add theme support to help generators (21d024c)
  • theme: add createStyler function (8926fba)
  • theme: add defaultText and make Theme properties optional (191bee2)
  • theme: add theme types and built-in themes (b6044bb)
  • types: add BargsOptions type for runtime options (ec6dfad)

Bug Fixes

  • help: fix named positionals in POSITIONALS section (5fe6b26)
  • resolve ESLint and linting errors (96fd12f)
  • resolve test failures from environment and removed exports (8f4a5ce)
  • use bargsAsync for theme option tests after sync/async split (c9b38c3)