Stack.Path

Types and functions related to Stack's path command.

Documentation

data EnvConfigPathInfo

Instances

HasPantryConfig EnvConfigPathInfo

Defined in Stack.Path

Methods

pantryConfigL :: Lens' EnvConfigPathInfo PantryConfig

HasLogFunc EnvConfigPathInfo

Defined in Stack.Path

Methods

logFuncL :: Lens' EnvConfigPathInfo LogFunc

HasProcessContext EnvConfigPathInfo

Defined in Stack.Path

Methods

processContextL :: Lens' EnvConfigPathInfo ProcessContext

HasTerm EnvConfigPathInfo

Defined in Stack.Path

Methods

useColorL :: Lens' EnvConfigPathInfo Bool

termWidthL :: Lens' EnvConfigPathInfo Int

HasStylesUpdate EnvConfigPathInfo

Defined in Stack.Path

Methods

stylesUpdateL :: Lens' EnvConfigPathInfo StylesUpdate

HasBuildConfig EnvConfigPathInfo

Defined in Stack.Path

Methods

buildConfigL :: Lens' EnvConfigPathInfo BuildConfig

HasConfig EnvConfigPathInfo

Defined in Stack.Path

Methods

configL :: Lens' EnvConfigPathInfo Config

HasGHCVariant EnvConfigPathInfo

Defined in Stack.Path

Methods

ghcVariantL :: SimpleGetter EnvConfigPathInfo GHCVariant

HasPlatform EnvConfigPathInfo

Defined in Stack.Path

Methods

platformL :: Lens' EnvConfigPathInfo Platform

platformVariantL :: Lens' EnvConfigPathInfo PlatformVariant

HasRunner EnvConfigPathInfo

Defined in Stack.Path

Methods

runnerL :: Lens' EnvConfigPathInfo Runner

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

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

pathsFromRunner :: (String, Text)

The paths of interest to a user which do require a Config or EnvConfig. 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.

pathsFromConfig :: [(String, Text, Config -> Text)]

The paths of interest to a user which do require an EnvConfig. 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 Config and pass it to the function to generate an appropriate string. Trailing slashes are removed, see #506.

pathsFromEnvConfig :: [(String, Text, UseHaddocks (EnvConfigPathInfo -> Text))]

The paths of interest to a user which require a EnvConfig. 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 --project-root. But really it's mainly for the documentation aspect.

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