nvim-hs-0.0.6: 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

NeovimAPI for the neovim plugin provider nvim-hs
- API
  - Neovim.API.StringString based API
- Neovim.ClassesType classes used for conversion of msgpack and Haskell types
- Neovim.ConfigThe user editable and compilable configuration
- Neovim.ContextThe Neovim context
  - Neovim.Context.InternalAbstract description of the plugin provider's internal context
- Neovim.DebugUtilities to debug Neovim and nvim-hs functionality
- Neovim.LogLogging utilities and reexports
- Neovim.MainWrapper for the actual main function
- Neovim.PluginPlugin and functionality registration code
  - Neovim.Plugin.ClassesClasses and data types related to plugins
  - Neovim.Plugin.ConfigHelperHelper plugin to ease recompiling the nvim-hs config
  - Neovim.Plugin.IPCCommunication between Haskell processes/threads
    - Neovim.Plugin.IPC.ClassesClasses used for Inter Plugin Communication
  - Neovim.Plugin.InternalSplit module that can import Neovim.Context without creating import circles
  - Neovim.Plugin.StartupStartup utilities for plugins
- Neovim.QuickfixAPI for interacting with the quickfix list
- RPC
  - Neovim.RPC.ClassesData types and classes for the RPC components
  - Neovim.RPC.CommonCommon functons for the RPC module
  - Neovim.RPC.EventHandlerEvent handling loop
  - Neovim.RPC.FunctionCallFunctions for calling functions
  - Neovim.RPC.SocketReaderThe component which reads RPC messages from the neovim instance
- Neovim.TestTesting functions
- Neovim.UtilUtility functions