fix(flags): allow options after variadic options (#865)

Fixes #716

Author: c4spar

command/test/option/variadic_test.ts

@@ -113,9 +113,23 @@ test("command optionVariadic exactLastOptionalVariadic", async () => {
 
   assertEquals(
     options,
-    // @TODO: fix variadic types.
-    // deno-lint-ignore no-explicit-any
-    { variadicOption: [1, "abc", true, false, true, false] as any },
+    { variadicOption: [1, "abc", true, false, true, false] },
+  );
+  assertEquals(args, []);
+});
+
+test("should allow passing an option after an variadic option", async () => {
+  const { options, args } = await new Command()
+    .option("-v, --variadic-option <...value:string>", "description ...")
+    .option("-s, --string <value:string>", "description ...")
+    .parse(["-v", "1", "abc", "-s", "string value"]);
+
+  assertEquals(
+    options,
+    {
+      variadicOption: ["1", "abc"],
+      string: "string value",
+    },
   );
   assertEquals(args, []);
 });

flags/flags.ts

@@ -500,14 +500,19 @@ function parseArgs<TFlagOptions extends FlagOptions>(
         if (!option.args?.length) {
           return false;
         }
-        const nextValue = currentValue ?? args[argsIndex + 1];
+        const nextValue = next();
         if (!nextValue) {
           return false;
         }
         if (option.args.length > 1 && optionArgsIndex >= option.args.length) {
           return false;
         }
-        if (!arg.optional) {
+        let nextOption: FlagOptions | undefined;
+        if (
+          !arg.optional &&
+          (!arg.variadic ||
+            !(nextOption = getOption(opts.flags ?? [], nextValue)))
+        ) {
           return true;
         }
         // require optional values to be called with an equal sign: foo=bar
@@ -517,7 +522,10 @@ function parseArgs<TFlagOptions extends FlagOptions>(
         ) {
           return false;
         }
-        if (arg.optional || arg.variadic) {
+        if (
+          (arg.optional || arg.variadic) &&
+          !(nextOption ?? getOption(opts.flags ?? [], nextValue))
+        ) {
           return nextValue[0] !== "-" ||
             typeof currentValue !== "undefined" ||
             (arg.type === "number" && !isNaN(Number(nextValue)));

flags/test/option/variadic_test.ts

@@ -168,3 +168,31 @@ test("flags optionVariadic exactLastOptionalVariadic", () => {
   assertEquals(unknown, []);
   assertEquals(literal, []);
 });
+
+test("should allow passing an option after an variadic option", () => {
+  const { flags, unknown, literal } = parseFlags([
+    "-e",
+    "1",
+    "abc",
+    "-s",
+    "string value",
+  ], {
+    flags: [{
+      name: "variadic-option",
+      type: "string",
+      aliases: ["e"],
+      variadic: true,
+    }, {
+      name: "string",
+      aliases: ["s"],
+      type: "string",
+    }],
+  });
+
+  assertEquals(flags, {
+    variadicOption: ["1", "abc"],
+    string: "string value",
+  });
+  assertEquals(unknown, []);
+  assertEquals(literal, []);
+});