remove false from version type

* this has had no effect since sindresorhus#68
tommy-mitchell · Feb 29, 2024 · 049f962 · 049f962
1 parent 7b9e739
commit 049f962
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 5 deletions.
diff --git a/readme.md b/readme.md
@@ -161,7 +161,7 @@ The description will be shown above your help text automatically.
 
 ##### version
 
-Type: `string | boolean`\
+Type: `string`\
 Default: The package.json `"version"` property
 
 Set a custom version output.

diff --git a/source/index.d.ts b/source/index.d.ts
@@ -180,10 +180,8 @@ export type Options<Flags extends AnyFlags> = {
 
 	/**
 	Set a custom version output. Default: The package.json `"version"` property.
-
-	Set it to `false` to disable it altogether.
 	*/
-	readonly version?: string | false;
+	readonly version?: string;
 
 	/**
 	Automatically show the help text when the `--help` flag is present. Useful to set this value to `false` when a CLI manages child CLIs with their own help text.

diff --git a/test/options/version.js b/test/options/version.js
@@ -38,7 +38,7 @@ test('custom version', verifyVersion, {
 test('version = false has no effect', verifyVersion, {
 	args: '--version',
 	execaOptions: {env: {VERSION: 'false'}},
-	expected: '1.0.0',
+	expected: 'false',
 });
 
 test('manual showVersion', verifyVersion, {