stack-3.1.1: The Haskell Tool Stack

Safe Haskell	None
Language	GHC2021

Stack.Types.Nix

Description

Nix types.

Synopsis

data NixOpts = NixOpts {
- enable :: !Bool
- pureShell :: !Bool
- packages :: ![Text]
- initFile :: !(Maybe FilePath)
- shellOptions :: ![Text]
- addGCRoots :: !Bool
}
data NixOptsMonoid = NixOptsMonoid {
- enable :: !(First Bool)
- pureShell :: !(First Bool)
- packages :: !(First [Text])
- initFile :: !(First FilePath)
- shellOptions :: !(First [Text])
- path :: !(First [Text])
- addGCRoots :: !FirstFalse
}
nixAddGCRootsArgName :: Text
nixEnableArgName :: Text
nixInitFileArgName :: Text
nixPackagesArgName :: Text
nixPathArgName :: Text
nixPureShellArgName :: Text
nixShellOptsArgName :: Text

Documentation

data NixOpts Source #

Nix configuration. Parameterize by snapshot type to avoid cyclic dependency.

Constructors

Fields

enable :: !Bool
pureShell :: !Bool
packages :: ![Text]
The system packages to be installed in the environment before it runs
initFile :: !(Maybe FilePath)
The path of a file containing preconfiguration of the environment (e.g shell.nix)
shellOptions :: ![Text]
Options to be given to the nix-shell command line
addGCRoots :: !Bool
Should we register gc roots so running nix-collect-garbage doesn't remove nix dependencies

Instances

Instances details

Show NixOpts Source #
Instance details Defined in Stack.Types.Nix Methods showsPrec :: Int -> NixOpts -> ShowS # show :: NixOpts -> String # showList :: [NixOpts] -> ShowS #

data NixOptsMonoid Source #

An uninterpreted representation of nix options. Configurations may be "cascaded" using mappend (left-biased).

Constructors

Fields

enable :: !(First Bool)
Is using nix-shell enabled?
pureShell :: !(First Bool)
Should the nix-shell be pure
packages :: !(First [Text])
System packages to use (given to nix-shell)
initFile :: !(First FilePath)
The path of a file containing preconfiguration of the environment (e.g shell.nix)
shellOptions :: !(First [Text])
Options to be given to the nix-shell command line
path :: !(First [Text])
Override parts of NIX_PATH (notably nixpkgs)
addGCRoots :: !FirstFalse
Should we register gc roots so running nix-collect-garbage doesn't remove nix dependencies

Instances

Instances details

Monoid NixOptsMonoid Source #

Left-biased combine Nix options

Instance details

Defined in Stack.Types.Nix

Methods

mempty :: NixOptsMonoid #

mappend :: NixOptsMonoid -> NixOptsMonoid -> NixOptsMonoid #

mconcat :: [NixOptsMonoid] -> NixOptsMonoid #

Semigroup NixOptsMonoid Source #

Left-biased combine Nix options

Instance details

Defined in Stack.Types.Nix

Methods

(<>) :: NixOptsMonoid -> NixOptsMonoid -> NixOptsMonoid #

sconcat :: NonEmpty NixOptsMonoid -> NixOptsMonoid #

stimes :: Integral b => b -> NixOptsMonoid -> NixOptsMonoid #

Generic NixOptsMonoid Source #

Instance details

Defined in Stack.Types.Nix

Associated Types

type Rep NixOptsMonoid

Instance details

Defined in Stack.Types.Nix

type Rep NixOptsMonoid = D1 ('MetaData "NixOptsMonoid" "Stack.Types.Nix" "stack-3.1.1-AIQL095WJ5NLZdAE5tBS1a" 'False) (C1 ('MetaCons "NixOptsMonoid" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enable") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First Bool)) :*: (S1 ('MetaSel ('Just "pureShell") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First Bool)) :*: S1 ('MetaSel ('Just "packages") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First [Text])))) :*: ((S1 ('MetaSel ('Just "initFile") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First FilePath)) :*: S1 ('MetaSel ('Just "shellOptions") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First [Text]))) :*: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First [Text])) :*: S1 ('MetaSel ('Just "addGCRoots") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FirstFalse)))))

Methods

from :: NixOptsMonoid -> Rep NixOptsMonoid x #

to :: Rep NixOptsMonoid x -> NixOptsMonoid #

Show NixOptsMonoid Source #

Instance details

Defined in Stack.Types.Nix

Methods

showsPrec :: Int -> NixOptsMonoid -> ShowS #

show :: NixOptsMonoid -> String #

showList :: [NixOptsMonoid] -> ShowS #

Eq NixOptsMonoid Source #

Instance details

Defined in Stack.Types.Nix

Methods

(==) :: NixOptsMonoid -> NixOptsMonoid -> Bool #

(/=) :: NixOptsMonoid -> NixOptsMonoid -> Bool #

FromJSON (WithJSONWarnings NixOptsMonoid) Source #

Decode uninterpreted nix options from JSON/YAML.

Instance details

Defined in Stack.Types.Nix

Methods

parseJSON :: Value -> Parser (WithJSONWarnings NixOptsMonoid) #

parseJSONList :: Value -> Parser [WithJSONWarnings NixOptsMonoid] #

omittedField :: Maybe (WithJSONWarnings NixOptsMonoid) #

type Rep NixOptsMonoid Source #

Instance details

Defined in Stack.Types.Nix

type Rep NixOptsMonoid = D1 ('MetaData "NixOptsMonoid" "Stack.Types.Nix" "stack-3.1.1-AIQL095WJ5NLZdAE5tBS1a" 'False) (C1 ('MetaCons "NixOptsMonoid" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enable") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First Bool)) :*: (S1 ('MetaSel ('Just "pureShell") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First Bool)) :*: S1 ('MetaSel ('Just "packages") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First [Text])))) :*: ((S1 ('MetaSel ('Just "initFile") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First FilePath)) :*: S1 ('MetaSel ('Just "shellOptions") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First [Text]))) :*: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (First [Text])) :*: S1 ('MetaSel ('Just "addGCRoots") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FirstFalse)))))

nixAddGCRootsArgName :: Text Source #

Add GC roots arg name

nixEnableArgName :: Text Source #

Nix enable argument name.

nixInitFileArgName :: Text Source #

shell.nix file path argument name.

nixPackagesArgName :: Text Source #

Nix packages (build inputs) argument name.

nixPathArgName :: Text Source #

NIX_PATH override argument name

nixPureShellArgName :: Text Source #

Nix run in pure shell argument name.

nixShellOptsArgName :: Text Source #

Extra options for the nix-shell command argument name.