A module to handle Vim's command arguments like the followings.

:MyCommand ++enc=sjis ++ff=dos -f --foo=foo --bar=bar --bar=baz hello world

Developers should utilize [<f-args>] in Vim script to acquire the arguments as a string array, adhering to the standard Vim command behavior.

For example:

command! -nargs=* MyCommand call denops#request("myplugin", "test", [[<f-args>]])

Then, developers can use this module to parse, validate, or format the arguments.

import type { Denops } from "../mod.ts";
import {
  builtinOpts,
  formatFlags,
  formatOpts,
  parse,
  validateFlags,
  validateOpts,
} from "./mod.ts";

export async function main(denops: Denops): Promise<void> {
  denops.dispatcher = {
    test(args: unknown) {
      // Parse string array to extract `opts`, `flags`.
      const [opts, flags, residues] = parse(args as string[]);

      console.log(opts);
      // { "enc": "sjis", "ff": "dos" }
      console.log(flags);
      // { "f": "", "foo": "foo", "bar": ["bar", "baz"] }
      console.log(residues);
      // ["hello", "world"]

      // Validate if `opts` has unknown options
      validateOpts(opts, ["enc", "ff"]);

      // Or use `builtinOpts` to validate Vim's builtin `++opts`
      validateOpts(opts, builtinOpts);

      // Validate if `flags` has unknown flags
      validateFlags(flags, ["f", "foo", "bar"]);

      // Reformat `opts` to string
      console.log(formatOpts(opts));
      // "++enc=sjis ++ff=dos"

      // Reformat `flags` to string
      console.log(formatFlags(flags));
      // "-f --foo=foo --bar=bar --bar=baz"
    },
  };
}