Fix flag default values validation (#238)

sindresorhus · May 4, 2023 · c3bf62b · c3bf62b
1 parent 525e442
commit c3bf62b
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 4 deletions.
diff --git a/source/options.js b/source/options.js
@@ -27,7 +27,7 @@ const validateOptions = options => {
 				},
 			},
 			defaultNotInChoices: {
-				filter: ([, flag]) => flag.default && Array.isArray(flag.choices) && [flag.default].flat().every(value => flag.choices.includes(value)),
+				filter: ([, flag]) => flag.default && Array.isArray(flag.choices) && ![flag.default].flat().every(value => flag.choices.includes(value)),
 				message: flagKeys => `Each value of the option \`default\` must exist within the option \`choices\`. Invalid flags: ${joinFlagKeys(flagKeys)}`,
 			},
 		},

diff --git a/test/choices.js b/test/choices.js
@@ -177,8 +177,8 @@ test('choices - choices must be of the same type', t => {
 	}, {message: 'Each value of the option `choices` must be of the same type as its flag. Invalid flags: (`--number`, type: \'number\'), (`--boolean`, type: \'boolean\')'});
 });
 
-test('choices - default must only include valid choices', t => {
-	t.throws(() => {
+test('choices - success when each value of default exist within the option choices', t => {
+	t.notThrows(() => {
 		meow({
 			importMeta,
 			flags: {
@@ -187,7 +187,44 @@ test('choices - default must only include valid choices', t => {
 					choices: [1, 2, 3],
 					default: 1,
 				},
+				string: {
+					type: 'string',
+					choices: ['dog', 'cat', 'unicorn'],
+					default: 'dog',
+				},
+				multiString: {
+					type: 'string',
+					choices: ['dog', 'cat', 'unicorn'],
+					default: ['dog', 'cat'],
+					isMultiple: true,
+				},
+			},
+		});
+	});
+});
+
+test('choices - throws when default does not only include valid choices', t => {
+	t.throws(() => {
+		meow({
+			importMeta,
+			flags: {
+				number: {
+					type: 'number',
+					choices: [1, 2, 3],
+					default: 8,
+				},
+				string: {
+					type: 'string',
+					choices: ['dog', 'cat'],
+					default: 'unicorn',
+				},
+				multiString: {
+					type: 'string',
+					choices: ['dog', 'cat'],
+					default: ['dog', 'unicorn'],
+					isMultiple: true,
+				},
 			},
 		});
-	}, {message: 'Each value of the option `default` must exist within the option `choices`. Invalid flags: `--number`'});
+	}, {message: 'Each value of the option `default` must exist within the option `choices`. Invalid flags: `--number`, `--string`, `--multiString`'});
 });