Documentation

The stack of plugin internals.

The complete stack of a Neovim plugin.

Run plugin internals without IO effects.

Run the main loop for a remote plugin.

Run plugin internals and IO effects for a remote plugin, reading options from the CLI.

Like runRemoteStack, but allows the CLI option parser to be specified.

Run plugin internals and IO effects for a remote plugin, reading options from the CLI.

Run a Neovim plugin using a set of handlers and configuration, with an arbitrary stack of custom effects placed between the handlers and the Ribosome stack.

Like runNvimPluginIO, but allows the PluginConfig to contain a CLI parser for an arbitrary type c that is then provided in a Reader c to the plugin.

This is separate from runNvimPluginIO because it requires a type hint when using OverloadedStrings or def to construct the config without an option parser.

Run a Neovim plugin using a set of handlers and configuration, with an arbitrary stack of custom effects placed between the handlers and the Ribosome stack. This is important, because the custom effects may want to use the Neovim API, while the handlers want to use both Neovim and the custom effects.

Example:

data Numbers :: Effect where
  Number :: Int -> Sem r Int

makeSem ''Numbers

runNumbers :: Member (Rpc !! RpcError) r => InterpreterFor Numbers r
runNumbers = \case
  Number i -> (-1) <! nvimGetVar ("number_" <> show i)

type CustomStack = [AtomicState Int, Numbers]

currentNumber :: Handler r Int
currentNumber = number =<< atomicGet

setNumber :: Int -> Handler r ()
setNumber = atomicPut

runCustomStack :: InterpretersFor CustomStack r
runCustomStack = interpretAtomic . runNumbers

main :: IO ()
main = runNvimPluginIO @CustomStack "numbers" runCustomStack [
  rpcFunction "CurrentNumber" Sync currentNumber,
  rpcFunction "SetNumber" Async setNumber
  ]

Note:

• PluginConfig is being constructed via OverloadedStrings
• CustomStack has to be specified as a type application, because GHC cannot figure it out on its own.
• For an explanation of Rpc !! RpcError, see Errors

This runs the entire stack to completion, so it can be used in the app's main function.

For more flexibility and less type inference noise, this can be inlined as:

runRemoteStack conf $ runCustomStack $ withHandlers handlers remotePlugin

Run a Neovim plugin using a set of handlers and configuration.

This function does not allow additional effects to be used. See runNvimPluginIO for that purpose.

This runs the entire stack to completion, so it can be used in the app's main function.