Safe Haskell	None
Language	Haskell2010

Stack.Dot

Synopsis

dot :: DotOpts -> RIO Runner ()
listDependencies :: ListDepsOpts -> RIO Runner ()
data DotOpts = DotOpts {
- dotIncludeExternal :: !Bool
- dotIncludeBase :: !Bool
- dotDependencyDepth :: !(Maybe Int)
- dotPrune :: !(Set PackageName)
- dotTargets :: [Text]
- dotFlags :: !(Map ApplyCLIFlag (Map FlagName Bool))
- dotTestTargets :: Bool
- dotBenchTargets :: Bool
- dotGlobalHints :: Bool
}
data DotPayload = DotPayload {
- payloadVersion :: Maybe Version
- payloadLicense :: Maybe (Either License License)
}
data ListDepsOpts = ListDepsOpts {
- listDepsDotOpts :: !DotOpts
- listDepsSep :: !Text
- listDepsLicense :: !Bool
- listDepsTree :: !Bool
}
resolveDependencies :: (Applicative m, Monad m) => Maybe Int -> Map PackageName (Set PackageName, DotPayload) -> (PackageName -> m (Set PackageName, DotPayload)) -> m (Map PackageName (Set PackageName, DotPayload))
printGraph :: (Applicative m, MonadIO m) => DotOpts -> Set PackageName -> Map PackageName (Set PackageName, DotPayload) -> m ()
pruneGraph :: (Foldable f, Foldable g, Eq a) => f PackageName -> g PackageName -> Map PackageName (Set PackageName, a) -> Map PackageName (Set PackageName, a)

Documentation

dot :: DotOpts -> RIO Runner () Source #

Visualize the project's dependencies as a graphviz graph

listDependencies :: ListDepsOpts -> RIO Runner () Source #

data DotOpts Source #

Options record for stack dot

Constructors

DotOpts

Fields

dotIncludeExternal :: !Bool
Include external dependencies
dotIncludeBase :: !Bool
Include dependencies on base
dotDependencyDepth :: !(Maybe Int)
Limit the depth of dependency resolution to (Just n) or continue until fixpoint
dotPrune :: !(Set PackageName)
Package names to prune from the graph
dotTargets :: [Text]
stack TARGETs to trace dependencies for
dotFlags :: !(Map ApplyCLIFlag (Map FlagName Bool))
Flags to apply when calculating dependencies
dotTestTargets :: Bool
Like the "--test" flag for build, affects the meaning of dotTargets.
dotBenchTargets :: Bool
Like the "--bench" flag for build, affects the meaning of dotTargets.
dotGlobalHints :: Bool
Use global hints instead of relying on an actual GHC installation.

data DotPayload Source #

Information about a package in the dependency graph, when available.

Constructors

DotPayload
Fields payloadVersion :: Maybe Version The package version. payloadLicense :: Maybe (Either License License) The license the package was released under.

Instances

Eq DotPayload Source #
Instance details Defined in Stack.Dot Methods (==) :: DotPayload -> DotPayload -> Bool # (/=) :: DotPayload -> DotPayload -> Bool #
Show DotPayload Source #
Instance details Defined in Stack.Dot Methods showsPrec :: Int -> DotPayload -> ShowS # show :: DotPayload -> String # showList :: [DotPayload] -> ShowS #

data ListDepsOpts Source #

Constructors

ListDepsOpts
Fields listDepsDotOpts :: !DotOpts The normal dot options. listDepsSep :: !Text Separator between the package name and details. listDepsLicense :: !Bool Print dependency licenses instead of versions. listDepsTree :: !Bool Print dependency tree.

resolveDependencies :: (Applicative m, Monad m) => Maybe Int -> Map PackageName (Set PackageName, DotPayload) -> (PackageName -> m (Set PackageName, DotPayload)) -> m (Map PackageName (Set PackageName, DotPayload)) Source #

Resolve the dependency graph up to (Just depth) or until fixpoint is reached

printGraph Source #

Arguments

:: (Applicative m, MonadIO m)
=> DotOpts
-> Set PackageName	all locals
-> Map PackageName (Set PackageName, DotPayload)
-> m ()

Print a graphviz graph of the edges in the Map and highlight the given local packages

pruneGraph :: (Foldable f, Foldable g, Eq a) => f PackageName -> g PackageName -> Map PackageName (Set PackageName, a) -> Map PackageName (Set PackageName, a) Source #

pruneGraph dontPrune toPrune graph prunes all packages in graph with a name in toPrune and removes resulting orphans unless they are in dontPrune