Neovim.Main

Documentation

logger :: String

data CommandLineOptions

Constructors

Opt

Fields

• providerName :: Maybe String
• hostPort :: Maybe (String, Int)
• unix :: Maybe FilePath
• env :: Bool
• logOpts :: Maybe (FilePath, Priority)

Instances

Default CommandLineOptions

Methods

def :: CommandLineOptions

optParser :: Parser CommandLineOptions

opts :: ParserInfo CommandLineOptions

neovim :: NeovimConfig -> IO ()

This is essentially the main function for nvim-hs, at least if you want to use Config.Dyre for the configuration.

type TransitionHandler a = [ThreadId] -> Config RPCConfig () -> IO a

A TransitionHandler function receives the ThreadIds of all running threads which have been started by the plugin provider as well as the Config with the custom field set to RPCConfig. These information can be used to properly clean up a session and then do something else. The transition handler is first called after the plugin provider has started.

realMain :: TransitionHandler a -> Maybe (Params NeovimConfig) -> NeovimConfig -> IO ()

This main functions can be used to create a custom executable without using the Config.Dyre library while still using the nvim-hs specific configuration facilities.

runPluginProvider

Arguments

:: CommandLineOptions

See nvim-hs executables --help function or optParser

-> Maybe NeovimConfig

-> TransitionHandler a

-> Maybe (Params NeovimConfig)

-> IO a

Generic main function. Most arguments are optional or have sane defaults.

finishDyre :: TransitionHandler ()

If the plugin provider is started with dyre, this handler is used to handle a restart.