Make options required (#260)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
sindresorhus · Feb 29, 2024 · 9961bc0 · 9961bc0
1 parent c00d5c5
commit 9961bc0
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 23 deletions.
diff --git a/readme.md b/readme.md
@@ -45,7 +45,7 @@ const cli = meow(`
 	  $ foo unicorns --rainbow
 	  🌈 unicorns 🌈
 `, {
-	importMeta: import.meta,
+	importMeta: import.meta, // This is required
 	flags: {
 		rainbow: {
 			type: 'boolean',
@@ -66,7 +66,7 @@ foo(cli.input.at(0), cli.flags);
 
 ## API
 
-### meow(helpText, options?)
+### meow(helpText, options)
 ### meow(options)
 
 Returns an `object` with:
@@ -91,6 +91,7 @@ Type: `object`
 
 ##### importMeta
 
+**Required**\
 Type: `object`
 
 Pass in [`import.meta`](https://nodejs.org/dist/latest/docs/api/esm.html#esm_import_meta). This is used to find the correct package.json file.

diff --git a/source/index.d.ts b/source/index.d.ts
@@ -395,7 +395,7 @@ const cli = meow(`
 	  $ foo unicorns --rainbow
 	  🌈 unicorns 🌈
 `, {
-	importMeta: import.meta,
+	importMeta: import.meta, // This is required
 	flags: {
 		rainbow: {
 			type: 'boolean',
@@ -413,5 +413,5 @@ const cli = meow(`
 foo(cli.input.at(0), cli.flags);
 ```
 */
-export default function meow<Flags extends AnyFlags>(helpMessage: string, options?: Options<Flags>): Result<Flags>;
-export default function meow<Flags extends AnyFlags>(options?: Options<Flags>): Result<Flags>;
+export default function meow<Flags extends AnyFlags>(helpMessage: string, options: Options<Flags>): Result<Flags>;
+export default function meow<Flags extends AnyFlags>(options: Options<Flags>): Result<Flags>;
diff --git a/test-d/build.test-d.ts b/test-d/build.test-d.ts
@@ -6,7 +6,8 @@ type AnyFlag = NonNullable<NonNullable<Parameters<typeof meow>[0]>['flags']>[str
 
 const importMeta = import.meta;
 
-expectType<Result<never>>(meow('Help text'));
+expectError(meow('Help text'));
+expectError(meow('Help text', {}));
 expectType<Result<never>>(meow('Help text', {importMeta}));
 expectAssignable<{flags: {foo: number}}>(
 	meow({importMeta: import.meta, flags: {foo: {type: 'number', isRequired: true}}}),

diff --git a/test-d/index.test-d.ts b/test-d/index.test-d.ts
@@ -6,7 +6,8 @@ type AnyFlag = NonNullable<NonNullable<Parameters<typeof meow>[0]>['flags']>[str
 
 const importMeta = import.meta;
 
-expectType<Result<never>>(meow('Help text'));
+expectError(meow('Help text'));
+expectError(meow('Help text', {}));
 expectType<Result<never>>(meow('Help text', {importMeta, hardRejection: false}));
 expectAssignable<{flags: {foo: number}}>(
 	meow({importMeta: import.meta, flags: {foo: {type: 'number', isRequired: true}}}),

diff --git a/test/options/import-meta.js b/test/options/import-meta.js
@@ -1,24 +1,45 @@
 import test from 'ava';
 import meow from '../../source/index.js';
 
-test('main', t => {
-	t.notThrows(() => meow({importMeta: import.meta}));
+const verifyImportMeta = test.macro((t, {cli, error}) => {
+	if (error) {
+		t.throws(cli, {message: 'The `importMeta` option is required. Its value must be `import.meta`.'});
+	} else {
+		t.notThrows(cli);
+	}
 });
 
-test('with help shortcut', t => {
-	t.notThrows(() => (
-		meow(`
-			unicorns
-			rainbows
-		`, {
-			importMeta: import.meta,
-		})
-	));
+test('main', verifyImportMeta, {
+	cli: () => meow({
+		importMeta: import.meta,
+	}),
 });
 
-test('invalid package url', t => {
-	t.throws(
-		() => meow({importMeta: '/path/to/package'}),
-		{message: 'The `importMeta` option is required. Its value must be `import.meta`.'},
-	);
+test('with help shortcut', verifyImportMeta, {
+	cli: () => meow(`
+		unicorns
+		rainbows
+	`, {
+		importMeta: import.meta,
+	}),
+});
+
+test('invalid package url', verifyImportMeta, {
+	cli: () => meow({importMeta: '/path/to/package'}),
+	error: true,
+});
+
+test('throws if unset', verifyImportMeta, {
+	cli: () => meow('foo', {}),
+	error: true,
+});
+
+test('throws if unset - options only', verifyImportMeta, {
+	cli: () => meow({}),
+	error: true,
+});
+
+test('throws if unset - help shortcut only', verifyImportMeta, {
+	cli: () => meow('foo'),
+	error: true,
 });