Fix reporting missing required flags (#168)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>

Author: alexmcmanus

index.d.ts

@@ -32,7 +32,7 @@ declare namespace meow {
 		/**
 		Define argument flags.
 
-		The key is the flag name and the value is an object with any of:
+		The key is the flag name in camel-case and the value is an object with any of:
 
 		- `type`: Type of value. (Possible values: `string` `boolean` `number`)
 		- `alias`: Usually used to define a short flag alias.
@@ -42,6 +42,8 @@ declare namespace meow {
 		- `isMultiple`: Indicates a flag can be set multiple times. Values are turned into an array. (Default: false)
 			Multiple values are provided by specifying the flag multiple times, for example, `$ foo -u rainbow -u cat`. Space- or comma-separated values are *not* supported.
 
+		Note that flags are always defined using a camel-case key (`myKey`), but will match arguments in kebab-case (`--my-key`).
+
 		@example
 		```
 		flags: {

index.js

@@ -3,6 +3,7 @@ const path = require('path');
 const buildParserOptions = require('minimist-options');
 const parseArguments = require('yargs-parser');
 const camelCaseKeys = require('camelcase-keys');
+const decamelize = require('decamelize');
 const decamelizeKeys = require('decamelize-keys');
 const trimNewlines = require('trim-newlines');
 const redent = require('redent');
@@ -50,7 +51,14 @@ const getMissingRequiredFlags = (flags, receivedFlags, input) => {
 const reportMissingRequiredFlags = missingRequiredFlags => {
 	console.error(`Missing required flag${missingRequiredFlags.length > 1 ? 's' : ''}`);
 	for (const flag of missingRequiredFlags) {
-		console.error(`\t--${flag.key}${flag.alias ? `, -${flag.alias}` : ''}`);
+		console.error(`\t--${decamelize(flag.key, '-')}${flag.alias ? `, -${flag.alias}` : ''}`);
+	}
+};
+
+const validateOptions = ({flags}) => {
+	const invalidFlags = Object.keys(flags).filter(flagKey => flagKey.includes('-') && flagKey !== '--');
+	if (invalidFlags.length > 0) {
+		throw new Error(`Flag keys may not contain '-': ${invalidFlags.join(', ')}`);
 	}
 };
 
@@ -125,6 +133,7 @@ const meow = (helpText, options) => {
 		hardRejection();
 	}
 
+	validateOptions(options);
 	let parserOptions = {
 		arguments: options.input,
 		...buildParserFlags(options)

package.json

@@ -42,6 +42,7 @@
 	"dependencies": {
 		"@types/minimist": "^1.2.0",
 		"camelcase-keys": "^6.2.2",
+		"decamelize": "^1.2.0",
 		"decamelize-keys": "^1.1.0",
 		"hard-rejection": "^2.1.0",
 		"minimist-options": "4.1.0",

readme.md

@@ -132,7 +132,7 @@ Type: `object`
 
 Define argument flags.
 
-The key is the flag name and the value is an object with any of:
+The key is the flag name in camel-case and the value is an object with any of:
 
 - `type`: Type of value. (Possible values: `string` `boolean` `number`)
 - `alias`: Usually used to define a short flag alias.
@@ -145,6 +145,8 @@ The key is the flag name and the value is an object with any of:
 - `isMultiple`: Indicates a flag can be set multiple times. Values are turned into an array. (Default: false)
 	- Multiple values are provided by specifying the flag multiple times, for example, `$ foo -u rainbow -u cat`. Space- or comma-separated values are [currently *not* supported](https://github.com/sindresorhus/meow/issues/164).
 
+Note that flags are always defined using a camel-case key (`myKey`), but will match arguments in kebab-case (`--my-key`).
+
 Example:
 
 ```js

test/fixtures/fixture-required.js

@@ -18,6 +18,10 @@ const cli = meow({
 			type: 'number',
 			isRequired: true
 		},
+		kebabCase: {
+			type: 'string',
+			isRequired: true
+		},
 		notRequired: {
 			type: 'string'
 		}

test/is-required-flag.js

@@ -15,7 +15,8 @@ test('spawn cli and test not specifying required flags', async t => {
 		t.regex(stderr, /Missing required flag/);
 		t.regex(stderr, /--test, -t/);
 		t.regex(stderr, /--number/);
-		t.notRegex(stderr, /--notRequired/);
+		t.regex(stderr, /--kebab-case/);
+		t.notRegex(stderr, /--not-required/);
 	}
 });
 
@@ -24,7 +25,9 @@ test('spawn cli and test specifying all required flags', async t => {
 		'-t',
 		'test',
 		'--number',
-		'6'
+		'6',
+		'--kebab-case',
+		'test'
 	]);
 	t.is(stdout, 'test,6');
 });
@@ -63,7 +66,7 @@ test('spawn cli and test setting isRequired as a function and specifying only th
 		const {stderr, message} = error;
 		t.regex(message, /Command failed with exit code 2/);
 		t.regex(stderr, /Missing required flag/);
-		t.regex(stderr, /--withTrigger/);
+		t.regex(stderr, /--with-trigger/);
 	}
 });
 

test/test.js

@@ -99,6 +99,13 @@ test('single character flag casing should be preserved', t => {
 	t.deepEqual(meow({argv: ['-F']}).flags, {F: true});
 });
 
+test('flag declared in kebab-case is an error', t => {
+	const error = t.throws(() => {
+		meow({flags: {'kebab-case': 'boolean', test: 'boolean', 'another-one': 'boolean'}});
+	});
+	t.is(error.message, 'Flag keys may not contain \'-\': kebab-case, another-one');
+});
+
 test('type inference', t => {
 	t.is(meow({argv: ['5']}).input[0], '5');
 	t.is(meow({argv: ['5']}, {input: 'string'}).input[0], '5');