hasundue / denocy.vim

E2E Testing Framework for Vim/Neovim (WIP)

denocy.vim

An end-to-end testing library for Vim/Neovim powered by denops.vim, inspired by modern Javascript testing frameworks like Cypress.

Key Features

• Pseudo-Synchronous API
  • Easy to write/read
  • Run denops plugins synchronously as much as possible
• (TODO) Asynchronous API
• Human-readable selectors and matchers optimized for Vim

Requirements

• Latest Deno runtime
• Git (unless you use your own clone of denops.vim)

Installation

Installation is not required, since Denocy is a Deno module. You can use Denocy by importing it remotely like other Deno modules (see Getting Started).

Configuration

Denocy is supposed to work with zero configuration, but the following environment variables are available to tweak:

DENOCY_DIR

Path to a directory where Denocy caches temporary files (default: ~/.cache/denocy)

DENOCY_VIM_PATH

Path to Vim executable (default: vim)

DENOCY_NVIM_PATH

Path to Neovim executable (default: nvim)

DENOPS_PATH

Path to a cloned repository of denops.vim (default: ~/.cache/denocy/denops.vim)

Getting Started

Use Denocy

import { test } from "https://pax.deno.dev/hasundue/denocy.vim/mod.ts";

This will clone the denops.vim repository into DENOCY_DIR (default: ~/.cache/denocy) and set environment variables required to use the test module of Denops.

denocy.vim's Issues

Failed to run test file with error [email protected]/mod.ts' does not provide an export named 'assertArray'

Hello
I tried to run the following test

import { test } from "https://pax.deno.dev/hasundue/denocy.vim/mod.ts";

test("Sample", { target: "all" }, (vim) => {
  vim.cmd('echo "foo"')
});

but execution fails with the following error

error: Uncaught SyntaxError: The requested module 'https://deno.land/x/[email protected]/mod.ts' does not provide an export named 'assertArray'
  assertArray,
  ^
    at <anonymous> (https://raw.githubusercontent.com/hasundue/denocy.vim/master/deps.ts:15:3)

Could the code be trying to use a deprecated function from this library or is some other kind of issue?

Refactor

• Migrate to denops_test module
• Use autocmd to trigger assertions
• Use docker
• Redesign assertion APIs