Merge pull request #127 from vim-denops/fix-readme

🌿 Fix type checks on READMEs

Author: lambdalisue

denops_std/batch/README.md

@@ -32,7 +32,7 @@ import { Denops } from "https://deno.land/x/denops_std/mod.ts";
 import { batch } from "https://deno.land/x/denops_std/batch/mod.ts";
 
 async function replace(denops: Denops, content: string): Promise<void> {
-  await batch(denops, (denops) => {
+  await batch(denops, async (denops) => {
     await denops.cmd("setlocal modifiable");
     await denops.cmd("setlocal foldmethod=manual");
     await denops.call("setline", 1, content.split(/\r?\n/));
@@ -78,7 +78,7 @@ import * as anonymous from "https://deno.land/x/denops_std/anonymous/mod.ts";
 
 export async function main(denops: Denops): Promise<void> {
   await batch(denops, async (denops) => {
-    const [id] = anonymous.add(denops, () => {
+    const [id] = anonymous.add(denops, async () => {
       // This code is called outside of 'batch' block
       // thus the 'denops' instance works like a real one.
       // That's why you can write code like below
@@ -120,13 +120,14 @@ Note that `denops.call()` or `denops.eval()` always return falsy value in
 
 ```typescript
 import { Denops } from "https://deno.land/x/denops_std/mod.ts";
-import { batch } from "https://deno.land/x/denops_std/batch/mod.ts";
+import { gather } from "https://deno.land/x/denops_std/batch/mod.ts";
 
 export async function main(denops: Denops): Promise<void> {
   const results = await gather(denops, async (denops) => {
     // !!! DON'T DO THIS !!!
     if (await denops.call("has", "nvim")) {
-      await denops.call("api_info").version;
+      // deno-lint-ignore no-explicit-any
+      await (denops.call("api_info") as any).version;
     } else {
       await denops.eval("v:version");
     }

denops_std/function/README.md

@@ -14,11 +14,12 @@ in minimal supported Vim and Neovim versions.
 ## Example
 
 ```typescript
+import { Denops } from "https://deno.land/x/denops_std/mod.ts";
 import * as fn from "https://deno.land/x/denops_std/function/mod.ts";
 import * as vimFn from "https://deno.land/x/denops_std/function/vim/mod.ts";
 import * as nvimFn from "https://deno.land/x/denops_std/function/nvim/mod.ts";
 
-export async function main(denops) {
+export async function main(denops: Denops): Promise<void> {
   // fn holds functions exists in both Vim and Neovim
   console.log(fn.or(denops, 0, 1));
 

denops_std/helper/README.md

@@ -106,7 +106,7 @@ export async function main(denops: Denops): Promise<void> {
         cmdline: string,
         cursorpos: number,
       ): Promise<string[]> => {
-        return ["Hello", "World"];
+        return Promise.resolve(["Hello", "World"]);
       },
     }),
   );
@@ -121,7 +121,7 @@ import { Denops } from "https://deno.land/x/denops_std/mod.ts";
 import { input } from "https://deno.land/x/denops_std/helper/mod.ts";
 
 export async function main(denops: Denops): Promise<void> {
-  denops.dispatch = {
+  denops.dispatcher = {
     say: async () => {
       return await input(denops, {
         prompt: "> ",

denops_std/option/README.md

@@ -14,34 +14,35 @@ minimal supported Vim and Neovim versions.
 ## Example
 
 ```typescript
+import { Denops } from "https://deno.land/x/denops_std/mod.ts";
 import * as op from "https://deno.land/x/denops_std/option/mod.ts";
 import * as vimOp from "https://deno.land/x/denops_std/option/vim/mod.ts";
 import * as nvimOp from "https://deno.land/x/denops_std/option/nvim/mod.ts";
 
-export async function main(denops) {
+export async function main(denops: Denops): Promise<void> {
   // Get value of the option.
   // `get` is available on any options
   // `getGlobal` is available on only global options
   // `getLocal` is available on only local options
-  console.log(await op.filetype.get(denops));
-  console.log(await op.filetype.getGlobal(denops));
-  console.log(await op.filetype.getLocal(denops));
+  console.log(await op.autoread.get(denops));
+  console.log(await op.autoread.getGlobal(denops));
+  console.log(await op.autoread.getLocal(denops));
 
   // Set value of the option.
   // `set` is available on any options
   // `setGlobal` is available on only global options
   // `setLocal` is available on only local options
-  await op.filetype.set(denops, "hello");
-  await op.filetype.setGlobal(denops, "hello");
-  await op.filetype.setLocal(denops, "hello");
+  await op.autoread.set(denops, true);
+  await op.autoread.setGlobal(denops, true);
+  await op.autoread.setLocal(denops, true);
 
   // Reset the option.
   // `reset` is available on any options
   // `resetGlobal` is available on only global options
   // `resetLocal` is available on only local options
-  await op.filetype.reset(denops);
-  await op.filetype.resetGlobal(denops);
-  await op.filetype.resetLocal(denops);
+  await op.autoread.reset(denops);
+  await op.autoread.resetGlobal(denops);
+  await op.autoread.resetLocal(denops);
 
   // vimOp has options only exist in Vim
   console.log(await vimOp.compatible.get(denops));

denops_std/variable/README.md

@@ -164,12 +164,12 @@ export async function main(denops: Denops): Promise<void> {
   // Get option
   console.log(await options.get(denops, "filetype"));
   console.log(await localOptions.get(denops, "filetype"));
-  console.log(await globalOption.get(denops, "filetype"));
+  console.log(await globalOptions.get(denops, "filetype"));
 
   // Reset option
   await options.remove(denops, "filetype");
   await localOptions.remove(denops, "filetype");
-  await globalOption.remove(denops, "filetype");
+  await globalOptions.remove(denops, "filetype");
 }
 ```