Neovim.Ghcid.Plugin

Documentation

data ProjectSettings

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

Eq ProjectSettings

Methods

(==) :: ProjectSettings -> ProjectSettings -> Bool

(/=) :: ProjectSettings -> ProjectSettings -> Bool

Ord ProjectSettings

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

Show ProjectSettings

Methods

showsPrec :: Int -> ProjectSettings -> ShowS

show :: ProjectSettings -> String

showList :: [ProjectSettings] -> ShowS

Generic ProjectSettings

Associated Types

type Rep ProjectSettings :: * -> *

Methods

from :: ProjectSettings -> Rep ProjectSettings x

to :: Rep ProjectSettings x -> ProjectSettings

ToJSON ProjectSettings

Methods

toJSON :: ProjectSettings -> Value

toEncoding :: ProjectSettings -> Encoding

toJSONList :: [ProjectSettings] -> Value

toEncodingList :: [ProjectSettings] -> Encoding

FromJSON ProjectSettings

Methods

parseJSON :: Value -> Parser ProjectSettings

parseJSONList :: Value -> Parser [ProjectSettings]

type Rep ProjectSettings

type Rep ProjectSettings = D1 * (MetaData "ProjectSettings" "Neovim.Ghcid.Plugin" "nvim-hs-ghcid-1.0.0.0-2SCjQ5t4f2H1mj84Wigpjx" False) (C1 * (MetaCons "ProjectSettings" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "rootDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * FilePath)) (S1 * (MetaSel (Just Symbol "cmd") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * String))))

data GhcidEnv

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

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

ghcidStart :: CommandArguments -> Neovim GhcidEnv ()

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 ()

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

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

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

ghcidStop :: CommandArguments -> Neovim GhcidEnv ()

Stop a ghcid session associated to the currently active buffer.

ghcidRestart :: CommandArguments -> Neovim GhcidEnv ()

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

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

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

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

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.