Stack.Types.NamedComponent

Module exporting the NamedComponent type and related functions.

Documentation

data NamedComponent

Type representing components of a fully-resolved Cabal package.

Constructors

CLib

CSubLib !Text

CFlib !Text

CExe !Text

CTest !Text

CBench !Text

Instances

Show NamedComponent

Defined in Stack.Types.NamedComponent

Methods

showsPrec :: Int -> NamedComponent -> ShowS

show :: NamedComponent -> String

showList :: [NamedComponent] -> ShowS

Eq NamedComponent

Defined in Stack.Types.NamedComponent

Methods

(==) :: NamedComponent -> NamedComponent -> Bool

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

Ord NamedComponent

Defined in Stack.Types.NamedComponent

Methods

compare :: NamedComponent -> NamedComponent -> Ordering

(<) :: NamedComponent -> NamedComponent -> Bool

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

(>) :: NamedComponent -> NamedComponent -> Bool

(>=) :: NamedComponent -> NamedComponent -> Bool

max :: NamedComponent -> NamedComponent -> NamedComponent

min :: NamedComponent -> NamedComponent -> NamedComponent

HasField "qualifiedName" StackBenchmark NamedComponent

Defined in Stack.Types.Component

Methods

getField :: StackBenchmark -> NamedComponent

HasField "qualifiedName" StackExecutable NamedComponent

Defined in Stack.Types.Component

Methods

getField :: StackExecutable -> NamedComponent

HasField "qualifiedName" StackForeignLibrary NamedComponent

Defined in Stack.Types.Component

Methods

getField :: StackForeignLibrary -> NamedComponent

HasField "qualifiedName" StackLibrary NamedComponent

Defined in Stack.Types.Component

Methods

getField :: StackLibrary -> NamedComponent

HasField "qualifiedName" StackTestSuite NamedComponent

Defined in Stack.Types.Component

Methods

getField :: StackTestSuite -> NamedComponent

renderComponent :: NamedComponent -> Text

renderComponentTo :: IsString a => NamedComponent -> a

Render a component to anything with an IsString instance. For Text prefer renderComponent.

renderPkgComponents :: [(PackageName, NamedComponent)] -> Text

renderPkgComponent :: (PackageName, NamedComponent) -> Text

exeComponents :: Set NamedComponent -> Set Text

testComponents :: Set NamedComponent -> Set Text

benchComponents :: Set NamedComponent -> Set Text

subLibComponents :: Set NamedComponent -> Set Text

isCLib :: NamedComponent -> Bool

isCSubLib :: NamedComponent -> Bool

isCExe :: NamedComponent -> Bool

isCTest :: NamedComponent -> Bool

isCBench :: NamedComponent -> Bool

isPotentialDependency :: NamedComponent -> Bool

splitComponents :: [NamedComponent] -> (Set Text, Set Text, Set Text, Set Text)

A function to split the given list of components into sets of the names of the named components by the type of component (sub-libraries, executables, test-suites, benchmarks), ignoring any main unnamed library component or foreign library component. This function should be used very sparingly; more often than not, you can keep/parse the components split from the start.