License	BSD-3-Clause
Safe Haskell	None
Language	GHC2024

Stack.Path

Description

Types and functions related to Stack's path command.

Synopsis

data EnvConfigPathInfo
data UseHaddocks a
path :: [Text] -> RIO Runner ()
pathsFromRunner :: (String, Text)
pathsFromConfig :: [(String, Text, Config -> Text)]
pathsFromEnvConfig :: [(String, Text, UseHaddocks (EnvConfigPathInfo -> Text))]

Documentation

data EnvConfigPathInfo Source #

Type representing information needed to generate an appropriate string for paths of interest to a user which require an EnvConfig.

Instances

Instances details

HasPantryConfig EnvConfigPathInfo Source #
Instance details Defined in Stack.Path Methods pantryConfigL :: Lens' EnvConfigPathInfo PantryConfig #
HasLogFunc EnvConfigPathInfo Source #
Instance details Defined in Stack.Path Methods logFuncL :: Lens' EnvConfigPathInfo LogFunc #
HasProcessContext EnvConfigPathInfo Source #
Instance details Defined in Stack.Path Methods processContextL :: Lens' EnvConfigPathInfo ProcessContext
HasTerm EnvConfigPathInfo Source #
Instance details Defined in Stack.Path Methods useColorL :: Lens' EnvConfigPathInfo Bool # termWidthL :: Lens' EnvConfigPathInfo Int #
HasStylesUpdate EnvConfigPathInfo Source #
Instance details Defined in Stack.Path Methods stylesUpdateL :: Lens' EnvConfigPathInfo StylesUpdate #
HasBuildConfig EnvConfigPathInfo Source #
Instance details Defined in Stack.Path Methods buildConfigL :: Lens' EnvConfigPathInfo BuildConfig Source #
HasConfig EnvConfigPathInfo Source #
Instance details Defined in Stack.Path Methods configL :: Lens' EnvConfigPathInfo Config Source #
HasGHCVariant EnvConfigPathInfo Source #
Instance details Defined in Stack.Path Methods ghcVariantL :: SimpleGetter EnvConfigPathInfo GHCVariant Source #
HasPlatform EnvConfigPathInfo Source #
Instance details Defined in Stack.Path Methods platformL :: Lens' EnvConfigPathInfo Platform Source # platformVariantL :: Lens' EnvConfigPathInfo PlatformVariant Source #
HasRunner EnvConfigPathInfo Source #
Instance details Defined in Stack.Path Methods runnerL :: Lens' EnvConfigPathInfo Runner Source #

data UseHaddocks a Source #

Type representing whether or not building Haddocks is required.

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

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

pathsFromRunner :: (String, Text) Source #

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)] Source #

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))] Source #

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.