fix: disallow accepting aliases with --

BREAKING CHANGE: no longer supports the edge-case --a where a is an alias
privatenumber · Jun 20, 2024 · 4d4ec18 · 4d4ec18
1 parent d328656
commit 4d4ec18
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/src/type-flag.ts b/src/type-flag.ts
@@ -56,7 +56,9 @@ export const typeFlag = <Schemas extends Flags>(
 
 	argvIterator(argv, {
 		onFlag(name, explicitValue, flagIndex) {
-			const isKnownFlag = hasOwn(flagRegistry, name);
+			const isAlias = flagIndex.length === 3;
+			const isValid = isAlias || name.length > 1;
+			const isKnownFlag = isValid && hasOwn(flagRegistry, name);
 			if (
 				ignore?.(
 					isKnownFlag ? KNOWN_FLAG : UNKNOWN_FLAG,

diff --git a/tests/specs/type-flag.ts b/tests/specs/type-flag.ts
@@ -406,6 +406,23 @@ export default testSuite(({ describe }) => {
 					expect<string[]>(parsed.flags.alias).toStrictEqual(['', '', 'value']);
 					expect(argv).toStrictEqual([]);
 				});
+
+				test('should not accept aliases with --', () => {
+					const argv = ['--a'];
+					const parsed = typeFlag(
+						{
+							alias: {
+								type: Boolean,
+								alias: 'a',
+							},
+						},
+						argv,
+					);
+
+					expect<string | undefined>(parsed.flags.alias).toBe(undefined);
+					expect<(string | boolean)[]>(parsed.unknownFlags.a).toStrictEqual([true]);
+					expect(argv).toStrictEqual([]);
+				});
 			});
 
 			test('unknown flags', () => {