Safe Haskell | None |
---|---|
Language | Haskell2010 |
Spago.Types
Synopsis
- newtype PackageName = PackageName {
- packageName :: Text
- data Package = Package {
- dependencies :: !(Set PackageName)
- location :: !PackageLocation
- data PackageLocation
- data PackageSet = PackageSet {}
- newtype Repo = Repo {}
- data Force
- data IncludeTransitive
- newtype ModuleName = ModuleName {
- unModuleName :: Text
- newtype TargetPath = TargetPath {
- unTargetPath :: Text
- newtype SourcePath = SourcePath {
- unSourcePath :: Text
- newtype PursArg = PursArg {}
- newtype BackendArg = BackendArg {
- unBackendArg :: Text
- data WithMain
- data WithSrcMap
- data Platform
- data Minify
- data CacheFlag
- data CheckModulesUnique
- data JsonFlag
- data NoSearch
- data OpenDocs
- data UsePsa
- data PathType
- data DepsOnly
- data Watch
- data NoBuild
- data NoInstall
- data ClearScreen
- data AllowIgnored
- data ShowVersion
- data BuildOptions = BuildOptions {
- shouldWatch :: Watch
- shouldClear :: ClearScreen
- allowIgnored :: AllowIgnored
- sourcePaths :: [SourcePath]
- withSourceMap :: WithSrcMap
- noInstall :: NoInstall
- pursArgs :: [PursArg]
- depsOnly :: DepsOnly
- beforeCommands :: [Text]
- thenCommands :: [Text]
- elseCommands :: [Text]
- defaultBuildOptions :: BuildOptions
- data BundleOptions = BundleOptions {}
- fromScriptOptions :: BuildOptions -> ScriptBuildOptions -> BuildOptions
- data ScriptBuildOptions = ScriptBuildOptions {
- pursArgs :: [PursArg]
- beforeCommands :: [Text]
- thenCommands :: [Text]
- elseCommands :: [Text]
- data Config = Config {}
- data MigrateConfig = MigrateConfig {}
- data PublishConfig = PublishConfig {}
- data PursCmd = PursCmd {}
- newtype Jobs = Jobs Int
- newtype ConfigPath = ConfigPath Text
- newtype GitCmd = GitCmd Text
- newtype BowerCmd = BowerCmd Text
- data GlobalCache = GlobalCache !FilePath !(Maybe CacheFlag)
- newtype ModuleGraph = ModuleGraph {}
- data ModuleGraphNode = ModuleGraphNode {}
- type Graph = Maybe ModuleGraph
Documentation
newtype PackageName #
Constructors
PackageName | |
Fields
|
Instances
A package-set package. Matches the packages definition in Package.dhall from package-sets
Constructors
Package | |
Fields
|
Instances
FromJSON Package # | |||||
Defined in Spago.Types | |||||
Generic Package # | |||||
Defined in Spago.Types Associated Types
| |||||
Show Package # | |||||
Eq Package # | |||||
type Rep Package # | |||||
Defined in Spago.Types type Rep Package = D1 ('MetaData "Package" "Spago.Types" "spago-0.21.0-7fGZ7CPhD6UKUhYlrl5wZv" '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 #
Instances
data PackageSet #
Constructors
PackageSet | |
Fields |
Instances
FromJSON PackageSet # | |||||
Defined in Spago.Types | |||||
Generic PackageSet # | |||||
Defined in Spago.Types Associated Types
| |||||
Show PackageSet # | |||||
Defined in Spago.Types Methods showsPrec :: Int -> PackageSet -> ShowS # show :: PackageSet -> String # showList :: [PackageSet] -> ShowS # | |||||
type Rep PackageSet # | |||||
Defined in Spago.Types type Rep PackageSet = D1 ('MetaData "PackageSet" "Spago.Types" "spago-0.21.0-7fGZ7CPhD6UKUhYlrl5wZv" '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)))) |
We consider a Repo a "box of source to include in the build" This can have different nature:
Instances
Whether to force an action
data IncludeTransitive #
Constructors
IncludeTransitive | |
NoIncludeTransitive |
newtype ModuleName #
Constructors
ModuleName | |
Fields
|
Instances
FromJSON ModuleName # | |
Defined in Spago.Types | |
FromJSONKey ModuleName # | |
Defined in Spago.Types | |
Eq ModuleName # | |
Defined in Spago.Types | |
Ord ModuleName # | |
Defined in Spago.Types Methods compare :: ModuleName -> ModuleName -> Ordering # (<) :: ModuleName -> ModuleName -> Bool # (<=) :: ModuleName -> ModuleName -> Bool # (>) :: ModuleName -> ModuleName -> Bool # (>=) :: ModuleName -> ModuleName -> Bool # max :: ModuleName -> ModuleName -> ModuleName # min :: ModuleName -> ModuleName -> ModuleName # |
newtype TargetPath #
Constructors
TargetPath | |
Fields
|
newtype SourcePath #
Constructors
SourcePath | |
Fields
|
Instances
FromDhall SourcePath # | |
Defined in Spago.Types Methods | |
Show SourcePath # | |
Defined in Spago.Types Methods showsPrec :: Int -> SourcePath -> ShowS # show :: SourcePath -> String # showList :: [SourcePath] -> ShowS # | |
Eq SourcePath # | |
Defined in Spago.Types | |
Ord SourcePath # | |
Defined in Spago.Types Methods compare :: SourcePath -> SourcePath -> Ordering # (<) :: SourcePath -> SourcePath -> Bool # (<=) :: SourcePath -> SourcePath -> Bool # (>) :: SourcePath -> SourcePath -> Bool # (>=) :: SourcePath -> SourcePath -> Bool # max :: SourcePath -> SourcePath -> SourcePath # min :: SourcePath -> SourcePath -> SourcePath # |
newtype BackendArg #
Constructors
BackendArg | |
Fields
|
Instances
Eq BackendArg # | |
Defined in Spago.Types |
Constructors
WithMain | |
WithoutMain |
data WithSrcMap #
Constructors
WithSrcMap | |
WithoutSrcMap |
data CheckModulesUnique #
Constructors
DoCheckModulesUnique | |
NoCheckModulesUnique |
Constructors
JsonOutputNo | |
JsonOutputYes |
A flag to skip patching the docs using purescript-docs-search
.
Flag to open generated HTML documentation in browser
Constructors
NoOpenDocs | |
DoOpenDocs |
Only build deps and ignore project paths
Constructors
DepsOnly | |
AllSources |
Flag to go through with the build step
or skip it, in the case of bundleApp
and bundleModule
.
Flag to skip the automatic installation of libraries on build
data ClearScreen #
Instances
Eq ClearScreen # | |
Defined in Spago.Types |
data AllowIgnored #
Flag to allow files ignored via `.gitignore` to trigger a rebuild
Constructors
DoAllowIgnored | |
NoAllowIgnored |
data ShowVersion #
Constructors
DoShowVersion | |
NoShowVersion |
data BuildOptions #
Constructors
BuildOptions | |
Fields
|
data BundleOptions #
Constructors
BundleOptions | |
Fields |
data ScriptBuildOptions #
Constructors
ScriptBuildOptions | |
Fields
|
Instances
Generic ScriptBuildOptions # | |||||
Defined in Spago.Types Associated Types
Methods from :: ScriptBuildOptions -> Rep ScriptBuildOptions x # to :: Rep ScriptBuildOptions x -> ScriptBuildOptions # | |||||
Show ScriptBuildOptions # | |||||
Defined in Spago.Types Methods showsPrec :: Int -> ScriptBuildOptions -> ShowS # show :: ScriptBuildOptions -> String # showList :: [ScriptBuildOptions] -> ShowS # | |||||
Eq ScriptBuildOptions # | |||||
Defined in Spago.Types Methods (==) :: ScriptBuildOptions -> ScriptBuildOptions -> Bool # (/=) :: ScriptBuildOptions -> ScriptBuildOptions -> Bool # | |||||
type Rep ScriptBuildOptions # | |||||
Defined in Spago.Types type Rep ScriptBuildOptions = D1 ('MetaData "ScriptBuildOptions" "Spago.Types" "spago-0.21.0-7fGZ7CPhD6UKUhYlrl5wZv" '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])))) |
Spago configuration file type
Constructors
Config | |
Fields |
Instances
Generic Config # | |||||
Defined in Spago.Types Associated Types
| |||||
Show Config # | |||||
type Rep Config # | |||||
Defined in Spago.Types type Rep Config = D1 ('MetaData "Config" "Spago.Types" "spago-0.21.0-7fGZ7CPhD6UKUhYlrl5wZv" '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
Constructors
MigrateConfig | |
Fields
|
Instances
Generic MigrateConfig # | |||||
Defined in Spago.Types Associated Types
| |||||
Show MigrateConfig # | |||||
Defined in Spago.Types Methods showsPrec :: Int -> MigrateConfig -> ShowS # show :: MigrateConfig -> String # showList :: [MigrateConfig] -> ShowS # | |||||
type Rep MigrateConfig # | |||||
Defined in Spago.Types type Rep MigrateConfig = D1 ('MetaData "MigrateConfig" "Spago.Types" "spago-0.21.0-7fGZ7CPhD6UKUhYlrl5wZv" '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.
Constructors
PublishConfig | |
Fields |
Instances
Generic PublishConfig # | |||||
Defined in Spago.Types Associated Types
| |||||
Show PublishConfig # | |||||
Defined in Spago.Types Methods showsPrec :: Int -> PublishConfig -> ShowS # show :: PublishConfig -> String # showList :: [PublishConfig] -> ShowS # | |||||
type Rep PublishConfig # | |||||
Defined in Spago.Types type Rep PublishConfig = D1 ('MetaData "PublishConfig" "Spago.Types" "spago-0.21.0-7fGZ7CPhD6UKUhYlrl5wZv" 'False) (C1 ('MetaCons "PublishConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "publishLicense") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "publishRepository") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) |
Instances
Generic PursCmd # | |||||
Defined in Spago.Types Associated Types
| |||||
type Rep PursCmd # | |||||
Defined in Spago.Types type Rep PursCmd = D1 ('MetaData "PursCmd" "Spago.Types" "spago-0.21.0-7fGZ7CPhD6UKUhYlrl5wZv" '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 ConfigPath #
Constructors
ConfigPath Text |
data GlobalCache #
Constructors
GlobalCache !FilePath !(Maybe CacheFlag) |
newtype ModuleGraph #
Constructors
ModuleGraph | |
Fields |
Instances
FromJSON ModuleGraph # | |
Defined in Spago.Types |
data ModuleGraphNode #
Constructors
ModuleGraphNode | |
Fields
|
Instances
FromJSON ModuleGraphNode # | |||||
Defined in Spago.Types Methods parseJSON :: Value -> Parser ModuleGraphNode # parseJSONList :: Value -> Parser [ModuleGraphNode] # | |||||
Generic ModuleGraphNode # | |||||
Defined in Spago.Types Associated Types
Methods from :: ModuleGraphNode -> Rep ModuleGraphNode x # to :: Rep ModuleGraphNode x -> ModuleGraphNode # | |||||
type Rep ModuleGraphNode # | |||||
Defined in Spago.Types type Rep ModuleGraphNode = D1 ('MetaData "ModuleGraphNode" "Spago.Types" "spago-0.21.0-7fGZ7CPhD6UKUhYlrl5wZv" 'False) (C1 ('MetaCons "ModuleGraphNode" 'PrefixI 'True) (S1 ('MetaSel ('Just "graphNodePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "graphNodeDepends") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ModuleName]))) |
type Graph = Maybe ModuleGraph #