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.

Sign up for GitHub

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

Jump to bottom

Throw error on storeOptionsAsProperties() after setting option values #1928

Merged
merged 3 commits into from
Aug 19, 2023
Merged

Throw error on storeOptionsAsProperties() after setting option values #1928

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ddfeaf8
Throw error on options-as-properties config after setting option values
aweebit Aug 2, 2023
ab0239e
Add test for storeOptionsAsProperties() after setting option value
aweebit Aug 2, 2023
c5343b2
Call storeOptionsAsProperties() with appropriate parameter value in test
aweebit Aug 11, 2023
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
5 changes: 4 additions & 1 deletion lib/command.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -750,10 +750,13 @@ Expecting one of '${allowedValues.join("', '")}'`);
*/

storeOptionsAsProperties(storeAsProperties = true) {
this._storeOptionsAsProperties = !!storeAsProperties;
if (this.options.length) {
throw new Error('call .storeOptionsAsProperties() before adding options');
}
if (Object.keys(this._optionValues).length) {
throw new Error('call .storeOptionsAsProperties() before setting option values');
}
this._storeOptionsAsProperties = !!storeAsProperties;
return this;
}

Expand Down
10 changes: 9 additions & 1 deletion tests/commander.configureCommand.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,14 @@ test('when storeOptionsAsProperties() after adding option then throw', () => {
const program = new commander.Command();
program.option('--port <number>', 'port number', '80');
expect(() => {
program.storeOptionsAsProperties(false);
program.storeOptionsAsProperties();
}).toThrow();
});

test('when storeOptionsAsProperties() after setting option value then throw', () => {
const program = new commander.Command();
program.setOptionValue('foo', 'bar');
expect(() => {
program.storeOptionsAsProperties();
}).toThrow();
});