initial commit

Author: tennashi

.github/workflows/test.yaml

@@ -0,0 +1,56 @@
+name: Test
+
+env:
+  DENO_VERSION: 1.x
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: denoland/setup-deno@main
+        with:
+          deno-version: ${{ env.DENO_VERSION }}
+      - name: Lint
+        run: deno lint
+
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: denoland/setup-deno@main
+        with:
+          deno-version: ${{ env.DENO_VERSION }}
+      - name: Format
+        run: |
+          deno fmt --check
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: denoland/setup-deno@main
+        with:
+          deno-version: ${{ env.DENO_VERSION }}
+      - name: Test
+        run: |
+          deno test
+        timeout-minutes: 5
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: denoland/setup-deno@main
+        with:
+          deno-version: ${{ env.DENO_VERSION }}
+      - name: Type check
+        run: |
+          deno test --unstable --no-run ./*.ts

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 tennashi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,2 @@
+# WIP: denops_app
+UI module for [denops.vim](https://github.com/vim-denops/denops.vim).

app.ts

@@ -0,0 +1,82 @@
+import { Denops, execute, group, GroupHelper } from "./deps.ts";
+import { Buffer } from "./buffer.ts";
+import { Component, Route } from "./router.ts";
+
+export class DenopsApp {
+  #appName: string;
+  #routes: {
+    pathRegexp: RegExp;
+    component: Component;
+  }[];
+  #denops: Denops;
+  #commands: {
+    name: string;
+    path: string;
+  }[];
+
+  constructor(appName: string, denops: Denops) {
+    this.#appName = appName;
+    this.#routes = [];
+    this.#denops = denops;
+    this.#commands = [];
+  }
+
+  setRoutes(routes: Route[]) {
+    this.#routes = routes.map((route) => ({
+      pathRegexp: new RegExp(
+        "^" + route.path.replaceAll(/\/:(\w+)/g, "/(?<$1>\\w+)") + "$",
+      ),
+      component: route.component,
+    }));
+    console.log(this.#routes);
+  }
+
+  addCommand(name: string, path: string) {
+    this.#commands.push({ name: name, path: path });
+  }
+
+  matchRoute(path: string): Promise<Buffer> {
+    for (const route of this.#routes) {
+      const matched = path.match(route.pathRegexp);
+
+      if (!matched) {
+        continue;
+      }
+
+      const pathParams = matched.groups || {};
+      return route.component(pathParams);
+    }
+
+    throw Error("not found");
+  }
+
+  async initialize() {
+    this.#denops.dispatcher = {
+      renderContents: async (path: unknown): Promise<void> => {
+        const buffer = await this.matchRoute(
+          (path as string).substring(`denopsapp://${this.#denops.name}`.length),
+        );
+        await buffer.render(this.#denops);
+      },
+    };
+
+    this.#commands.forEach(async (cmd) => {
+      await execute(
+        this.#denops,
+        `command! ${cmd.name} split denopsapp://${this.#denops.name}${cmd.path}`,
+      );
+    });
+
+    await group(
+      this.#denops,
+      `${this.#appName}-buffer`,
+      (helper: GroupHelper) => {
+        helper.define(
+          "BufReadCmd",
+          `denopsapp://${this.#appName}/*`,
+          `call denops#notify('${this.#denops.name}', 'renderContents', [expand('<amatch>')])`,
+        );
+      },
+    );
+  }
+}

buffer.ts

@@ -0,0 +1,5 @@
+import { Denops } from "./deps.ts";
+
+export interface Buffer {
+  render: (denops: Denops) => Promise<void>;
+}

deps.ts

@@ -0,0 +1,10 @@
+export { Denops } from "https://deno.land/x/denops_std@v1.0.0-alpha.0/mod.ts";
+
+export {
+  execute,
+} from "https://deno.land/x/denops_std@v1.0.0-alpha.0/helper/mod.ts";
+
+export {
+  group,
+  GroupHelper,
+} from "https://deno.land/x/denops_std@v1.0.0-alpha.0/autocmd/mod.ts";

list.ts

@@ -0,0 +1,64 @@
+import { Denops, execute } from "./deps.ts";
+import { Buffer } from "./buffer.ts";
+
+export class ListWidget<T> implements Buffer {
+  #items: {
+    item: T;
+    renderFn: (item: T) => string;
+  }[];
+
+  #keybinds: {
+    [key: string]: (denops: Denops, item: T) => Promise<void>;
+  };
+
+  constructor() {
+    this.#items = [];
+    this.#keybinds = {};
+  }
+
+  setItem(item: T, renderFn: (item: T) => string) {
+    this.#items.push({ item, renderFn });
+  }
+
+  handleKey(key: string, handler: (denops: Denops, item: T) => Promise<void>) {
+    this.#keybinds[key] = handler;
+  }
+
+  async render(denops: Denops) {
+    await denops.call(
+      "setline",
+      1,
+      this.#items.map((item) => item.renderFn(item.item)),
+    );
+
+    Object.keys(this.#keybinds).forEach(async (key) => {
+      denops.dispatcher[`keyHandler`] = async (
+        index: unknown,
+      ): Promise<void> => {
+        await this.#keybinds[key](
+          denops,
+          this.#items[(index as number)].item,
+        );
+      };
+
+      await execute(
+        denops,
+        [
+          `nmap <buffer> <expr> ${key} denops#notify('${denops.name}', 'keyHandler', [line('.') - 1])`,
+        ],
+      );
+    });
+
+    await execute(
+      denops,
+      [
+        `setlocal bufhidden=hide`,
+        `setlocal buftype=nofile`,
+        `setlocal nobuckup`,
+        `setlocal noswapfile`,
+        `setlocal nomodified`,
+        `setlocal nomodifiable`,
+      ],
+    );
+  }
+}

mod.ts

@@ -0,0 +1,5 @@
+export * from "./app.ts";
+export * from "./router.ts";
+export * from "./buffer.ts";
+export * from "./list.ts";
+export * from "./text.ts";

router.ts

@@ -0,0 +1,10 @@
+import { Buffer } from "./buffer.ts";
+
+export type Context = { [key: string]: string };
+
+export type Component = (context: Context) => Promise<Buffer>;
+
+export interface Route {
+  path: string;
+  component: Component;
+}

text.ts

@@ -0,0 +1,33 @@
+import { Denops, execute } from "./deps.ts";
+import { Buffer } from "./buffer.ts";
+
+export class TextWidget implements Buffer {
+  #content: string;
+  constructor() {
+    this.#content = "";
+  }
+
+  setContent(content: string) {
+    this.#content = content;
+  }
+
+  async render(denops: Denops) {
+    await denops.call(
+      "setline",
+      1,
+      this.#content.split(/\r?\n/g),
+    );
+
+    await execute(
+      denops,
+      [
+        `setlocal bufhidden=hide`,
+        `setlocal buftype=nofile`,
+        `setlocal nobuckup`,
+        `setlocal noswapfile`,
+        `setlocal nomodified`,
+        `setlocal nomodifiable`,
+      ],
+    );
+  }
+}