Merge pull request #41 from vim-denops/to-beta

Minor updates for beta release

Author: lambdalisue

Makefile

@@ -9,7 +9,7 @@ help:
 
 tools: FORCE	## Install development tools
 	@mkdir -p ${TOOLS}
-	@deno install -f --allow-write --allow-read --allow-net --root ${TOOLS} https://deno.land/x/dlink/dlink.ts
+	@deno install -A -f -n udd --root ${TOOLS} https://deno.land/x/[email protected]/main.ts
 
 fmt: FORCE	## Format code
 	@deno fmt
@@ -27,11 +27,11 @@ test: FORCE	## Test
 	@deno test --unstable -A
 
 gen: FORCE	## Generate codes
-	@deno run -A ./scripts/gen-function/gen-function.ts
+	@deno run --unstable -A ./scripts/gen-function/gen-function.ts
 	@make fmt
 
-dlink: FORCE	## Update dlink
-	(cd denops_std; ${TOOLS}/bin/dlink)
+update: FORCE	## Update dependencies
+	@${TOOLS}/bin/udd $$(find ./denops_std -name '*.ts')
 	@make fmt
 
 FORCE:

README.md

@@ -8,50 +8,8 @@
 used in denops plugin and the code is assumed to be called in a worker thread
 for a plugin.
 
-**UNDER DEVELOPMENT**
-
-By using this module, developers can write Vim/Neovim denops plugins like:
-
-```typescript
-import { Denops } from "https://deno.land/x/denops_std/mod.ts";
-import { execute } from "https://deno.land/x/denops_std/helper/mod.ts";
-import { ensureString } from "https://deno.land/x/unknownutil/mod.ts";
-
-export async function main(denops: Denops): Promise<void> {
-  denops.dispatcher = {
-    async say(where: unknown): Promise<void> {
-      // Ensure that `where` is `string` here
-      ensureString(where);
-      // Use `call` to call Vim's function
-      const name = await denops.call("input", "Your name: ");
-      // Use `eval` to evaluate Vim's expression
-      const progname = await denops.eval("v:progname");
-      // Construct messages
-      const messages = [
-        `Hello ${where}`,
-        `Your name is ${name}`,
-        `This is ${progname}`,
-      ];
-      // Use `cmd` to execute Vim's command
-      await denops.cmd(`redraw | echomsg message`, {
-        message: messages.join(". "),
-      });
-    },
-  };
-
-  // Use 'execute()' to execute multiline Vim script
-  await execute(
-    denops,
-    `
-    command! HelloWorld call denops#notify("${denops.name}", "say", ["World"])
-    command! HelloDenops call denops#notify("${denops.name}", "say", ["Denops"])
-    `,
-  );
-}
-```
-
-See [denops-helloworld.vim](https://github.com/vim-denops/denops-helloworld.vim)
-for more details.
+See [Module README](./denops_std/README.md) for quick usage and API
+documentations.
 
 [deno]: https://deno.land/
 [denops.vim]: https://github.com/vim-denops/denops.vim

denops_std/README.md

@@ -12,6 +12,8 @@ By using this module, developers can write Vim/Neovim denops plugins like:
 
 ```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 vars from "https://deno.land/x/denops_std/variable/mod.ts";
 import { execute } from "https://deno.land/x/denops_std/helper/mod.ts";
 import { ensureString } from "https://deno.land/x/unknownutil/mod.ts";
 
@@ -21,9 +23,9 @@ export async function main(denops: Denops): Promise<void> {
       // Ensure that `where` is `string` here
       ensureString(where);
       // Use `call` to call Vim's function
-      const name = await denops.call("input", "Your name: ");
+      const name = await fn.input(denops, "Your name: ");
       // Use `eval` to evaluate Vim's expression
-      const progname = await denops.eval("v:progname");
+      const progname = await vars.v.get(denops, "progname");
       // Construct messages
       const messages = [
         `Hello ${where}`,
@@ -53,3 +55,13 @@ for more details.
 
 [deno]: https://deno.land/
 [denops.vim]: https://github.com/vim-denops/denops.vim
+
+## Index
+
+| Name                       | Description                                                      |
+| -------------------------- | ---------------------------------------------------------------- |
+| [`anonymous`](./anonymous) | A module to provide anonymous function                           |
+| [`autocmd`](./autocmd)     | A module to provide helper functions to manage `autocmd`         |
+| [`function`](./function)   | A module to provide functions of Vim and Neovim native functions |
+| [`helper`](./helper)       | A module to provide helper functions                             |
+| [`variable`](./variable)   | A module to provide helper accessor functions to variables       |

denops_std/anonymous/README.md

@@ -0,0 +1,104 @@
+# anonymous
+
+`anonymous` is a module to provide anonymous function which is callable from
+outside of the plugin (Vim or other plugins.)
+
+- [API documentation](https://doc.deno.land/https/deno.land/x/denops_std/anonymous/mod.ts)
+
+## Usage
+
+### add
+
+Use `add()` to add new anonymous functions and use return value as unique IDs to
+call added functions later like:
+
+```typescript
+import { Denops } from "https://deno.land/x/denops_std/mod.ts";
+import * as anonymous from "https://deno.land/x/denops_std/anonymous/mod.ts";
+
+export async function main(denops: Denops): Promise<void> {
+  // Add anonymous functions
+  const ids = anonymous.add(
+    denops,
+    () => {
+      // Do what ever you want.
+    },
+    () => {
+      // Do what ever you want.
+    },
+    // You can add as many callbacks as you want...
+  );
+
+  // Use ids to dispatch added functions from Deno
+  await denops.dispatch(denops.name, ids[0]);
+  await denops.dispatch(denops.name, ids[1]);
+
+  // Or from Vim
+  await denops.cmd("call denops#notify(name, id, [])", {
+    name: denops.name,
+    id: ids[1],
+  });
+}
+```
+
+### once
+
+If you need one-time anonymous function, use `once()` instead like:
+
+```typescript
+import { Denops } from "https://deno.land/x/denops_std/mod.ts";
+import * as anonymous from "https://deno.land/x/denops_std/anonymous/mod.ts";
+
+export async function main(denops: Denops): Promise<void> {
+  // Add anonymous functions
+  const ids = anonymous.once(
+    denops,
+    () => {
+      // Do what ever you want.
+    },
+    () => {
+      // Do what ever you want.
+    },
+    // You can add as many callbacks as you want...
+  );
+
+  // First calls complete normally
+  await denops.dispatch(denops.name, ids[0]);
+  await denops.dispatch(denops.name, ids[1]);
+
+  // But second call would throw errors
+  await denops.dispatch(denops.name, ids[0]);
+}
+```
+
+### remove
+
+When you need to remove callback, use `remove()` like:
+
+```typescript
+import { Denops } from "https://deno.land/x/denops_std/mod.ts";
+import * as anonymous from "https://deno.land/x/denops_std/anonymous/mod.ts";
+
+export async function main(denops: Denops): Promise<void> {
+  // Add anonymous functions
+  const ids = anonymous.add(
+    denops,
+    () => {
+      // Do what ever you want.
+    },
+    () => {
+      // Do what ever you want.
+    },
+    // You can add as many callbacks as you want...
+  );
+
+  // Remove ids[1]
+  anonymous.remove(denops, ids[1]);
+
+  // Call of ids[0] complete normally
+  await denops.dispatch(denops.name, ids[0]);
+
+  // But ids[1] is already removed
+  await denops.dispatch(denops.name, ids[1]);
+}
+```

denops_std/anonymous/mod.ts

@@ -1,4 +1,4 @@
-import { Denops } from "../vendor/https/deno.land/x/denops_core/mod.ts";
+import { Denops } from "../deps.ts";
 
 // https://github.com/microsoft/TypeScript/issues/26223#issuecomment-674500430
 export type TupleOf<T, N extends number> = N extends N

denops_std/anonymous/mod_test.ts

@@ -1,8 +1,5 @@
-import {
-  assertEquals,
-  assertThrowsAsync,
-} from "../vendor/https/deno.land/std/testing/asserts.ts";
-import { test } from "../vendor/https/deno.land/x/denops_core/test/mod.ts";
+import { assertEquals, assertThrowsAsync } from "../deps_test.ts";
+import { test } from "../deps_test.ts";
 import * as anonymous from "./mod.ts";
 
 test({