Skip to content

fix: remove inaccurate and unnecessary regexp used by unknown-options-as-args #508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions lib/yargs-parser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -980,14 +980,8 @@ export class YargsParser {
const flagWithEquals = /^-+([^=]+?)=[\s\S]*$/
// e.g. '-a' or '--arg'
const normalFlag = /^-+([^=]+?)$/
// e.g. '-a-'
const flagEndingInHyphen = /^-+([^=]+?)-$/
// e.g. '-abc123'
const flagEndingInDigits = /^-+([^=]+?\d+)$/
// e.g. '-a/usr/local'
const flagEndingInNonWordCharacters = /^-+([^=]+?)\W+.*$/
// check the different types of flag styles, including negatedBoolean, a pattern defined near the start of the parse method
return !hasFlagsMatching(arg, flagWithEquals, negatedBoolean, normalFlag, flagEndingInHyphen, flagEndingInDigits, flagEndingInNonWordCharacters)
return !hasFlagsMatching(arg, flagWithEquals, negatedBoolean, normalFlag)
}

// make a best effort to pick a default value
Expand Down
110 changes: 110 additions & 0 deletions test/yargs-parser.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -3182,6 +3182,19 @@ describe('yargs-parser', function () {
k: 1
})
})
it('should ignore unknown options in short format followed by a dash character', function () {
// Somewhat redundant test since '-' is a non-word character (see next test) but '-' has own code in parser.
const argv = parser('-k- -u-', {
string: ['k'],
configuration: {
'unknown-options-as-args': true
}
})
argv.should.deep.equal({
_: ['-u-'],
k: '-'
})
})
it('should ignore unknown options in short format followed by a non-word character', function () {
const argv = parser('-k/1/ -u/2/', {
string: ['k'],
Expand Down Expand Up @@ -3217,6 +3230,103 @@ describe('yargs-parser', function () {
k: true,
v: true
})
})
// Fixes: https://github.com/yargs/yargs-parser/issues/501
it('should allow an unknown arg that resembles a known arg and contains hyphens to be used as the value of another flag in short form', function () {
{
const argv = parser('--known-arg /1/ -k --known-arg-unknown', {
string: ['k', 'known-arg'],
narg: { k: 1, 'known-arg': 1 },
configuration: {
'unknown-options-as-args': true
}
})
argv.should.deep.equal({
_: [],
k: '--known-arg-unknown',
'knownArg': '/1/',
'known-arg': '/1/',
})
}

{
const argv = parser('-k --u-u', {
string: ['k', 'u'],
narg: { k: 1, u: 1 },
configuration: {
'unknown-options-as-args': true
}
})
argv.should.deep.equal({
_: [],
k: '--u-u'
})
}
})
// Fixes: https://github.com/yargs/yargs-parser/issues/501
it('should allow an unknown arg that resembles a known arg and contains hyphens to be used as the value of another flag in long form', function () {
{
const argv = parser('-k /1/ --known-arg --k-u', {
string: ['k', 'known-arg'],
narg: { k: 1, 'known-arg': 1 },
configuration: {
'unknown-options-as-args': true
}
})
argv.should.deep.equal({
_: [],
k: '/1/',
'knownArg': '--k-u',
'known-arg': '--k-u',
})
}

{
const argv = parser('--known-arg --known-unknown', {
string: ['known-arg', 'known'],
narg: { 'known-arg': 1, 'known': 1 },
configuration: {
'unknown-options-as-args': true
}
})
argv.should.deep.equal({
_: [],
'knownArg': '--known-unknown',
'known-arg': '--known-unknown',
})
}
})
// Fixes: https://github.com/yargs/yargs-parser/issues/501
it('should allow an unknown arg that resembles a known arg and contains hyphens to be used as the value of another flag in array form', function () {
{
const argv = parser('--known-arg --known-unknown --known-not-known', {
array: ['known-arg', 'known'],
configuration: {
'unknown-options-as-args': true
}
})
argv.should.deep.equal({
_: [],
knownArg: ['--known-unknown', '--known-not-known'],
'known-arg': ['--known-unknown', '--known-not-known']
})
}

{
const argv = parser('--known-arg --k-unknown --k-not-known', {
array: ['known-arg'],
alias: { 'known-arg': ['k'] },
configuration: {
'unknown-options-as-args': true
}
})
argv.should.deep.equal({
_: [],
knownArg: ['--k-unknown', '--k-not-known'],
'known-arg': ['--k-unknown', '--k-not-known'],
k: ['--k-unknown', '--k-not-known']
})
}
})
it('should parse negative numbers', function () {
const argv = parser('-k -33', {
Expand Down