Contributing

Build

Warning Building on OSX requires a patched libmpack-lua

make

# run tests from the shell
make test

# run tests in watch mode
watchexec -- ./.deps/usr/bin/busted --lpath='./src/?.lua\;./test/?.lua' src/

-- configure vim-test to run busted correctly
vim.g['test#lua#busted#executable'] = './.deps/usr/bin/busted --lpath="./src/?.lua;./test/?.lua"'

To release version Y from X do the following:

Rename nvim-client-proxy-${X}.rockspec to nvim-client-proxy-${Y}.rockspec
Update version in the rockspec to Y
Add a section at the top of CHANGELOG.md. Be sure to keep the right format. Two things to keep in mind: a. Blank lines need spaces 😭. b. You can test the release notes with make Release.txt
Create a commit with the updated CHANGELOG.md and push it (optionally merge to master via a PR).
Tag the commit git tag v${Y} and push the tag.

Pushing a tag will automatically trigger the release workflow, which releases to: