PFile.Env

Types and functions for managing PFile's environment.

Documentation

resolve :: MonadIO m => Options -> m Env

Deduce PFile's dataHomeDirPath in the following order:

• Lookup in "$PFILE_DATA_HOME" environment variable if exists.
• Use ".pfile" directory from the current working directory if exists.
• Use "$XDG_DATA_HOME/pfile" directory.

Based on the dataHomeDirPath other fields of Env are resolved.

Since: 0.1.0.0

description :: Env -> Text

Describe an Env.

Since: 0.1.0.0

newtype Options

Env options.

Since: 0.1.0.0

Constructors

Options

Fields

• verbose :: Bool

  Whether logging should be enabled.

data Env

PFile's environment that effects its behavior.

Since: 0.1.0.0

Constructors

Env

Fields

• dataHomeDirPath :: !Absolute

  PFile's home directory.

• profilesHomeDirPath :: !Absolute

  Profiles home directory.

• currentLinkPath :: !Absolute

  Path to a current profile's link.

• print :: !(Text -> IO ())

  Function used by logging functions.

• options :: !Options

  Options that were used to create the Env.