HsDev.Project.Types

Documentation

data Project

Cabal project

Constructors

Project

Fields

• _projectName :: Text
• _projectPath :: Path
• _projectCabal :: Path
• _projectDescription :: Maybe ProjectDescription

Instances

Eq Project

Methods

(==) :: Project -> Project -> Bool

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

Ord Project

Methods

compare :: Project -> Project -> Ordering

(<) :: Project -> Project -> Bool

(<=) :: Project -> Project -> Bool

(>) :: Project -> Project -> Bool

(>=) :: Project -> Project -> Bool

max :: Project -> Project -> Project

min :: Project -> Project -> Project

Read Project

Methods

readsPrec :: Int -> ReadS Project

readList :: ReadS [Project]

readPrec :: ReadPrec Project

readListPrec :: ReadPrec [Project]

Show Project

Methods

showsPrec :: Int -> Project -> ShowS

show :: Project -> String

showList :: [Project] -> ShowS

NFData Project

Methods

rnf :: Project -> ()

ToJSON Project

Methods

toJSON :: Project -> Value

toEncoding :: Project -> Encoding

toJSONList :: [Project] -> Value

toEncodingList :: [Project] -> Encoding

FromJSON Project

Methods

parseJSON :: Value -> Parser Project

parseJSONList :: Value -> Parser [Project]

Formattable Project

Methods

formattable :: Project -> FormatFlags -> Formatted

Paths Project

Methods

paths :: Traversal' Project FilePath

Display Project

Methods

display :: Project -> String

displayType :: Project -> String

Documented Project

Methods

brief :: Project -> Text

detailed :: Project -> Text

EnumContents Project

Methods

enumContents :: CommandMonad m => Project -> m ScanContents

projectName :: Lens' Project Text

projectPath :: Lens' Project Path

projectCabal :: Lens' Project Path

projectDescription :: Lens' Project (Maybe ProjectDescription)

project :: FilePath -> Project

Make project by .cabal file

data ProjectDescription

Constructors

ProjectDescription

Fields

• _projectVersion :: Text
• _projectLibrary :: Maybe Library
• _projectExecutables :: [Executable]
• _projectTests :: [Test]

Instances

Eq ProjectDescription

Methods

(==) :: ProjectDescription -> ProjectDescription -> Bool

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

Read ProjectDescription

Methods

readsPrec :: Int -> ReadS ProjectDescription

readList :: ReadS [ProjectDescription]

readPrec :: ReadPrec ProjectDescription

readListPrec :: ReadPrec [ProjectDescription]

Show ProjectDescription

Methods

showsPrec :: Int -> ProjectDescription -> ShowS

show :: ProjectDescription -> String

showList :: [ProjectDescription] -> ShowS

ToJSON ProjectDescription

Methods

toJSON :: ProjectDescription -> Value

toEncoding :: ProjectDescription -> Encoding

toJSONList :: [ProjectDescription] -> Value

toEncodingList :: [ProjectDescription] -> Encoding

FromJSON ProjectDescription

Methods

parseJSON :: Value -> Parser ProjectDescription

parseJSONList :: Value -> Parser [ProjectDescription]

Paths ProjectDescription

Methods

paths :: Traversal' ProjectDescription FilePath

projectVersion :: Lens' ProjectDescription Text

projectLibrary :: Lens' ProjectDescription (Maybe Library)

projectExecutables :: Lens' ProjectDescription [Executable]

projectTests :: Lens' ProjectDescription [Test]

infos :: Traversal' ProjectDescription Info

Build target infos

targetInfos :: ProjectDescription -> [TargetInfo]

Build target infos, more detailed

class Target a where

Minimal complete definition

targetName, buildInfo, targetMain, targetModules

Methods

targetName :: Traversal' a Text

buildInfo :: Lens' a Info

targetMain :: a -> Maybe Path

targetModules :: a -> [[Text]]

Instances

Target Test

Methods

targetName :: Traversal' Test Text

buildInfo :: Lens' Test Info

targetMain :: Test -> Maybe Path

targetModules :: Test -> [[Text]]

Target Executable

Methods

targetName :: Traversal' Executable Text

buildInfo :: Lens' Executable Info

targetMain :: Executable -> Maybe Path

targetModules :: Executable -> [[Text]]

Target Library

Methods

targetName :: Traversal' Library Text

buildInfo :: Lens' Library Info

targetMain :: Library -> Maybe Path

targetModules :: Library -> [[Text]]

Target TargetInfo

Methods

targetName :: Traversal' TargetInfo Text

buildInfo :: Lens' TargetInfo Info

targetMain :: TargetInfo -> Maybe Path

targetModules :: TargetInfo -> [[Text]]

data TargetInfo

Constructors

TargetInfo

Fields

• _targetInfoName :: Maybe Text
• _targetBuildInfo :: Info
• _targetInfoMain :: Maybe Path
• _targetInfoModules :: [[Text]]

Instances

Eq TargetInfo

Methods

(==) :: TargetInfo -> TargetInfo -> Bool

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

Ord TargetInfo

Methods

compare :: TargetInfo -> TargetInfo -> Ordering

(<) :: TargetInfo -> TargetInfo -> Bool

(<=) :: TargetInfo -> TargetInfo -> Bool

(>) :: TargetInfo -> TargetInfo -> Bool

(>=) :: TargetInfo -> TargetInfo -> Bool

max :: TargetInfo -> TargetInfo -> TargetInfo

min :: TargetInfo -> TargetInfo -> TargetInfo

Show TargetInfo

Methods

showsPrec :: Int -> TargetInfo -> ShowS

show :: TargetInfo -> String

showList :: [TargetInfo] -> ShowS

Paths TargetInfo

Methods

paths :: Traversal' TargetInfo FilePath

Target TargetInfo

Methods

targetName :: Traversal' TargetInfo Text

buildInfo :: Lens' TargetInfo Info

targetMain :: TargetInfo -> Maybe Path

targetModules :: TargetInfo -> [[Text]]

targetInfoName :: Lens' TargetInfo (Maybe Text)

targetBuildInfo :: Lens' TargetInfo Info

targetInfoMain :: Lens' TargetInfo (Maybe Path)

targetInfoModules :: Lens' TargetInfo [[Text]]

targetInfo :: Target a => a -> TargetInfo

data Library

Library in project

Constructors

Library

Fields

• _libraryModules :: [[Text]]
• _libraryBuildInfo :: Info

Instances

Eq Library

Methods

(==) :: Library -> Library -> Bool

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

Read Library

Methods

readsPrec :: Int -> ReadS Library

readList :: ReadS [Library]

readPrec :: ReadPrec Library

readListPrec :: ReadPrec [Library]

Show Library

Methods

showsPrec :: Int -> Library -> ShowS

show :: Library -> String

showList :: [Library] -> ShowS

ToJSON Library

Methods

toJSON :: Library -> Value

toEncoding :: Library -> Encoding

toJSONList :: [Library] -> Value

toEncodingList :: [Library] -> Encoding

FromJSON Library

Methods

parseJSON :: Value -> Parser Library

parseJSONList :: Value -> Parser [Library]

Paths Library

Methods

paths :: Traversal' Library FilePath

Target Library

Methods

targetName :: Traversal' Library Text

buildInfo :: Lens' Library Info

targetMain :: Library -> Maybe Path

targetModules :: Library -> [[Text]]

libraryModules :: Lens' Library [[Text]]

libraryBuildInfo :: Lens' Library Info

data Executable

Executable

Constructors

Executable

Fields

• _executableName :: Text
• _executablePath :: Path
• _executableBuildInfo :: Info

Instances

Eq Executable

Methods

(==) :: Executable -> Executable -> Bool

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

Read Executable

Methods

readsPrec :: Int -> ReadS Executable

readList :: ReadS [Executable]

readPrec :: ReadPrec Executable

readListPrec :: ReadPrec [Executable]

Show Executable

Methods

showsPrec :: Int -> Executable -> ShowS

show :: Executable -> String

showList :: [Executable] -> ShowS

ToJSON Executable

Methods

toJSON :: Executable -> Value

toEncoding :: Executable -> Encoding

toJSONList :: [Executable] -> Value

toEncodingList :: [Executable] -> Encoding

FromJSON Executable

Methods

parseJSON :: Value -> Parser Executable

parseJSONList :: Value -> Parser [Executable]

Paths Executable

Methods

paths :: Traversal' Executable FilePath

Target Executable

Methods

targetName :: Traversal' Executable Text

buildInfo :: Lens' Executable Info

targetMain :: Executable -> Maybe Path

targetModules :: Executable -> [[Text]]

executableName :: Lens' Executable Text

executablePath :: Lens' Executable Path

executableBuildInfo :: Lens' Executable Info

data Test

Test

Constructors

Test

Fields

• _testName :: Text
• _testEnabled :: Bool
• _testMain :: Maybe Path
• _testBuildInfo :: Info

Instances

Eq Test

Methods

(==) :: Test -> Test -> Bool

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

Read Test

Methods

readsPrec :: Int -> ReadS Test

readList :: ReadS [Test]

readPrec :: ReadPrec Test

readListPrec :: ReadPrec [Test]

Show Test

Methods

showsPrec :: Int -> Test -> ShowS

show :: Test -> String

showList :: [Test] -> ShowS

ToJSON Test

Methods

toJSON :: Test -> Value

toEncoding :: Test -> Encoding

toJSONList :: [Test] -> Value

toEncodingList :: [Test] -> Encoding

FromJSON Test

Methods

parseJSON :: Value -> Parser Test

parseJSONList :: Value -> Parser [Test]

Paths Test

Methods

paths :: Traversal' Test FilePath

Target Test

Methods

targetName :: Traversal' Test Text

buildInfo :: Lens' Test Info

targetMain :: Test -> Maybe Path

targetModules :: Test -> [[Text]]

testName :: Lens' Test Text

testEnabled :: Lens' Test Bool

testBuildInfo :: Lens' Test Info

testMain :: Lens' Test (Maybe Path)

data Info

Build info

Constructors

Info

Fields

• _infoDepends :: [Text]
• _infoLanguage :: Maybe Language
• _infoExtensions :: [Extension]
• _infoGHCOptions :: [Text]
• _infoSourceDirs :: [Path]
• _infoOtherModules :: [[Text]]

Instances

Eq Info

Methods

(==) :: Info -> Info -> Bool

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

Ord Info

Methods

compare :: Info -> Info -> Ordering

(<) :: Info -> Info -> Bool

(<=) :: Info -> Info -> Bool

(>) :: Info -> Info -> Bool

(>=) :: Info -> Info -> Bool

max :: Info -> Info -> Info

min :: Info -> Info -> Info

Read Info

Methods

readsPrec :: Int -> ReadS Info

readList :: ReadS [Info]

readPrec :: ReadPrec Info

readListPrec :: ReadPrec [Info]

Show Info

Methods

showsPrec :: Int -> Info -> ShowS

show :: Info -> String

showList :: [Info] -> ShowS

Monoid Info

Methods

mempty :: Info

mappend :: Info -> Info -> Info

mconcat :: [Info] -> Info

ToJSON Info

Methods

toJSON :: Info -> Value

toEncoding :: Info -> Encoding

toJSONList :: [Info] -> Value

toEncodingList :: [Info] -> Encoding

FromJSON Info

Methods

parseJSON :: Value -> Parser Info

parseJSONList :: Value -> Parser [Info]

Paths Info

Methods

paths :: Traversal' Info FilePath

infoDepends :: Lens' Info [Text]

infoLanguage :: Lens' Info (Maybe Language)

infoExtensions :: Lens' Info [Extension]

infoGHCOptions :: Lens' Info [Text]

infoSourceDirs :: Lens' Info [Path]

infoOtherModules :: Lens' Info [[Text]]

data Extensions a

Entity with project extensions

Constructors

Extensions

Fields

• _extensions :: [Extension]
• _ghcOptions :: [Text]
• _entity :: a

Instances

Functor Extensions

Methods

fmap :: (a -> b) -> Extensions a -> Extensions b

(<$) :: a -> Extensions b -> Extensions a

Applicative Extensions

Methods

pure :: a -> Extensions a

(<*>) :: Extensions (a -> b) -> Extensions a -> Extensions b

liftA2 :: (a -> b -> c) -> Extensions a -> Extensions b -> Extensions c

(*>) :: Extensions a -> Extensions b -> Extensions b

(<*) :: Extensions a -> Extensions b -> Extensions a

Foldable Extensions

Methods

fold :: Monoid m => Extensions m -> m

foldMap :: Monoid m => (a -> m) -> Extensions a -> m

foldr :: (a -> b -> b) -> b -> Extensions a -> b

foldr' :: (a -> b -> b) -> b -> Extensions a -> b

foldl :: (b -> a -> b) -> b -> Extensions a -> b

foldl' :: (b -> a -> b) -> b -> Extensions a -> b

foldr1 :: (a -> a -> a) -> Extensions a -> a

foldl1 :: (a -> a -> a) -> Extensions a -> a

toList :: Extensions a -> [a]

null :: Extensions a -> Bool

length :: Extensions a -> Int

elem :: Eq a => a -> Extensions a -> Bool

maximum :: Ord a => Extensions a -> a

minimum :: Ord a => Extensions a -> a

sum :: Num a => Extensions a -> a

product :: Num a => Extensions a -> a

Traversable Extensions

Methods

traverse :: Applicative f => (a -> f b) -> Extensions a -> f (Extensions b)

sequenceA :: Applicative f => Extensions (f a) -> f (Extensions a)

mapM :: Monad m => (a -> m b) -> Extensions a -> m (Extensions b)

sequence :: Monad m => Extensions (m a) -> m (Extensions a)

Eq a => Eq (Extensions a)

Methods

(==) :: Extensions a -> Extensions a -> Bool

(/=) :: Extensions a -> Extensions a -> Bool

Ord a => Ord (Extensions a)

Methods

compare :: Extensions a -> Extensions a -> Ordering

(<) :: Extensions a -> Extensions a -> Bool

(<=) :: Extensions a -> Extensions a -> Bool

(>) :: Extensions a -> Extensions a -> Bool

(>=) :: Extensions a -> Extensions a -> Bool

max :: Extensions a -> Extensions a -> Extensions a

min :: Extensions a -> Extensions a -> Extensions a

Read a => Read (Extensions a)

Methods

readsPrec :: Int -> ReadS (Extensions a)

readList :: ReadS [Extensions a]

readPrec :: ReadPrec (Extensions a)

readListPrec :: ReadPrec [Extensions a]

Show a => Show (Extensions a)

Methods

showsPrec :: Int -> Extensions a -> ShowS

show :: Extensions a -> String

showList :: [Extensions a] -> ShowS

EnumContents (Extensions ModuleLocation)

Methods

enumContents :: CommandMonad m => Extensions ModuleLocation -> m ScanContents

extensions :: forall a. Lens' (Extensions a) [Extension]

ghcOptions :: forall a. Lens' (Extensions a) [Text]

entity :: forall a a. Lens (Extensions a) (Extensions a) a a

Orphan instances

ToJSON Language

Methods

toJSON :: Language -> Value

toEncoding :: Language -> Encoding

toJSONList :: [Language] -> Value

toEncodingList :: [Language] -> Encoding

ToJSON Extension

Methods

toJSON :: Extension -> Value

toEncoding :: Extension -> Encoding

toJSONList :: [Extension] -> Value

toEncodingList :: [Extension] -> Encoding

FromJSON Language

Methods

parseJSON :: Value -> Parser Language

parseJSONList :: Value -> Parser [Language]

FromJSON Extension

Methods

parseJSON :: Value -> Parser Extension

parseJSONList :: Value -> Parser [Extension]