Merge pull request #217 from vim-denops/feat

👍 Chores

Author: lambdalisue

denops_std/argument/flags_test.ts

@@ -1,4 +1,4 @@
-import { assertEquals } from "https://deno.land/std@0.192.0/testing/asserts.ts";
+import { assertEquals } from "https://deno.land/std@0.205.0/assert/mod.ts";
 import { parseFlags } from "./flags.ts";
 
 Deno.test("parseFlags", () => {

denops_std/argument/mod.ts

@@ -1,6 +1,65 @@
 /**
- * A module to handle Vim's command arguments.
+ * A module to handle Vim's command arguments like the followings.
  *
+ * ```vim
+ * :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:
+ *
+ * ```vim
+ * command! -nargs=* MyCommand call denops#request("myplugin", "test", [[<f-args>]])
+ * ```
+ *
+ * Then, developers can use this module to parse, validate, or format the arguments.
+ *
+ * ```typescript
+ * 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"
+ *     },
+ *   };
+ * }
+ * ```
  * @module
  */
 import { Opts, parseOpts } from "./opts.ts";

denops_std/argument/mod_test.ts

@@ -1,4 +1,4 @@
-import { assertEquals } from "https://deno.land/std@0.192.0/testing/asserts.ts";
+import { assertEquals } from "https://deno.land/std@0.205.0/assert/mod.ts";
 import { parse } from "./mod.ts";
 
 Deno.test("parse", () => {

denops_std/argument/opts_test.ts

@@ -1,4 +1,4 @@
-import { assertEquals } from "https://deno.land/std@0.192.0/testing/asserts.ts";
+import { assertEquals } from "https://deno.land/std@0.205.0/assert/mod.ts";
 import { parseOpts } from "./opts.ts";
 
 Deno.test("parseOpts", () => {

denops_std/autocmd/README.md

@@ -1,4 +1,4 @@
-import { assertEquals } from "https://deno.land/std@0.192.0/testing/asserts.ts";
+import { assertEquals } from "https://deno.land/std@0.205.0/assert/mod.ts";
 import { test } from "https://deno.land/x/denops_test@v1.4.0/mod.ts";
 import { globals } from "../variable/mod.ts";
 import { define, emit, emitAll, list, remove } from "./common.ts";

denops_std/autocmd/common_test.ts

@@ -1,4 +1,4 @@
-import { assertEquals } from "https://deno.land/std@0.192.0/testing/asserts.ts";
+import { assertEquals } from "https://deno.land/std@0.205.0/assert/mod.ts";
 import { test } from "https://deno.land/x/denops_test@v1.4.0/mod.ts";
 import { globals } from "../variable/mod.ts";
 import { group } from "./group.ts";

denops_std/autocmd/group_test.ts

@@ -1,9 +1,9 @@
-import { assertEquals } from "https://deno.land/std@0.192.0/testing/asserts.ts";
+import { assertEquals } from "https://deno.land/std@0.205.0/assert/mod.ts";
 import {
   assertSpyCall,
   assertSpyCalls,
   spy,
-} from "https://deno.land/std@0.192.0/testing/mock.ts";
+} from "https://deno.land/std@0.205.0/testing/mock.ts";
 import { test } from "https://deno.land/x/denops_test@v1.4.0/mod.ts";
 import { batch, BatchHelper } from "./batch.ts";
 

denops_std/batch/batch_test.ts

@@ -1,7 +1,7 @@
 import {
   assertEquals,
   assertRejects,
-} from "https://deno.land/std@0.192.0/testing/asserts.ts";
+} from "https://deno.land/std@0.205.0/assert/mod.ts";
 import { test } from "https://deno.land/x/denops_test@v1.4.0/mod.ts";
 import type { Denops } from "https://deno.land/x/denops_core@v5.0.0/mod.ts";
 import { collect } from "./collect.ts";

denops_std/batch/collect_test.ts

@@ -1,4 +1,5 @@
 import type { Denops } from "https://deno.land/x/denops_core@v5.0.0/mod.ts";
+import { maybe } from "https://deno.land/x/unknownutil@v3.10.0/mod.ts#^";
 import * as autocmd from "../autocmd/mod.ts";
 import * as batch from "../batch/mod.ts";
 import * as fn from "../function/mod.ts";
@@ -7,7 +8,7 @@ import { execute } from "../helper/mod.ts";
 import {
   FileFormat,
   findFileFormat,
-  maybeFileFormat,
+  isFileFormat,
   splitText,
 } from "./fileformat.ts";
 import { tryDecode } from "./fileencoding.ts";
@@ -284,7 +285,7 @@ export async function decode(
   } else {
     [enc, text] = tryDecode(data, fileencodings);
   }
-  const ff = maybeFileFormat(options.fileformat) ??
+  const ff = maybe(options.fileformat, isFileFormat) ??
     findFileFormat(text, fileformats) ?? fileformat;
   return {
     content: splitText(text, ff),

denops_std/buffer/buffer.ts

@@ -1,7 +1,7 @@
 import {
   assertEquals,
   assertRejects,
-} from "https://deno.land/std@0.192.0/testing/asserts.ts";
+} from "https://deno.land/std@0.205.0/assert/mod.ts";
 import { test } from "https://deno.land/x/denops_test@v1.4.0/mod.ts";
 import { default as Encoding } from "https://cdn.skypack.dev/encoding-japanese@2.0.0/";
 import * as fn from "../function/mod.ts";

denops_std/buffer/buffer_test.ts

@@ -1,4 +1,4 @@
-import { assertEquals } from "https://deno.land/std@0.192.0/testing/asserts.ts";
+import { assertEquals } from "https://deno.land/std@0.205.0/assert/mod.ts";
 import { test } from "https://deno.land/x/denops_test@v1.4.0/mod.ts";
 import * as fn from "../function/mod.ts";
 import * as vimFn from "../function/vim/mod.ts";

denops_std/buffer/decoration_test.ts

@@ -1,4 +1,4 @@
-import { assertEquals } from "https://deno.land/std@0.192.0/testing/asserts.ts";
+import { assertEquals } from "https://deno.land/std@0.205.0/assert/mod.ts";
 import { default as Encoding } from "https://cdn.skypack.dev/encoding-japanese@2.0.0/";
 import { tryDecode } from "./fileencoding.ts";