nvim-hs-0.1.1: Haskell plugin backend for neovim

This package provides a plugin provider for neovim. It allows you to write plugins for one of the great editors of our time in the best programming language of our time! ;-)

You should find all the documentation you need inside the Neovim module. Most other modules are considered internal, so don't be annoyed if using things from there may break your code!

The following modules may also be of interest and they should not change their API: Neovim.Quickfix

If you want to write unit tests that interact with neovim, Neovim.Test provides some useful functions for that.

If you are keen to debug nvim-hs or a module you are writing, take a look at the Neovim.Debug module.

If you spot any errors or if you have great ideas, feel free to open an issue on github.

Modules

Neovim API for the neovim plugin provider nvim-hs
- API
  - Neovim.API.String String based API
- Neovim.Classes Type classes used for conversion of msgpack and Haskell types
- Neovim.Config The user editable and compilable configuration
- Neovim.Context The Neovim context
  - Neovim.Context.Internal Abstract description of the plugin provider's internal context
- Neovim.Debug Utilities to debug Neovim and nvim-hs functionality
- Neovim.Log Logging utilities and reexports
- Neovim.Main Wrapper for the actual main function
- Neovim.Plugin Plugin and functionality registration code
  - Neovim.Plugin.Classes Classes and data types related to plugins
  - Neovim.Plugin.ConfigHelper Helper plugin to ease recompiling the nvim-hs config
  - Neovim.Plugin.IPC Communication between Haskell processes/threads
    - Neovim.Plugin.IPC.Classes Classes used for Inter Plugin Communication
  - Neovim.Plugin.Internal Split module that can import Neovim.Context without creating import circles
  - Neovim.Plugin.Startup Startup utilities for plugins
- Neovim.Quickfix API for interacting with the quickfix list
- RPC
  - Neovim.RPC.Classes Data types and classes for the RPC components
  - Neovim.RPC.Common Common functons for the RPC module
  - Neovim.RPC.EventHandler Event handling loop
  - Neovim.RPC.FunctionCall Functions for calling functions
  - Neovim.RPC.SocketReader The component which reads RPC messages from the neovim instance
- Neovim.Test Testing functions
- Neovim.Util Utility functions