@phylum/command v1.2.0

@phylum/command

Configurable command line parser

Usage

npm i @phylum/command

import { CommandSpec } from '@phylum/command';

new CommandSpec()
	.add({name: 'foo', multiple: true})
	.add({name: 'bar', alias: 'b' type: 'flag'})
	.parse(['--foo', 'bar', 'baz', '-b']);

// => { foo: ['bar', 'baz'], bar: true }

Command Line Format

Options

options.partial

If specified, unknown arguments will be ignored instead of throwing an error.

new CommandSpec()
	.add({name: 'foo'})
	.parse(['--foo', 'bar', '--baz'], {partial: true});

// => { foo: 'bar' }

options.sparse

If specified, arguments that follow others may be associated with the default argument.

new CommandSpec()
	.add({name: 'foo', default: true})
	.add({name: 'bar'})
	.parse(['--bar', 'baz', 'foo'], {sparse: true});

// => { bar: 'baz', foo: 'foo' }

Custom Types

function myType(value: string, spec: ArgumentSpec, options: ArgumentOptions) {
	return value.toUpperCase();
}

new CommandSpec()
	.add({name: 'foo', type: myType})
	.parse(['--foo', 'bar']);

// => { foo: 'BAR' }

Packaged Code