lua-client

Lua client for Neovim

Future plans

The future of lua-client (this repo) is grim, because the future of Nvim Lua is supple and verdant:

1. Nvim core will gain the ability to run Lua code via nvim -l.
2. We will include some sort of Lua client in Nvim core. Perhaps starting with https://github.com/justinmk/lua-client2
3. Legacy lua-client (this repo) will be archived.

Build

The Makefile pulls and builds various dependencies into .deps.

 make

To build on platforms other than linux, specify a LUA_TARGET, e.g.

LUA_TARGET=macosx build

Valid LUA_TARGETs are those supported by lua 5.1 i.e. one of:

• aix
• ansi
• bsd
• freebsd
• generic
• linux
• macosx
• mingw
• posix
• solaris

Test

Run tests against whatever nvim is in $PATH:

 make test

Use a specific nvim:

 NVIM_PROG=/path/to/nvim make test

Use test tags (it('#foo', function() ...):

 NVIM_PROG=/path/to/nvim make test TEST_TAG=foo

Release

1. Bump the rockspec version and filename.
2. Create and push a new tag.

   TAG=$(echo *.rockspec | grep -o '[0-9].[0-9].[0-9].[0-9]')
   git tag -a "$TAG" -m "nvim-client $TAG"
   git push --follow-tags --dry-run
   git push --follow-tags
   

3. Generate LuaRocks API key
4. Upload the new rockspec.

   ./.deps/usr/bin/luarocks upload --api-key=xxx nvim-client-*.rockspec
   

   • Note: luarocks upload requires a JSON library.

     ./.deps/usr/bin/luarocks install dkjson