Copyright	(c) Sebastian Witte
License	Apache-2.0
Maintainer	woozletoff@gmail.com
Stability	experimental
Portability	GHC
Safe Haskell	Safe-Inferred
Language	Haskell2010

Neovim.Ghcid.Plugin

Description

Synopsis

data ProjectSettings = ProjectSettings {
- rootDir :: FilePath
- cmd :: String
}
data GhcidEnv = GhcidEnv {
- startedSessions :: TVar (Map FilePath (Ghci, Neovim GhcidEnv ()))
- quickfixItems :: TVar [QuickfixListItem String]
}
initGhcidEnv :: MonadIO m => m GhcidEnv
modifyStartedSessions :: (Map FilePath (Ghci, Neovim GhcidEnv ()) -> Map FilePath (Ghci, Neovim GhcidEnv ())) -> Neovim GhcidEnv ()
ghcidStart :: CommandArguments -> Neovim GhcidEnv ()
startOrReload :: ProjectSettings -> Neovim GhcidEnv ()
applyQuickfixActions :: [QuickfixListItem String] -> Neovim GhcidEnv ()
placeSigns :: [QuickfixListItem String] -> Neovim env ()
ghcidStop :: CommandArguments -> Neovim GhcidEnv ()
ghcidRestart :: CommandArguments -> Neovim GhcidEnv ()
loadToQuickfix :: [Load] -> [QuickfixListItem String]
maybePluginConfig :: MonadIO io => Directory -> io (Maybe BuildTool)
determineProjectSettings' :: FilePath -> IO (Maybe ProjectSettings)

Documentation

data ProjectSettings Source #

Simple data type containing a few information on how to start ghcid.

Constructors

ProjectSettings
Fields rootDir :: FilePath Project directory from which ghcid can be started successfully. cmd :: String Command to start a ghci session (usually `cabal repl` or `stack ghci`).

Instances

Instances details

FromJSON ProjectSettings Source #
Instance details Defined in Neovim.Ghcid.Plugin Methods parseJSON :: Value -> Parser ProjectSettings # parseJSONList :: Value -> Parser [ProjectSettings] #
ToJSON ProjectSettings Source #
Instance details Defined in Neovim.Ghcid.Plugin Methods toJSON :: ProjectSettings -> Value # toEncoding :: ProjectSettings -> Encoding # toJSONList :: [ProjectSettings] -> Value # toEncodingList :: [ProjectSettings] -> Encoding #
Generic ProjectSettings Source #
Instance details Defined in Neovim.Ghcid.Plugin Associated Types type Rep ProjectSettings :: Type -> Type # Methods from :: ProjectSettings -> Rep ProjectSettings x # to :: Rep ProjectSettings x -> ProjectSettings #
Show ProjectSettings Source #
Instance details Defined in Neovim.Ghcid.Plugin Methods showsPrec :: Int -> ProjectSettings -> ShowS # show :: ProjectSettings -> String # showList :: [ProjectSettings] -> ShowS #
Eq ProjectSettings Source #
Instance details Defined in Neovim.Ghcid.Plugin Methods (==) :: ProjectSettings -> ProjectSettings -> Bool # (/=) :: ProjectSettings -> ProjectSettings -> Bool #
Ord ProjectSettings Source #
Instance details Defined in Neovim.Ghcid.Plugin Methods compare :: ProjectSettings -> ProjectSettings -> Ordering # (<) :: ProjectSettings -> ProjectSettings -> Bool # (<=) :: ProjectSettings -> ProjectSettings -> Bool # (>) :: ProjectSettings -> ProjectSettings -> Bool # (>=) :: ProjectSettings -> ProjectSettings -> Bool # max :: ProjectSettings -> ProjectSettings -> ProjectSettings # min :: ProjectSettings -> ProjectSettings -> ProjectSettings #
type Rep ProjectSettings Source #
Instance details Defined in Neovim.Ghcid.Plugin type Rep ProjectSettings = D1 ('MetaData "ProjectSettings" "Neovim.Ghcid.Plugin" "nvim-hs-ghcid-2.0.1.0-pRFBONThxeEWeY0WSfNze" 'False) (C1 ('MetaCons "ProjectSettings" 'PrefixI 'True) (S1 ('MetaSel ('Just "rootDir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: S1 ('MetaSel ('Just "cmd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

data GhcidEnv Source #

Constructors

GhcidEnv
Fields startedSessions :: TVar (Map FilePath (Ghci, Neovim GhcidEnv ())) A map from the root directory (see `rootDir`) to a `Ghci` session and a release function which unregisters some autocmds and stops the ghci session. quickfixItems :: TVar [QuickfixListItem String]

initGhcidEnv :: MonadIO m => m GhcidEnv Source #

modifyStartedSessions :: (Map FilePath (Ghci, Neovim GhcidEnv ()) -> Map FilePath (Ghci, Neovim GhcidEnv ())) -> Neovim GhcidEnv () Source #

ghcidStart :: CommandArguments -> Neovim GhcidEnv () Source #

Start or update a ghcid session.

This will call determineProjectSettings and ask you to confirm or overwrite its proposed settings. If you prepend a bang, it acts as if you have confirmed all settings.

startOrReload :: ProjectSettings -> Neovim GhcidEnv () Source #

Start a new ghcid session or reload the modules to update the quickfix list.

applyQuickfixActions :: [QuickfixListItem String] -> Neovim GhcidEnv () Source #

placeSigns :: [QuickfixListItem String] -> Neovim env () Source #

ghcidStop :: CommandArguments -> Neovim GhcidEnv () Source #

Stop a ghcid session associated to the currently active buffer.

ghcidRestart :: CommandArguments -> Neovim GhcidEnv () Source #

Same as :GhcidStop followed by :GhcidStart!. Note the bang!

loadToQuickfix :: [Load] -> [QuickfixListItem String] Source #

maybePluginConfig :: MonadIO io => Directory -> io (Maybe BuildTool) Source #

determineProjectSettings' :: FilePath -> IO (Maybe ProjectSettings) Source #

Determine project settings for a directory.

This will traverse through all parent directories and search for a hint on how to start the ghcid background process. The following configurations will be tried in this order:

A ghcid.yaml file which can be created with the GhcidStart command
A stack.yaml file
A cabal.sandbox.config file
A *.cabal file

Note that ghcidStart prompts for confirmation unless you prepend a bang. So, if you want to use your preferred settings, simply save them to the ghcid.yaml file and you're done.