1.1.0

Dependency Changes

• Bump shargs-parser to 1.1.0.

1.0.2

Dependency Changes

• Bump shargs-usage to 1.0.1.

Documentation Changes

• Document new behaviour of synopses after the bug fix in shargs-usage 1.0.1.

1.0.1

Documentation Changes

• Add an example for three-tiered configuration using shargs: A config file, environment variables, and command-line arguments.

1.0.0

We are delighted to announce the availability of shargs 1.0.0!

Release Summary

shargs 1.0.0 is a bundle release of four different modules from the shargs ecosystem:

• shargs-core 1.0.0 provides core functions for defining command-line parsers, e.g. parser, parserSync, and verifyCommand (read release notes).
• shargs-opts 1.0.0 provides a DSL for describing command-line options, e.g. command, number, string, and subcommand (read release notes).
• shargs-parser 1.0.0 is an extensive library of 37 functions that add various features to shargs-core parsers, e.g. splitShortOpts, requireOpts, suggestOpts, cast, setDefaultValues, bestGuessArgs, bestGuessCast, and flagsAsBools (read release notes).
• shargs-usage 1.0.0 is a DSL for dynamically generating usage documentation based on command-line option objects and provides functions like optsDef, optsList, and synopsis, decorate, layout, and usage (read release notes).

0.26.2

Dependency Changes

• Bump shargs-parser to 0.6.2.

0.26.1

Dependency Changes

• Bump shargs-core to 0.26.1.

0.26.0

This release changes the essence of the shargs module: It acts now as a bundle installation for the shargs ecosystem. Its former role of providing core functions is transferred to the shargs-core module. Although this release stays backwards compatible with version 0.25.0, it is recommended to follow the migration guide below.

Notable Changes

• Move all code from this module to the shargs-core module.
• Add shargs-core, shargs-opts, shargs-parser, and shargs-usage as dependencies.
• Provide new public APIs: shargs-core as require('shargs') (to be backwards compatible) and require('shargs/core'), shargs-opts as require('shargs/opts'), shargs-parser as require('shargs/parser'), and shargs-usage as require('shargs/usage').

Documentation Changes

• Add information about bundle and modules installations to the README.

Migration Guide

Please read up on the differences between the bundle and module installations in the README and decide which type of installation you prefer.

If you wish to go with a module installation, replace the shargs dependency with the shargs-core dependency (shargs-core version 0.26.0). Then, replace all require('shargs') with require('shargs-core') (or import 'shargs' with import 'shargs-core').

If you wish to go with a bundle installation, upgrade the shargs dependency to 0.26.0 and uninstall the shargs-opts, shargs-usage, and shargs-parser dependencies, since they are included in the shargs bundle. Do not uninstall the shargs-repl dependency! It is not part of the bundle.

0.25.0

Notable Changes

• The lexer, lexerSync and lexerF functions are removed from the API. They may be replaced with parser and parserSync functions having identity functions in their toArgs, args and fromArgs stages.
• Factor out verifyCommand from toOpts and expose it in the public API.
• Remove parserF from the public API since it has a very niche use case.

Notable Bug Fixes

• Make sure that args entries do not contain white spaces (e.g. '--help' is valid, '--he lp' is not).

Documentation Changes

• Streamline the whole documentation in README.

0.24.9

Documentation Changes

• Add shargs-example-sync-sql to examples.

0.24.8

Bug Fixes

• Fixed a bug that caused positional arguments of subcommands of subcommands to be parsed incorrectly.