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

Allow boolean default for flag option #987

Merged
merged 5 commits into from Jul 25, 2019
Merged

Allow boolean default for flag option #987

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5a27ec4
Add support for default value for boolean flags
shadowspawn Jun 30, 2019
3ff940b
Expand testing for boolean flags to cover new features
shadowspawn Jul 24, 2019
b3ccac2
Add written description of boolean default value for --foo/--no-foo
shadowspawn Jul 24, 2019
e346d67
Avoid eslint warnings for requiring shouldjs in simple way
shadowspawn Jul 25, 2019
bb4af52
Restore test.options.bool.small.js, KISS
shadowspawn Jul 25, 2019
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
3 changes: 2 additions & 1 deletion Readme.md
View file
Open in desktop
Expand Up @@ -101,8 +101,9 @@ cheese: stilton

You can specify a boolean option long name with a leading `no-` to set the option value to false when used.
Defined alone this also makes the option true by default.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In rereading this and the edits, I'm not sure we're using consistent vocabulary on this specific line; i.e. it can be unclear whether "define" (or "specify", "add", "set", etc.) means "when defining the program" or "when invoking the program via the CLI."

It could just be that the sentence is slightly awkwardly worded (and sorry to comment on something that isn't a change in this commit).

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with the awkward and potential for misinterpretation. I have struggled with the wording a couple of times, but at least we do have examples to consult. I'm not planning to have another go in this PR.

If you define `foo` first, adding `--no-foo` does not change the default value.

If you define `--foo` first, adding `--no-foo` does not change the default value from what it would
otherwise be. You can specify a default boolean value for a boolean flag and it can be overridden on command line.

```js
const program = require('commander');
Expand Down
6 changes: 3 additions & 3 deletions index.js
View file
Open in desktop
Expand Up @@ -402,8 +402,8 @@ Command.prototype.option = function(flags, description, fn, defaultValue) {
}
}

// preassign default value only for --no-*, [optional], or <required>
if (option.negate || option.optional || option.required) {
// preassign default value for --no-*, [optional], <required>, or plain flag if boolean value
if (option.negate || option.optional || option.required || typeof defaultValue === 'boolean') {
// when --no-foo we make sure default is true, unless a --foo option is already defined
if (option.negate) {
var opts = self.opts();
Expand All @@ -427,7 +427,7 @@ Command.prototype.option = function(flags, description, fn, defaultValue) {
val = fn(val, self[name] === undefined ? defaultValue : self[name]);
}

// unassigned or bool
// unassigned or boolean value
if (typeof self[name] === 'boolean' || typeof self[name] === 'undefined') {
// if no value, negate false, and we have a default, then use it!
if (val == null) {
Expand Down
37 changes: 25 additions & 12 deletions test/test.options.bool.js
View file
Open in desktop
@@ -1,15 +1,28 @@
/**
* Module dependencies.
*/
const commander = require('../');
// eslint-disable-next-line no-unused-vars
const should = require('should');
shadowspawn marked this conversation as resolved.
Show resolved Hide resolved

var program = require('../')
, should = require('should');
// Test simple flag and negatable flag

program
.version('0.0.1')
.option('-p, --pepper', 'add pepper')
.option('-c, --no-cheese', 'remove cheese');
function simpleFlagProgram() {
const program = new commander.Command();
program
.option('-p, --pepper', 'add pepper')
.option('-C, --no-cheese', 'remove cheese');
return program;
}

program.parse(['node', 'test', '--pepper']);
program.pepper.should.be.true();
program.cheese.should.be.true();
const simpleFlagNoOptions = simpleFlagProgram();
simpleFlagNoOptions.parse(['node', 'test']);
simpleFlagNoOptions.should.not.have.property('pepper');
simpleFlagNoOptions.cheese.should.be.true();

const simpleFlagLong = simpleFlagProgram();
simpleFlagLong.parse(['node', 'test', '--pepper', '--no-cheese']);
simpleFlagLong.pepper.should.be.true();
simpleFlagLong.cheese.should.be.false();

const simpleFlagShort = simpleFlagProgram();
shadowspawn marked this conversation as resolved.
Show resolved Hide resolved
simpleFlagShort.parse(['node', 'test', '-p', '-C']);
simpleFlagShort.pepper.should.be.true();
simpleFlagShort.cheese.should.be.false();
95 changes: 64 additions & 31 deletions test/test.options.bool.no.js
View file
Open in desktop
@@ -1,31 +1,64 @@
/**
* Module dependencies.
*/

var program = require('../')
, should = require('should');

program
.version('0.0.1')
.option('-e, --everything', 'add all of the toppings')
.option('-p, --pepper', 'add pepper')
.option('-P, --no-pepper', 'remove pepper')
.option('-c|--no-cheese', 'remove cheese');

program.parse(['node', 'test']);
program.should.not.have.property('everything');
program.should.not.have.property('pepper');
program.cheese.should.be.true();

program.parse(['node', 'test', '--everything']);
program.everything.should.be.true();
program.should.not.have.property('pepper');
program.cheese.should.be.true();

program.parse(['node', 'test', '--pepper']);
program.pepper.should.be.true();
program.cheese.should.be.true();

program.parse(['node', 'test', '--everything', '--no-pepper', '--no-cheese']);
program.pepper.should.be.false();
program.cheese.should.be.false();
const commander = require('../');
// eslint-disable-next-line no-unused-vars
const should = require('should');

// Test combination of flag and --no-flag
// (negatable flag on its own is tested in test.options.bool.js)

function flagProgram(defaultValue) {
const program = new commander.Command();
program
.option('-p, --pepper', 'add pepper', defaultValue)
.option('-P, --no-pepper', 'remove pepper');
return program;
}

// Flag with no default, normal usage.

const programNoDefaultNoOptions = flagProgram();
programNoDefaultNoOptions.parse(['node', 'test']);
programNoDefaultNoOptions.should.not.have.property('pepper');

const programNoDefaultWithFlag = flagProgram();
programNoDefaultWithFlag.parse(['node', 'test', '--pepper']);
programNoDefaultWithFlag.pepper.should.be.true();

const programNoDefaultWithNegFlag = flagProgram();
programNoDefaultWithNegFlag.parse(['node', 'test', '--no-pepper']);
programNoDefaultWithNegFlag.pepper.should.be.false();

// Flag with default, say from an environment variable.

const programTrueDefaultNoOptions = flagProgram(true);
programTrueDefaultNoOptions.parse(['node', 'test']);
programTrueDefaultNoOptions.pepper.should.be.true();

const programTrueDefaultWithFlag = flagProgram(true);
programTrueDefaultWithFlag.parse(['node', 'test', '-p']);
programTrueDefaultWithFlag.pepper.should.be.true();

const programTrueDefaultWithNegFlag = flagProgram(true);
programTrueDefaultWithNegFlag.parse(['node', 'test', '-P']);
programTrueDefaultWithNegFlag.pepper.should.be.false();

const programFalseDefaultNoOptions = flagProgram(false);
programFalseDefaultNoOptions.parse(['node', 'test']);
programFalseDefaultNoOptions.pepper.should.be.false();

const programFalseDefaultWithFlag = flagProgram(false);
programFalseDefaultWithFlag.parse(['node', 'test', '-p']);
programFalseDefaultWithFlag.pepper.should.be.true();

const programFalseDefaultWithNegFlag = flagProgram(false);
programFalseDefaultWithNegFlag.parse(['node', 'test', '-P']);
programFalseDefaultWithNegFlag.pepper.should.be.false();

// Flag specified both ways, last one wins.

const programNoYes = flagProgram();
programNoYes.parse(['node', 'test', '--no-pepper', '--pepper']);
programNoYes.pepper.should.be.true();

const programYesNo = flagProgram();
programYesNo.parse(['node', 'test', '--pepper', '--no-pepper']);
programYesNo.pepper.should.be.false();
15 changes: 0 additions & 15 deletions test/test.options.bool.small.js
View file
Open in desktop

This file was deleted.

18 changes: 9 additions & 9 deletions test/test.options.defaults.given.js
View file
Open in desktop
@@ -1,22 +1,22 @@
/**
* Module dependencies.
*/

var program = require('../')
, should = require('should');
const program = require('../');
// eslint-disable-next-line no-unused-vars
const should = require('should');

program
.version('0.0.1')
.option('-a, --anchovies', 'Add anchovies?')
.option('-o, --onions', 'Add onions?', true)
.option('-O, --no-onions', 'No onions')
.option('-t, --tomatoes', 'Add tomatoes?', false)
.option('-T, --no-tomatoes', 'No tomatoes')
.option('-v, --olives', 'Add olives? Sorry we only have black.', 'black')
.option('-s, --no-sauce', 'Uh… okay')
.option('-r, --crust <type>', 'What kind of crust would you like?', 'hand-tossed')
.option('-c, --cheese [type]', 'optionally specify the type of cheese', 'mozzarella');

program.parse(['node', 'test', '--anchovies', '--onions', '--olives', '--no-sauce', '--crust', 'thin', '--cheese', 'wensleydale']);
program.parse(['node', 'test', '--anchovies', '--no-onions', '--tomatoes', '--olives', '--no-sauce', '--crust', 'thin', '--cheese', 'wensleydale']);
program.should.have.property('anchovies', true);
program.should.have.property('onions', true);
program.should.have.property('onions', false);
program.should.have.property('tomatoes', true);
program.should.have.property('olives', 'black');
program.should.have.property('sauce', false);
program.should.have.property('crust', 'thin');
Expand Down
20 changes: 9 additions & 11 deletions test/test.options.defaults.js
View file
Open in desktop
@@ -1,25 +1,23 @@
/**
* Module dependencies.
*/

var program = require('../')
, should = require('should');
const program = require('../');
// eslint-disable-next-line no-unused-vars
const should = require('should');

program
.version('0.0.1')
.option('-a, --anchovies', 'Add anchovies?')
.option('-o, --onions', 'Add onions?', true)
.option('-O, --no-onions', 'No onions')
.option('-t, --tomatoes', 'Add tomatoes?', false)
.option('-T, --no-tomatoes', 'No tomatoes')
.option('-v, --olives', 'Add olives? Sorry we only have black.', 'black')
.option('-s, --no-sauce', 'Uh… okay')
.option('-r, --crust <type>', 'What kind of crust would you like?', 'hand-tossed')
.option('-c, --cheese [type]', 'optionally specify the type of cheese', 'mozzarella');

program.should.have.property('_name', '');

program.parse(['node', 'test']);
program.should.have.property('_name', 'test');

program.should.not.have.property('anchovies');
program.should.not.have.property('onions');
program.should.have.property('onions', true);
program.should.have.property('tomatoes', false);
program.should.not.have.property('olives');
program.should.have.property('sauce', true);
program.should.have.property('crust', 'hand-tossed');
Expand Down