mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
32f8acb821
- `yargs` - Update to `v13` - Import `DetailedArguments` and `Configuration` from `yargs-parser` instead of copy-pasting - Add tests for new types - `yargs-parser` - Update to `v13` - Add more tests - Add JSDocs
132 lines
2.1 KiB
TypeScript
132 lines
2.1 KiB
TypeScript
import parse, { Arguments } from 'yargs-parser';
|
|
|
|
parse('--foo -bar');
|
|
|
|
parse(['--foo', '-bar']);
|
|
|
|
// prettier-ignore
|
|
// $ExpectError
|
|
parse(['--foo', '-bar'], {
|
|
string: 123,
|
|
});
|
|
|
|
parse(['--foo', '-bar'], {
|
|
// $ExpectError
|
|
unknown: ['b', 'a', 'r'],
|
|
});
|
|
|
|
// alias
|
|
|
|
parse(['--foo', '-bar'], {
|
|
alias: { foo: 'foo', bar: ['bar'] }
|
|
});
|
|
|
|
// array
|
|
|
|
parse(['--foo', '-bar'], {
|
|
array: ['foo', 'bar']
|
|
});
|
|
|
|
parse(['--foo', '-bar'], {
|
|
array: [{ key: 'foo', boolean: true }, { key: 'bar', number: true }],
|
|
});
|
|
|
|
// boolean
|
|
|
|
parse(['--foo', '-bar'], {
|
|
boolean: ['b', 'a', 'r'],
|
|
});
|
|
|
|
// config
|
|
|
|
parse(['--foo', '-bar'], {
|
|
config: 'path to config'
|
|
});
|
|
|
|
parse(['--foo', '-bar'], {
|
|
config: ['path to config #1', 'path to config #2']
|
|
});
|
|
|
|
parse(['--foo', '-bar'], {
|
|
config: { foo: true }
|
|
});
|
|
|
|
// configuration
|
|
|
|
parse(['--foo', '-bar'], {
|
|
configuration: {
|
|
'short-option-groups': false,
|
|
'camel-case-expansion': false,
|
|
'dot-notation': false,
|
|
'parse-numbers': false,
|
|
'boolean-negation': false,
|
|
'combine-arrays': true,
|
|
'duplicate-arguments-array': false,
|
|
'flatten-duplicate-arrays': false,
|
|
'negation-prefix': 'nope-',
|
|
'populate--': true,
|
|
'set-placeholder-key': true,
|
|
'halt-at-non-option': true
|
|
}
|
|
});
|
|
|
|
// coerce
|
|
|
|
parse(['--foo', '-bar'], {
|
|
coerce: { foo: arg => arg }
|
|
});
|
|
|
|
// count
|
|
|
|
parse(['--foo', '-bar'], {
|
|
count: ['foo', 'bar']
|
|
});
|
|
|
|
// default
|
|
|
|
parse(['--foo', '-bar'], {
|
|
default: { x: 33, y: 'hello world!' }
|
|
});
|
|
|
|
// envPrefix
|
|
|
|
parse(['--foo', '-bar'], {
|
|
envPrefix: 'YARG_',
|
|
configuration: {
|
|
// $ExpectError
|
|
'fake-key': true,
|
|
},
|
|
});
|
|
|
|
// narg
|
|
|
|
parse(['--foo', '-bar'], {
|
|
narg: { x: 2 }
|
|
});
|
|
|
|
// normalize
|
|
|
|
parse(['--foo', '-bar'], {
|
|
normalize: ['foo', 'bar']
|
|
});
|
|
|
|
// string
|
|
|
|
parse(['--foo', '-bar'], {
|
|
string: ['foo', 'bar']
|
|
});
|
|
|
|
// number
|
|
|
|
parse(['--foo', '-bar'], {
|
|
number: ['foo', 'bar']
|
|
});
|
|
|
|
parse.detailed('--foo -bar');
|
|
|
|
parse.detailed(['--foo', '-bar']);
|
|
|
|
parse.detailed(['--foo'], {});
|
|
|
|
function test(args: Arguments) { }
|