fix(command): accept ignoreArgv (#19)

Author: privatenumber

src/command.ts

@@ -1,3 +1,4 @@
+import type { TypeFlagOptions } from 'type-flag';
 import type {
 	CallbackFunction,
 	Flags,
@@ -37,6 +38,11 @@ export type CommandOptions<Parameters = string[]> = {
 	Options to configure the help documentation. Pass in `false` to disable handling `--help, -h`.
 	*/
 	help?: false | HelpOptions;
+
+	/**
+	 * Which argv elements to ignore from parsing
+	 */
+	ignoreArgv?: TypeFlagOptions['ignore'];
 };
 
 export function command<

tests/specs/command.ts

@@ -269,5 +269,51 @@ export default testSuite(({ describe }) => {
 				expect(callback.called).toBe(true);
 			});
 		});
+
+		describe('ignoreArgv', ({ test }) => {
+			test('ignore after arguments', () => {
+				const callback = spy();
+				const argv = ['commandA', '--unknown', 'arg', '--help'];
+
+				let receivedArgument = false;
+				const commandA = command({
+					name: 'commandA',
+					flags: {
+						flagA: String,
+					},
+					ignoreArgv(type) {
+						if (receivedArgument) {
+							return true;
+						}
+						if (type === 'argument') {
+							receivedArgument = true;
+							return true;
+						}
+					},
+				}, (parsed) => {
+					expect<(string | boolean)[]>(parsed.unknownFlags.unknown).toStrictEqual([true]);
+					callback();
+				});
+
+				const parsed = cli(
+					{
+						commands: [
+							commandA,
+						],
+					},
+					undefined,
+					argv,
+				);
+
+				expect(parsed.command).toBe('commandA');
+
+				// Narrow type
+				if (parsed.command === 'commandA') {
+					expect<(string | boolean)[]>(parsed.unknownFlags.unknown).toStrictEqual([true]);
+				}
+
+				expect(callback.called).toBe(true);
+			});
+		});
 	});
 });

tests/specs/flags.ts

@@ -120,5 +120,38 @@ export default testSuite(({ describe }) => {
 				expect(mocked.processExit.calls).toStrictEqual([[0]]);
 			});
 		});
+
+		describe('ignoreArgv', ({ test }) => {
+			test('ignore after arguments', () => {
+				const argv = ['--unknown', 'arg', '--help'];
+
+				let receivedArgument = false;
+				const parsed = cli(
+					{
+						ignoreArgv(type) {
+							if (receivedArgument) {
+								return true;
+							}
+							if (type === 'argument') {
+								receivedArgument = true;
+								return true;
+							}
+						},
+					},
+					(p) => {
+						expect(argv).toStrictEqual(['arg', '--help']);
+						expect(p.unknownFlags).toStrictEqual({
+							unknown: [true],
+						});
+					},
+					argv,
+				);
+
+				expect(argv).toStrictEqual(['arg', '--help']);
+				expect(parsed.unknownFlags).toStrictEqual({
+					unknown: [true],
+				});
+			});
+		});
 	});
 });

tests/tsconfig.json

@@ -5,7 +5,4 @@
 		"esModuleInterop": true,
 		"module": "Node16"
 	},
-	"include": [
-		"src",
-	],
 }