/purescript-neovim

Primary LanguagePureScriptMIT LicenseMIT

purescript-neovim

Latest release

Purescript bindings for the Neovim remote plugin API for use with the node host.

Example Installation

  • Follow the installation instructions for the node host. Currently version v0.0.1 is required; newer versions will not work.
  • Build the example (you need to create the rplugin/node directory if it does not exist)
pulp build --src-path example --include src --to ~/.nvim/rplugin/node/purescript-neovim.js

This is known to work with pulp v10.0.4 and psc 0.10.2.

  • Update your plugins via UpdateRemotePlugins.
  • Restart neovim and run the HelloPurescript command. You should see Hi back! appear in the current buffer.

Debugging

Any errors in the plugin will be logged to NEOVIM_JS_DEBUG, which is not set by default. To start a debug session, use something like

NEOVIM_JS_DEBUG=./nvim-debug.log nvim

Interface

The interface is auto-generated from the metadata returned by nvim --api-info. To build it, run

pulp run --src-path scripts -m NeovimTypes

Documentation

Module documentation is published on Pursuit.