Skip to content
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

fix: wrap unknown args in quotes #2092

Merged
merged 6 commits into from Dec 28, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/validation.ts
Expand Up @@ -205,7 +205,7 @@ export function validation(
'Unknown argument: %s',
'Unknown arguments: %s',
unknown.length,
unknown.join(', ')
unknown.map(s => `"${s}"`).join(', ')
)
);
}
Expand Down Expand Up @@ -233,7 +233,7 @@ export function validation(
'Unknown command: %s',
'Unknown commands: %s',
unknown.length,
unknown.join(', ')
unknown.map(s => `"${s}"`).join(', ')
)
);
return true;
Expand Down
2 changes: 1 addition & 1 deletion test/command.cjs
Expand Up @@ -1528,7 +1528,7 @@ describe('Command', () => {
})
.parse('hi ben --hello=world', (err, argv, output) => {
commandRun.should.equal(false);
err.message.should.equal('Unknown argument: hello');
err.message.should.equal('Unknown argument: "hello"');
return done();
});
});
Expand Down
6 changes: 3 additions & 3 deletions test/usage.cjs
Expand Up @@ -1006,7 +1006,7 @@ describe('usage tests', () => {
' --version Show version number [boolean]',
' -f, --foo [required]',
' -b, --bar [required]',
'Unknown argument: baz',
'Unknown argument: "baz"',
]);
r.should.have.property('logs').with.length(0);
r.should.have.property('exit').and.equal(true);
Expand Down Expand Up @@ -1104,7 +1104,7 @@ describe('usage tests', () => {
' --version Show version number [boolean]',
' -f, --foo foo option',
' -b, --bar bar option',
'Unknown argument: baz',
'Unknown argument: "baz"',
]);
r.should.have.property('logs').with.length(0);
r.should.have.property('exit').and.equal(true);
Expand Down Expand Up @@ -1144,7 +1144,7 @@ describe('usage tests', () => {
' --version Show version number [boolean]',
' -f, --foo foo option',
' -b, --bar bar option',
'Unknown arguments: baz, q',
'Unknown arguments: "baz", "q"',
]);
r.should.have.property('logs').with.length(0);
r.should.have.property('exit').and.equal(true);
Expand Down
24 changes: 12 additions & 12 deletions test/validation.cjs
Expand Up @@ -460,7 +460,7 @@ describe('validation tests', () => {
yargs
.strict()
.fail(msg => {
msg.should.equal('Unknown argument: foo');
msg.should.equal('Unknown argument: "foo"');
done();
})
.parse('foo');
Expand All @@ -471,7 +471,7 @@ describe('validation tests', () => {
yargs
.strict()
.fail(msg => {
msg.should.equal('Unknown argument: foo');
msg.should.equal('Unknown argument: "foo"');
done();
})
.parse('foo -- hello');
Expand All @@ -485,7 +485,7 @@ describe('validation tests', () => {
.demand(1)
.strict()
.fail(msg => {
msg.should.equal('Unknown argument: koala');
msg.should.equal('Unknown argument: "koala"');
return done();
})
.parse();
Expand All @@ -497,7 +497,7 @@ describe('validation tests', () => {
.command('kangaroo <status>', 'kangaroo handlers')
.strict()
.fail(msg => {
msg.should.equal('Unknown argument: fast');
msg.should.equal('Unknown argument: "fast"');
return done();
})
.parse();
Expand All @@ -509,7 +509,7 @@ describe('validation tests', () => {
.command('$0 <status>', 'kangaroo handlers')
.strict()
.fail(msg => {
msg.should.equal('Unknown argument: fast');
msg.should.equal('Unknown argument: "fast"');
return done();
})
.parse();
Expand Down Expand Up @@ -1079,7 +1079,7 @@ describe('validation tests', () => {
.strict()
.option('foo', {boolean: true, describe: false})
.fail(msg => {
msg.should.equal('Unknown argument: hey');
msg.should.equal('Unknown argument: "hey"');
})
.parse();
});
Expand Down Expand Up @@ -1284,7 +1284,7 @@ describe('validation tests', () => {
.strictCommands()
.command('foo', 'foo command')
.fail(msg => {
msg.should.equal('Unknown command: blerg');
msg.should.equal('Unknown command: "blerg"');
return done();
})
.parse();
Expand All @@ -1297,7 +1297,7 @@ describe('validation tests', () => {
yargs.command('bar');
})
.fail(msg => {
msg.should.equal('Unknown command: blarg');
msg.should.equal('Unknown command: "blarg"');
return done();
})
.parse();
Expand All @@ -1320,7 +1320,7 @@ describe('validation tests', () => {
yargs.command('bar').strictCommands();
})
.fail(msg => {
msg.should.equal('Unknown command: blarg');
msg.should.equal('Unknown command: "blarg"');
return done();
})
.parse();
Expand All @@ -1346,7 +1346,7 @@ describe('validation tests', () => {
yargs()
.strictOptions()
.parse('bar -a 10', (err, argv) => {
expect(err).to.match(/Unknown argument: a/);
expect(err).to.match(/Unknown argument: "a"/);
argv.a.should.equal(10);
return done();
});
Expand All @@ -1356,7 +1356,7 @@ describe('validation tests', () => {
yargs()
.strictOptions()
.parse('foo --cool --awesome', err => {
expect(err).to.match(/Unknown arguments: cool, awesome/);
expect(err).to.match(/Unknown arguments: "cool", "awesome"/);
});
});

Expand All @@ -1370,7 +1370,7 @@ describe('validation tests', () => {
expect(err).to.equal(null);
});
y.parse('--cool --awesome', err => {
expect(err).to.match(/Unknown arguments: cool, awesome/);
expect(err).to.match(/Unknown arguments: "cool", "awesome"/);
});
});
});
Expand Down