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

Allow boolean default for flag option #987

Merged
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
37 changes: 25 additions & 12 deletions test/test.options.bool.js
@@ -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
@@ -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

This file was deleted.

16 changes: 6 additions & 10 deletions test/test.options.defaults.given.js
@@ -1,14 +1,10 @@
/**
* 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?')
.option('-o, --onions', 'Add onions?', true)
.option('-O, --no-onions', 'No onions')
.option('-t, --tomatoes', 'Add tomatoes?', false)
.option('-T, --no-tomatoes', 'No tomatoes')
Expand All @@ -17,9 +13,9 @@ program
.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', '--tomatoes', '--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);
Expand Down
18 changes: 6 additions & 12 deletions test/test.options.defaults.js
@@ -1,14 +1,10 @@
/**
* 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?')
.option('-o, --onions', 'Add onions?', true)
.option('-O, --no-onions', 'No onions')
.option('-t, --tomatoes', 'Add tomatoes?', false)
.option('-T, --no-tomatoes', 'No tomatoes')
Expand All @@ -17,12 +13,10 @@ program
.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);
Expand Down