Stack.Path

Types and functions related to Stack's path command.

Documentation

data PathInfo

Type representing information passed to all the path printers.

Instances

HasPantryConfig PathInfo

Defined in Stack.Path

Methods

pantryConfigL :: Lens' PathInfo PantryConfig

HasLogFunc PathInfo

Defined in Stack.Path

Methods

logFuncL :: Lens' PathInfo LogFunc

HasProcessContext PathInfo

Defined in Stack.Path

Methods

processContextL :: Lens' PathInfo ProcessContext

HasTerm PathInfo

Defined in Stack.Path

Methods

useColorL :: Lens' PathInfo Bool

termWidthL :: Lens' PathInfo Int

HasStylesUpdate PathInfo

Defined in Stack.Path

Methods

stylesUpdateL :: Lens' PathInfo StylesUpdate

HasBuildConfig PathInfo

Defined in Stack.Path

Methods

buildConfigL :: Lens' PathInfo BuildConfig

HasConfig PathInfo

Defined in Stack.Path

Methods

configL :: Lens' PathInfo Config

HasGHCVariant PathInfo

Defined in Stack.Path

Methods

ghcVariantL :: SimpleGetter PathInfo GHCVariant

HasPlatform PathInfo

Defined in Stack.Path

Methods

platformL :: Lens' PathInfo Platform

platformVariantL :: Lens' PathInfo PlatformVariant

HasRunner PathInfo

Defined in Stack.Path

Methods

runnerL :: Lens' PathInfo Runner

path :: [Text] -> RIO Runner ()

Print out useful path information in a human-readable format (and support others later).

paths :: [(String, Text, UseHaddocks (PathInfo -> Text))]

The paths of interest to a user. The first tuple string is used for a description that the optparse flag uses, and the second string as a machine-readable key and also for --foo flags. The user can choose a specific path to list like --stack-root. But really it's mainly for the documentation aspect.

When printing output we generate PathInfo and pass it to the function to generate an appropriate string. Trailing slashes are removed, see #506.