Skip to content

Commit

Permalink
feat!: maybeCoerceNumber() now takes into account arrays (#187)
Browse files Browse the repository at this point in the history
BREAKING CHANGE: unless "parse-numbers" is set to "false", arrays of numeric strings are now parsed as numbers, rather than strings.
  • Loading branch information
juergba authored and bcoe committed Jul 13, 2019
1 parent 17ca3bd commit 31c204b
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 4 deletions.
6 changes: 4 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,9 @@ function parse (args, opts) {
if (typeof val === 'string') val = val === 'true'
}

var value = maybeCoerceNumber(key, val)
var value = Array.isArray(val)
? val.map(function (v) { return maybeCoerceNumber(key, v) })
: maybeCoerceNumber(key, val)

// increment a count given as arg (either no value or value parsed as boolean)
if (checkAllAliases(key, flags.counts) && (isUndefined(value) || typeof value === 'boolean')) {
Expand All @@ -486,7 +488,7 @@ function parse (args, opts) {
}

function maybeCoerceNumber (key, value) {
if (!checkAllAliases(key, flags.strings)) {
if (!checkAllAliases(key, flags.strings) && !checkAllAliases(key, flags.bools) && !Array.isArray(value)) {
const shouldCoerceNumber = isNumber(value) && configuration['parse-numbers'] && (
Number.isSafeInteger(Math.floor(value))
)
Expand Down
17 changes: 15 additions & 2 deletions test/yargs-parser.js
Original file line number Diff line number Diff line change
Expand Up @@ -2160,6 +2160,19 @@ describe('yargs-parser', function () {
expect(parsed['bar']).to.equal(6)
expect(parsed['baz']).to.equal(7)
})

it('should coerce elements of number typed arrays to numbers', function () {
var parsed = parser(['--foo', '4', '--foo', '5', '2'], {
array: ['foo'],
configObjects: [{ foo: ['1', '2', '3'] }],
configuration: {
'combine-arrays': true,
'flatten-duplicate-arrays': false
}
})

expect(parsed['foo']).to.deep.equal([[4], [5, 2], [1, 2, 3]])
})
})

describe('boolean negation', function () {
Expand Down Expand Up @@ -2445,15 +2458,15 @@ describe('yargs-parser', function () {
})
describe('duplicate=true, flatten=false,', function () {
describe('type=array', function () {
it('[-x 1 -x 2 -x 3] => [1, 2, 3]', function () {
it('[-x 1 -x 2 -x 3] => [[1], [2], [3]]', function () {
var parsed = parser('-x 1 -x 2 -x 3', {
array: ['x'],
configuration: {
'duplicate-arguments-array': true,
'flatten-duplicate-arrays': false
}
})
parsed['x'].should.deep.equal([1, 2, 3])
parsed['x'].should.deep.equal([[1], [2], [3]])
})
it('[-x 1 2 3 -x 2 3 4] => [[1, 2, 3], [ 2, 3, 4]]', function () {
var parsed = parser('-x 1 2 3 -x 2 3 4', {
Expand Down

0 comments on commit 31c204b

Please sign in to comment.