Safe Haskell	Safe-Inferred
Language	GHC2021

Stack.Path

Description

Types and functions related to Stack's path command.

Synopsis

data PathInfo
path :: [Text] -> RIO Runner ()
paths :: [(String, Text, UseHaddocks (PathInfo -> Text))]

Documentation

data PathInfo Source #

Type representing information passed to all the path printers.

Instances

Instances details

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

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

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

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

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.