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

Neovim.BuildTool

Description

Synopsis

data BuildTool
- = Stack
- | Cabal CabalType
- | Shake
- | Make
- | Cmake
- | Ninja
- | Scons
- | Custom
data CabalType
- = Plain
- | Sandbox
- | NewBuild
newtype Directory = Directory {
- getDirectory :: FilePath
}
partialM :: Monad m => (a -> m Bool) -> a -> m (Maybe a)
mkDirectory :: MonadIO io => FilePath -> io (Maybe Directory)
newtype File = File {
- getFile :: FilePath
}
mkFile :: MonadIO io => Maybe Directory -> FilePath -> io (Maybe File)
thisAndParentDirectories :: Directory -> [Directory]
determineProjectSettings :: MonadIO io => [Directory -> io (Maybe BuildTool)] -> [Directory] -> io (Maybe (BuildTool, Directory))
defaultProjectIdentifiers :: MonadIO io => [Directory -> io (Maybe BuildTool)]
guessProjectSettings :: MonadIO io => [Directory] -> io (Maybe (BuildTool, Directory))
maybeStack :: MonadIO io => Directory -> io (Maybe BuildTool)
maybeCabalSandbox :: MonadIO io => Directory -> io (Maybe BuildTool)
maybeCabal :: MonadIO io => Directory -> io (Maybe BuildTool)

Documentation

data BuildTool Source #

Constructors

Stack
Cabal CabalType
Shake
Make
Cmake
Ninja
Scons
Custom

Instances

Instances details

FromJSON BuildTool Source #
Instance details Defined in Neovim.BuildTool Methods parseJSON :: Value -> Parser BuildTool # parseJSONList :: Value -> Parser [BuildTool] #
ToJSON BuildTool Source #
Instance details Defined in Neovim.BuildTool Methods toJSON :: BuildTool -> Value # toEncoding :: BuildTool -> Encoding # toJSONList :: [BuildTool] -> Value # toEncodingList :: [BuildTool] -> Encoding #
Generic BuildTool Source #
Instance details Defined in Neovim.BuildTool Associated Types type Rep BuildTool :: Type -> Type # Methods from :: BuildTool -> Rep BuildTool x # to :: Rep BuildTool x -> BuildTool #
Read BuildTool Source #
Instance details Defined in Neovim.BuildTool Methods readsPrec :: Int -> ReadS BuildTool # readList :: ReadS [BuildTool] # readPrec :: ReadPrec BuildTool # readListPrec :: ReadPrec [BuildTool] #
Show BuildTool Source #
Instance details Defined in Neovim.BuildTool Methods showsPrec :: Int -> BuildTool -> ShowS # show :: BuildTool -> String # showList :: [BuildTool] -> ShowS #
Eq BuildTool Source #
Instance details Defined in Neovim.BuildTool Methods (==) :: BuildTool -> BuildTool -> Bool # (/=) :: BuildTool -> BuildTool -> Bool #
Ord BuildTool Source #
Instance details Defined in Neovim.BuildTool Methods compare :: BuildTool -> BuildTool -> Ordering # (<) :: BuildTool -> BuildTool -> Bool # (<=) :: BuildTool -> BuildTool -> Bool # (>) :: BuildTool -> BuildTool -> Bool # (>=) :: BuildTool -> BuildTool -> Bool # max :: BuildTool -> BuildTool -> BuildTool # min :: BuildTool -> BuildTool -> BuildTool #
type Rep BuildTool Source #
Instance details Defined in Neovim.BuildTool type Rep BuildTool = D1 ('MetaData "BuildTool" "Neovim.BuildTool" "nvim-hs-contrib-2.0.0.2-Gm8wSVtVXN12gBOJCuNT9F" 'False) (((C1 ('MetaCons "Stack" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Cabal" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CabalType))) :+: (C1 ('MetaCons "Shake" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Make" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Cmake" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Ninja" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Scons" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Custom" 'PrefixI 'False) (U1 :: Type -> Type))))

data CabalType Source #

Constructors

Plain
Sandbox
NewBuild

Instances

Instances details

FromJSON CabalType Source #
Instance details Defined in Neovim.BuildTool Methods parseJSON :: Value -> Parser CabalType # parseJSONList :: Value -> Parser [CabalType] #
ToJSON CabalType Source #
Instance details Defined in Neovim.BuildTool Methods toJSON :: CabalType -> Value # toEncoding :: CabalType -> Encoding # toJSONList :: [CabalType] -> Value # toEncodingList :: [CabalType] -> Encoding #
Enum CabalType Source #
Instance details Defined in Neovim.BuildTool Methods succ :: CabalType -> CabalType # pred :: CabalType -> CabalType # toEnum :: Int -> CabalType # fromEnum :: CabalType -> Int # enumFrom :: CabalType -> [CabalType] # enumFromThen :: CabalType -> CabalType -> [CabalType] # enumFromTo :: CabalType -> CabalType -> [CabalType] # enumFromThenTo :: CabalType -> CabalType -> CabalType -> [CabalType] #
Generic CabalType Source #
Instance details Defined in Neovim.BuildTool Associated Types type Rep CabalType :: Type -> Type # Methods from :: CabalType -> Rep CabalType x # to :: Rep CabalType x -> CabalType #
Read CabalType Source #
Instance details Defined in Neovim.BuildTool Methods readsPrec :: Int -> ReadS CabalType # readList :: ReadS [CabalType] # readPrec :: ReadPrec CabalType # readListPrec :: ReadPrec [CabalType] #
Show CabalType Source #
Instance details Defined in Neovim.BuildTool Methods showsPrec :: Int -> CabalType -> ShowS # show :: CabalType -> String # showList :: [CabalType] -> ShowS #
Eq CabalType Source #
Instance details Defined in Neovim.BuildTool Methods (==) :: CabalType -> CabalType -> Bool # (/=) :: CabalType -> CabalType -> Bool #
Ord CabalType Source #
Instance details Defined in Neovim.BuildTool Methods compare :: CabalType -> CabalType -> Ordering # (<) :: CabalType -> CabalType -> Bool # (<=) :: CabalType -> CabalType -> Bool # (>) :: CabalType -> CabalType -> Bool # (>=) :: CabalType -> CabalType -> Bool # max :: CabalType -> CabalType -> CabalType # min :: CabalType -> CabalType -> CabalType #
type Rep CabalType Source #
Instance details Defined in Neovim.BuildTool type Rep CabalType = D1 ('MetaData "CabalType" "Neovim.BuildTool" "nvim-hs-contrib-2.0.0.2-Gm8wSVtVXN12gBOJCuNT9F" 'False) (C1 ('MetaCons "Plain" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Sandbox" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NewBuild" 'PrefixI 'False) (U1 :: Type -> Type)))

newtype Directory Source #

Constructors

Directory
Fields getDirectory :: FilePath

Instances

Instances details

Show Directory Source #
Instance details Defined in Neovim.BuildTool Methods showsPrec :: Int -> Directory -> ShowS # show :: Directory -> String # showList :: [Directory] -> ShowS #
Eq Directory Source #
Instance details Defined in Neovim.BuildTool Methods (==) :: Directory -> Directory -> Bool # (/=) :: Directory -> Directory -> Bool #
Ord Directory Source #
Instance details Defined in Neovim.BuildTool Methods compare :: Directory -> Directory -> Ordering # (<) :: Directory -> Directory -> Bool # (<=) :: Directory -> Directory -> Bool # (>) :: Directory -> Directory -> Bool # (>=) :: Directory -> Directory -> Bool # max :: Directory -> Directory -> Directory # min :: Directory -> Directory -> Directory #

partialM :: Monad m => (a -> m Bool) -> a -> m (Maybe a) Source #

If the monadic boolean predicate returns true, wrap the given object in a Just constructor, otherwise return Nothing.

mkDirectory :: MonadIO io => FilePath -> io (Maybe Directory) Source #

Create Just a Directory value if the given filepath exists and otherwise return Nothing. This method does not create an actual directory on your file system.

newtype File Source #

Constructors

File
Fields getFile :: FilePath

Instances

Instances details

Show File Source #
Instance details Defined in Neovim.BuildTool Methods showsPrec :: Int -> File -> ShowS # show :: File -> String # showList :: [File] -> ShowS #
Eq File Source #
Instance details Defined in Neovim.BuildTool Methods (==) :: File -> File -> Bool # (/=) :: File -> File -> Bool #
Ord File Source #
Instance details Defined in Neovim.BuildTool Methods compare :: File -> File -> Ordering # (<) :: File -> File -> Bool # (<=) :: File -> File -> Bool # (>) :: File -> File -> Bool # (>=) :: File -> File -> Bool # max :: File -> File -> File # min :: File -> File -> File #

mkFile :: MonadIO io => Maybe Directory -> FilePath -> io (Maybe File) Source #

Create Just a File value if the given file exists and is not a directory. Otherwise return Nothing. This function does not alter your filesystem.

thisAndParentDirectories :: Directory -> [Directory] Source #

Calculate the list of all parent directories for the given directory. This function also returns the initially specified directory.

determineProjectSettings :: MonadIO io => [Directory -> io (Maybe BuildTool)] -> [Directory] -> io (Maybe (BuildTool, Directory)) Source #

Given a list of build tool identifier functions, apply these to all the given directories and return the value of the first function that returns a BuildTool value or Nothing if no function ever returns a BuildTool. The identifier functions and directories are tried in the order as supplied to this function.

defaultProjectIdentifiers :: MonadIO io => [Directory -> io (Maybe BuildTool)] Source #

This list contains some build tool identifier functions for usual setups.

guessProjectSettings :: MonadIO io => [Directory] -> io (Maybe (BuildTool, Directory)) Source #

Same as determineProjectSettings defaultProjetIdentifiers.

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

Check if directory contains a stack.yaml file and return Just Stack in this case.

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

Check if the directory contains a cabal.sandbox.config file and return Just (Cabal Sandbox) in that case.

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

Check if the directory contains a cabal file and return Just (Cabal Plain) if present.