Merge pull request #16 from vim-denops/stream

💥 Support Web Streams API and simplify the features

Author: lambdalisue

.github/workflows/test.yml

@@ -38,3 +38,8 @@ jobs:
         run: |
           deno task test
         timeout-minutes: 5
+      - run: |
+          deno coverage --unstable .coverage --lcov > coverage.lcov
+      - uses: codecov/codecov-action@v1
+        with:
+          file: ./coverage.lcov

.gitignore

@@ -1 +1,2 @@
 deno.lock
+.coverage

README.md

@@ -3,6 +3,7 @@
 [![deno land](http://img.shields.io/badge/available%20on-deno.land/x-lightgrey.svg?logo=deno)](https://deno.land/x/vim_channel_command)
 [![deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/vim_channel_command/mod.ts)
 [![Test](https://github.com/vim-denops/deno-vim-channel-command/workflows/Test/badge.svg)](https://github.com/vim-denops/deno-vim-channel-command/actions?query=workflow%3ATest)
+[![codecov](https://codecov.io/github/vim-denops/deno-vim-channel-command/branch/main/graph/badge.svg?token=FYH6RHO6UC)](https://codecov.io/github/vim-denops/deno-vim-channel-command)
 
 [Deno][deno] module to support [Vim's Channel commands][vim's channel commands].
 

client.ts

@@ -0,0 +1,160 @@
+import { Indexer } from "https://deno.land/x/[email protected]/mod.ts";
+import { buildMessage, Message } from "./message.ts";
+import {
+  buildCallCommand,
+  buildExCommand,
+  buildExprCommand,
+  buildNormalCommand,
+  buildRedrawCommand,
+  Command,
+} from "./command.ts";
+
+const msgidThreshold = 2 ** 32;
+
+type Session = {
+  send: (data: Command | Message) => void;
+  recv: (msgid: number) => Promise<Message>;
+};
+
+/**
+ * Client is a wrapper of Session to send commands and messages.
+ *
+ * @example
+ * ```ts
+ * import { assertNumber } from "https://deno.land/x/unknownutil/mod.ts";
+ * import { channel } from "https://deno.land/x/streamtools/mod.ts";
+ * import { Session, Client } from "./mod.ts";
+ *
+ * const input = channel<Uint8Array>();
+ * const output = channel<Uint8Array>();
+ * const session = new Session(input.reader, output.writer);
+ * session.start();
+ *
+ * // Create a client
+ * const client = new Client(session);
+ *
+ * // Send a ex command
+ * client.ex("echo 'Hello, world!'");
+ *
+ * // Send a call command and wait for the result.
+ * console.log(await client.call("abs", -1)); // 1
+ * ```
+ */
+export class Client {
+  #session: Session;
+  #indexer: Indexer;
+
+  /**
+   * Constructs a new client.
+   *
+   * Note that the indexer must be unique for each session to avoid message ID conflicts.
+   * If multiple clients are created for a single session, specify a single indexer.
+   *
+   * @param {Session} session The session to communicate with.
+   * @param {Indexer} indexer The indexer to generate message IDs.
+   */
+  constructor(session: Session, indexer?: Indexer) {
+    this.#session = session;
+    this.#indexer = indexer ?? new Indexer(msgidThreshold);
+  }
+
+  #nextMsgid(): number {
+    // The msgid must be a negative number to avoid confusion with message that Vim sends.
+    // https://github.com/vim/vim/blob/b848ce6b7e27f24aff47a4d63933e0f96663acfe/runtime/doc/channel.txt#L379-L381
+    return (this.#indexer.next() + 1) * -1;
+  }
+
+  async #recv(msgid: number): Promise<unknown> {
+    const [_, response] = await this.#session.recv(msgid);
+    return response;
+  }
+
+  /**
+   * Sends a message to Vim.
+   *
+   * @param {number} msgid The message ID.
+   * @param {unknown} value The value to send.
+   */
+  reply(msgid: number, value: unknown): void {
+    const message = buildMessage(msgid, value);
+    this.#session.send(message);
+  }
+
+  /**
+   * Sends a redraw command to Vim.
+   *
+   * @param {boolean} force Whether to force redraw.
+   */
+  redraw(force = false): void {
+    const command = buildRedrawCommand(force);
+    this.#session.send(command);
+  }
+
+  /**
+   * Sends an ex command to Vim.
+   *
+   * @param {string} expr The expression to evaluate.
+   */
+  ex(expr: string): void {
+    const command = buildExCommand(expr);
+    this.#session.send(command);
+  }
+
+  /**
+   * Sends a normal command to Vim.
+   *
+   * @param {string} expr The expression to evaluate.
+   */
+  normal(expr: string): void {
+    const command = buildNormalCommand(expr);
+    this.#session.send(command);
+  }
+
+  /**
+   * Sends an expr command to Vim and wait for the result.
+   *
+   * @param {string} expr The expression to evaluate.
+   * @returns {Promise<unknown>} The result of the expression.
+   */
+  expr(expr: string): Promise<unknown> {
+    const msgid = this.#nextMsgid();
+    const command = buildExprCommand(expr, msgid);
+    this.#session.send(command);
+    return this.#recv(msgid);
+  }
+
+  /**
+   * Sends an expr command to Vim.
+   *
+   * @param {string} expr The expression to evaluate.
+   */
+  exprNoReply(expr: string): void {
+    const command = buildExprCommand(expr);
+    this.#session.send(command);
+  }
+
+  /**
+   * Sends a call command to Vim and wait for the result.
+   *
+   * @param {string} fn The function name to call.
+   * @param {unknown[]} args The arguments to pass to the function.
+   * @returns {Promise<unknown>} The result of the function.
+   */
+  call(fn: string, ...args: unknown[]): Promise<unknown> {
+    const msgid = this.#nextMsgid();
+    const command = buildCallCommand(fn, args, msgid);
+    this.#session.send(command);
+    return this.#recv(msgid);
+  }
+
+  /**
+   * Sends a call command to Vim.
+   *
+   * @param {string} fn The function name to call.
+   * @param {unknown[]} args The arguments to pass to the function.
+   */
+  callNoReply(fn: string, ...args: unknown[]): void {
+    const command = buildCallCommand(fn, args);
+    this.#session.send(command);
+  }
+}