A harness for testing vim via javascript. Provides an ergonimic interface to a NeovimClient for easy testing of vim (plugins or the like).
Use the entrypoint withVim to encapsulate your test with a live headless vim instance. You can then exercise vim to your liking via the NeovimClient api.
import assert from "assert";
import withVim from "nvim-test-js";
it("gives me the vim", () =>
withVim(async nvim => {
const result = await nvim.commandOutput('echo "It works!"');
assert.equal(result, "It works!");
}));Commonly when testing plugins I find I need to setup the buffer with the cursor in a particular location.
A helper method for this is available as setBuffer where the cursor is represented by |.
import assert from "assert";
import withVim, {getBuffer, setBuffer} from "nvim-test-js";
it("poulates a buffer with a cursor position", () =>
withVim(async nvim => {
await setBuffer(nvim, "f|oo")
assert.deepEqual(await getBuffer(nvim), "foo")
assert.deepEqual(await nvim.call("getpos", "."), [0, 1, 2, 0])
}));
it("can do the same with an array of lines", () =>
withVim(async nvim => {
await setBuffer(nvim, ["foo", "b|ar"])
assert.equal(await getBuffer(nvim), "foo\nbar")
assert.deepEqual(await nvim.call("getpos", "."), [0, 2, 2, 0])
}));I do enjoy playing with vim projects - but after all that work I find myself fatigued when testing it with vim related frameworks annd concepts. Give me some good ol' mocha, or jest or whatever and I'm happier. I find the javascript testing universe much more joyful - maybe you will too.