Neovim Ruby

Ruby bindings for Neovim.

Warning: This project is currently incomplete and unstable.

Installation

Add this line to your application's Gemfile:

gem "neovim"

And then execute:

$ bundle

Or install it yourself as:

$ gem install neovim

Usage

You can control a running nvim process by connecting to $NVIM_LISTEN_ADDRESS. Start it up like this:

$ NVIM_LISTEN_ADDRESS=/tmp/nvim.sock nvim

You can then connect to that socket to get a Neovim::Client:

require "neovim"
client = Neovim.attach_unix("/tmp/nvim.sock")

The interface of the client is generated at runtime from the vim_get_api_info RPC call. For now, you can refer to the Node client's auto-generated API description. Note that methods will be in snake_case rather than camelCase.

The neovim-ruby-host executable can be used to spawn Ruby plugins via the rpcstart command. A plugin can be defined like this:

# my_plugin.rb

Neovim.plugin do |plug|
  # Define a command called "Add" which returns the sum of two numbers
  # The `:sync => true` option tells nvim to wait for a response.
  # The result of the block will be returned to nvim.
  plug.command(:Add, :nargs => 2, :sync => true) do |nvim, x, y|
    x + y
  end

  # Define a command called "SetLine" which sets the current line
  # This command is asynchronous, so nvim won't wait for a response.
  plug.command(:SetLine, :nargs => 1) do |nvim, str|
    nvim.current.line = str
  end
end

In your nvim, you can start this plugin by running let host = rpcstart("neovim-ruby-host", ["./my_plugin.rb"]). You can use this channel id to communicate with the host, e.g.

let result = rpcrequest(host, "Add", 1, 2)
let result " # => 3

call rpcnotify(host, "SetLine", "Foo")
" Current line is set to "Foo"

Plugin functionality is very limited right now. Besides command, the plugin DSL exposes the function and autocmd directives, however they are functionally identical to command. Their purpose is to define a manifest that nvim can load via the UpdateRemotePlugins command, which will generate the actual command, function, and autocmd definitions. This piece has not yet been implemented.

Contributing

Fork it (http://github.com/alexgenco/neovim-ruby/fork)
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request