spago-0.21.0
Safe HaskellSafe-Inferred
LanguageHaskell2010

Spago.Types

Synopsis

Documentation

newtype PackageName #

Constructors

PackageName 

Fields

Instances

Instances details
FromJSON PackageName # 
Instance details

Defined in Spago.Types

FromJSONKey PackageName # 
Instance details

Defined in Spago.Types

ToJSON PackageName # 
Instance details

Defined in Spago.Types

ToJSONKey PackageName # 
Instance details

Defined in Spago.Types

Data PackageName # 
Instance details

Defined in Spago.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PackageName -> c PackageName #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PackageName #

toConstr :: PackageName -> Constr #

dataTypeOf :: PackageName -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PackageName) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PackageName) #

gmapT :: (forall b. Data b => b -> b) -> PackageName -> PackageName #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PackageName -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PackageName -> r #

gmapQ :: (forall d. Data d => d -> u) -> PackageName -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PackageName -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PackageName -> m PackageName #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageName -> m PackageName #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageName -> m PackageName #

Read PackageName # 
Instance details

Defined in Spago.Types

Show PackageName # 
Instance details

Defined in Spago.Types

FromDhall PackageName # 
Instance details

Defined in Spago.Types

Eq PackageName # 
Instance details

Defined in Spago.Types

Ord PackageName # 
Instance details

Defined in Spago.Types

data Package #

A package-set package. Matches the packages definition in Package.dhall from package-sets

Constructors

Package 

Fields

Instances

Instances details
FromJSON Package # 
Instance details

Defined in Spago.Types

Generic Package # 
Instance details

Defined in Spago.Types

Associated Types

type Rep Package :: Type -> Type #

Methods

from :: Package -> Rep Package x #

to :: Rep Package x -> Package #

Show Package # 
Instance details

Defined in Spago.Types

Eq Package # 
Instance details

Defined in Spago.Types

Methods

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

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

type Rep Package # 
Instance details

Defined in Spago.Types

type Rep Package = D1 ('MetaData "Package" "Spago.Types" "spago-0.21.0-wuq2Fsi0665WDIPyS8qRJ" 'False) (C1 ('MetaCons "Package" 'PrefixI 'True) (S1 ('MetaSel ('Just "dependencies") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Set PackageName)) :*: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PackageLocation)))

data PackageLocation #

Constructors

Remote 

Fields

  • repo :: !Repo

    the remote git repository

  • version :: !Text

    version string (also functions as a git ref)

Local 

Fields

Instances

Instances details
ToJSON PackageLocation #

This instance is to make `spago ls packages --json` work

Instance details

Defined in Spago.Types

Generic PackageLocation # 
Instance details

Defined in Spago.Types

Associated Types

type Rep PackageLocation :: Type -> Type #

Show PackageLocation # 
Instance details

Defined in Spago.Types

Eq PackageLocation # 
Instance details

Defined in Spago.Types

type Rep PackageLocation # 
Instance details

Defined in Spago.Types

type Rep PackageLocation = D1 ('MetaData "PackageLocation" "Spago.Types" "spago-0.21.0-wuq2Fsi0665WDIPyS8qRJ" 'False) (C1 ('MetaCons "Remote" 'PrefixI 'True) (S1 ('MetaSel ('Just "repo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Repo) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "Local" 'PrefixI 'True) (S1 ('MetaSel ('Just "localPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))

data PackageSet #

Instances

Instances details
FromJSON PackageSet # 
Instance details

Defined in Spago.Types

Generic PackageSet # 
Instance details

Defined in Spago.Types

Associated Types

type Rep PackageSet :: Type -> Type #

Show PackageSet # 
Instance details

Defined in Spago.Types

type Rep PackageSet # 
Instance details

Defined in Spago.Types

type Rep PackageSet = D1 ('MetaData "PackageSet" "Spago.Types" "spago-0.21.0-wuq2Fsi0665WDIPyS8qRJ" 'False) (C1 ('MetaCons "PackageSet" 'PrefixI 'True) (S1 ('MetaSel ('Just "packagesDB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map PackageName Package)) :*: S1 ('MetaSel ('Just "packagesMinPursVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SemVer))))

newtype Repo #

We consider a Repo a "box of source to include in the build" This can have different nature:

Constructors

Repo 

Fields

Instances

Instances details
FromJSON Repo # 
Instance details

Defined in Spago.Types

ToJSON Repo # 
Instance details

Defined in Spago.Types

Generic Repo # 
Instance details

Defined in Spago.Types

Associated Types

type Rep Repo :: Type -> Type #

Methods

from :: Repo -> Rep Repo x #

to :: Rep Repo x -> Repo #

Show Repo # 
Instance details

Defined in Spago.Types

Methods

showsPrec :: Int -> Repo -> ShowS #

show :: Repo -> String #

showList :: [Repo] -> ShowS #

FromDhall Repo # 
Instance details

Defined in Spago.Types

Eq Repo # 
Instance details

Defined in Spago.Types

Methods

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

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

type Rep Repo # 
Instance details

Defined in Spago.Types

type Rep Repo = D1 ('MetaData "Repo" "Spago.Types" "spago-0.21.0-wuq2Fsi0665WDIPyS8qRJ" 'True) (C1 ('MetaCons "Repo" 'PrefixI 'True) (S1 ('MetaSel ('Just "unRepo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Force #

Whether to force an action

Constructors

Force 
NoForce 

Instances

Instances details
Eq Force # 
Instance details

Defined in Spago.Types

Methods

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

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

newtype TargetPath #

Constructors

TargetPath 

Fields

newtype SourcePath #

Constructors

SourcePath 

Fields

Instances

Instances details
Show SourcePath # 
Instance details

Defined in Spago.Types

FromDhall SourcePath # 
Instance details

Defined in Spago.Types

Eq SourcePath # 
Instance details

Defined in Spago.Types

Ord SourcePath # 
Instance details

Defined in Spago.Types

newtype PursArg #

Constructors

PursArg 

Fields

Instances

Instances details
Show PursArg # 
Instance details

Defined in Spago.Types

Eq PursArg # 
Instance details

Defined in Spago.Types

Methods

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

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

newtype BackendArg #

Constructors

BackendArg 

Fields

Instances

Instances details
Eq BackendArg # 
Instance details

Defined in Spago.Types

data WithMain #

Constructors

WithMain 
WithoutMain 

data Platform #

Constructors

Browser 
Node 

data Minify #

Constructors

Minify 
NoMinify 

data CacheFlag #

Constructors

SkipCache 
NewCache 

Instances

Instances details
Eq CacheFlag # 
Instance details

Defined in Spago.Types

data NoSearch #

A flag to skip patching the docs using purescript-docs-search.

Constructors

NoSearch 
AddSearch 

Instances

Instances details
Eq NoSearch # 
Instance details

Defined in Spago.Types

data OpenDocs #

Flag to open generated HTML documentation in browser

Constructors

NoOpenDocs 
DoOpenDocs 

Instances

Instances details
Eq OpenDocs # 
Instance details

Defined in Spago.Types

data UsePsa #

Flag to disable the automatic use of $sel:psa:PursCmd

Constructors

UsePsa 
NoPsa 

data PathType #

The output path that can be obtained via ls

data DepsOnly #

Only build deps and ignore project paths

Constructors

DepsOnly 
AllSources 

Instances

Instances details
Eq DepsOnly # 
Instance details

Defined in Spago.Types

data Watch #

Constructors

Watch 
BuildOnce 

data NoBuild #

Flag to go through with the build step or skip it, in the case of bundleApp and bundleModule.

Constructors

NoBuild 
DoBuild 

data NoInstall #

Flag to skip the automatic installation of libraries on build

Constructors

NoInstall 
DoInstall 

Instances

Instances details
Eq NoInstall # 
Instance details

Defined in Spago.Types

data ClearScreen #

Constructors

DoClear 
NoClear 

Instances

Instances details
Eq ClearScreen # 
Instance details

Defined in Spago.Types

data AllowIgnored #

Flag to allow files ignored via `.gitignore` to trigger a rebuild

data ScriptBuildOptions #

Instances

Instances details
Generic ScriptBuildOptions # 
Instance details

Defined in Spago.Types

Associated Types

type Rep ScriptBuildOptions :: Type -> Type #

Show ScriptBuildOptions # 
Instance details

Defined in Spago.Types

Eq ScriptBuildOptions # 
Instance details

Defined in Spago.Types

type Rep ScriptBuildOptions # 
Instance details

Defined in Spago.Types

type Rep ScriptBuildOptions = D1 ('MetaData "ScriptBuildOptions" "Spago.Types" "spago-0.21.0-wuq2Fsi0665WDIPyS8qRJ" 'False) (C1 ('MetaCons "ScriptBuildOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pursArgs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PursArg]) :*: S1 ('MetaSel ('Just "beforeCommands") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])) :*: (S1 ('MetaSel ('Just "thenCommands") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "elseCommands") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]))))

data Config #

Spago configuration file type

Instances

Instances details
Generic Config # 
Instance details

Defined in Spago.Types

Associated Types

type Rep Config :: Type -> Type #

Methods

from :: Config -> Rep Config x #

to :: Rep Config x -> Config #

Show Config # 
Instance details

Defined in Spago.Types

type Rep Config # 
Instance details

Defined in Spago.Types

type Rep Config = D1 ('MetaData "Config" "Spago.Types" "spago-0.21.0-wuq2Fsi0665WDIPyS8qRJ" 'False) (C1 ('MetaCons "Config" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "dependencies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set PackageName)) :*: S1 ('MetaSel ('Just "packageSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageSet))) :*: ((S1 ('MetaSel ('Just "alternateBackend") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "configSourcePaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set SourcePath))) :*: (S1 ('MetaSel ('Just "publishConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Either (ReadError Void) PublishConfig)) :*: S1 ('MetaSel ('Just "migrateConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Either (ReadError Void) MigrateConfig))))))

data MigrateConfig #

Extra fields only needed when migrating to the new Spago

Instances

Instances details
Generic MigrateConfig # 
Instance details

Defined in Spago.Types

Associated Types

type Rep MigrateConfig :: Type -> Type #

Show MigrateConfig # 
Instance details

Defined in Spago.Types

type Rep MigrateConfig # 
Instance details

Defined in Spago.Types

type Rep MigrateConfig = D1 ('MetaData "MigrateConfig" "Spago.Types" "spago-0.21.0-wuq2Fsi0665WDIPyS8qRJ" 'False) (C1 ('MetaCons "MigrateConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "migrateLicense") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "migrateVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data PublishConfig #

The extra fields that are only needed for publishing libraries.

Instances

Instances details
Generic PublishConfig # 
Instance details

Defined in Spago.Types

Associated Types

type Rep PublishConfig :: Type -> Type #

Show PublishConfig # 
Instance details

Defined in Spago.Types

type Rep PublishConfig # 
Instance details

Defined in Spago.Types

type Rep PublishConfig = D1 ('MetaData "PublishConfig" "Spago.Types" "spago-0.21.0-wuq2Fsi0665WDIPyS8qRJ" 'False) (C1 ('MetaCons "PublishConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "publishLicense") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "publishRepository") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data PursCmd #

Constructors

PursCmd 

Instances

Instances details
Generic PursCmd # 
Instance details

Defined in Spago.Types

Associated Types

type Rep PursCmd :: Type -> Type #

Methods

from :: PursCmd -> Rep PursCmd x #

to :: Rep PursCmd x -> PursCmd #

type Rep PursCmd # 
Instance details

Defined in Spago.Types

type Rep PursCmd = D1 ('MetaData "PursCmd" "Spago.Types" "spago-0.21.0-wuq2Fsi0665WDIPyS8qRJ" 'False) (C1 ('MetaCons "PursCmd" 'PrefixI 'True) (S1 ('MetaSel ('Just "purs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "psa") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "compilerVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SemVer))))

newtype Jobs #

Constructors

Jobs Int 

newtype ConfigPath #

Constructors

ConfigPath Text 

newtype GitCmd #

Constructors

GitCmd Text 

newtype BowerCmd #

Constructors

BowerCmd Text 

newtype ModuleGraph #

Instances

Instances details
FromJSON ModuleGraph # 
Instance details

Defined in Spago.Types

data ModuleGraphNode #

Instances

Instances details
FromJSON ModuleGraphNode # 
Instance details

Defined in Spago.Types

Generic ModuleGraphNode # 
Instance details

Defined in Spago.Types

Associated Types

type Rep ModuleGraphNode :: Type -> Type #

type Rep ModuleGraphNode # 
Instance details

Defined in Spago.Types

type Rep ModuleGraphNode = D1 ('MetaData "ModuleGraphNode" "Spago.Types" "spago-0.21.0-wuq2Fsi0665WDIPyS8qRJ" 'False) (C1 ('MetaCons "ModuleGraphNode" 'PrefixI 'True) (S1 ('MetaSel ('Just "graphNodePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "graphNodeDepends") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ModuleName])))