Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.Configuration

Contents

Type Alias
Data Types

Synopsis

type ReplacementActionName = Text
type ReplacementSearchString = Text
type TemplateName = Text
data TextReplacementAction = TextReplacementAction {
}
replacementActionName :: Lens' TextReplacementAction ReplacementActionName
replacementActionSearchString :: Lens' TextReplacementAction ReplacementSearchString
replacementText :: Lens' TextReplacementAction Text
data AuthorInfo
- = SingularAuthor Text
- | MultipleAuthors (NonEmpty Text)
data TemplateConfiguration = TemplateConfiguration {
- _authorInfo :: Maybe AuthorInfo
- _templateDirectoryPath :: Path Abs Dir
- _relativeOutputPath :: Path Rel Dir
- _fileContentReplacementMap :: Map (Path Rel File) (Seq Text)
}
authorInfo :: Lens' TemplateConfiguration (Maybe AuthorInfo)
templateDirectoryPath :: Lens' TemplateConfiguration (Path Abs Dir)
relativeOutputPath :: Lens' TemplateConfiguration (Path Rel Dir)
fileContentReplacementMap :: Lens' TemplateConfiguration (Map (Path Rel File) (Seq Text))
data Configuration = Configuration {
- _contentReplacementActions :: Seq TextReplacementAction
- _templateConfigurations :: Map TemplateName TemplateConfiguration
}
contentReplacementActions :: Lens' Configuration (Seq TextReplacementAction)
templateConfigurations :: Lens' Configuration (Map TemplateName TemplateConfiguration)
data ConfigurationPath
- = NewConfiguration (Path Abs File)
- | ExistingConfiguration (Path Abs File)
configurationPath :: ConfigurationPath -> Path Abs File
isNewConfiguration :: ConfigurationPath -> Bool

Type Alias

type ReplacementActionName = Text #

type ReplacementSearchString = Text #

type TemplateName = Text #

Data Types

Text Replacement Action

data TextReplacementAction #

A text replacement action to perform on the contents of a file, as read from a configuration file.

Constructors

TextReplacementAction

Fields

_replacementActionName :: ReplacementActionName
The unique name for the replacement action
_replacementActionSearchString :: ReplacementSearchString
The String to find and replace with a file

_replacementText :: Text

The value to substitute in place of the found search string. There are some special values that can be used based on the current directory:

_replacementText Value	Substituted Value
%%THECOURSE%%	The course code found in the current directory.
%%THEASSESSNO%%	The numeric value of the current assessment folder.
%%THEAUTHOR%%	The author as specified in the used template. If no author is given, no replacement will be made.

Any other values will be substituted as is.

Instances

Instances details

FromJSON TextReplacementAction #
Instance details Defined in Data.Configuration Methods parseJSON :: Value -> Parser TextReplacementAction # parseJSONList :: Value -> Parser [TextReplacementAction] # omittedField :: Maybe TextReplacementAction #
ToJSON TextReplacementAction #
Instance details Defined in Data.Configuration Methods toJSON :: TextReplacementAction -> Value # toEncoding :: TextReplacementAction -> Encoding # toJSONList :: [TextReplacementAction] -> Value # toEncodingList :: [TextReplacementAction] -> Encoding # omitField :: TextReplacementAction -> Bool #
Generic TextReplacementAction #
Instance details Defined in Data.Configuration Associated Types type Rep TextReplacementAction :: Type -> Type # Methods from :: TextReplacementAction -> Rep TextReplacementAction x # to :: Rep TextReplacementAction x -> TextReplacementAction #
Show TextReplacementAction #
Instance details Defined in Data.Configuration Methods showsPrec :: Int -> TextReplacementAction -> ShowS # show :: TextReplacementAction -> String # showList :: [TextReplacementAction] -> ShowS #
Eq TextReplacementAction #
Instance details Defined in Data.Configuration Methods (==) :: TextReplacementAction -> TextReplacementAction -> Bool # (/=) :: TextReplacementAction -> TextReplacementAction -> Bool #
type Rep TextReplacementAction #
Instance details Defined in Data.Configuration type Rep TextReplacementAction = D1 ('MetaData "TextReplacementAction" "Data.Configuration" "UniHs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "TextReplacementAction" 'PrefixI 'True) (S1 ('MetaSel ('Just "_replacementActionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ReplacementActionName) :: (S1 ('MetaSel ('Just "_replacementActionSearchString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ReplacementSearchString) :: S1 ('MetaSel ('Just "_replacementText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

replacementActionName :: Lens' TextReplacementAction ReplacementActionName #

replacementActionSearchString :: Lens' TextReplacementAction ReplacementSearchString #

replacementText :: Lens' TextReplacementAction Text #

Template Configuration

data AuthorInfo #

Information about authors for TemplateConfigurations.

Constructors

SingularAuthor Text	A single author
MultipleAuthors (NonEmpty Text)	A non-empty collection of authors

Instances

Instances details

FromJSON AuthorInfo #
Instance details Defined in Data.Configuration Methods parseJSON :: Value -> Parser AuthorInfo # parseJSONList :: Value -> Parser [AuthorInfo] # omittedField :: Maybe AuthorInfo #
ToJSON AuthorInfo #
Instance details Defined in Data.Configuration Methods toJSON :: AuthorInfo -> Value # toEncoding :: AuthorInfo -> Encoding # toJSONList :: [AuthorInfo] -> Value # toEncodingList :: [AuthorInfo] -> Encoding # omitField :: AuthorInfo -> Bool #
Generic AuthorInfo #
Instance details Defined in Data.Configuration Associated Types type Rep AuthorInfo :: Type -> Type # Methods from :: AuthorInfo -> Rep AuthorInfo x # to :: Rep AuthorInfo x -> AuthorInfo #
Show AuthorInfo #
Instance details Defined in Data.Configuration Methods showsPrec :: Int -> AuthorInfo -> ShowS # show :: AuthorInfo -> String # showList :: [AuthorInfo] -> ShowS #
Eq AuthorInfo #
Instance details Defined in Data.Configuration Methods (==) :: AuthorInfo -> AuthorInfo -> Bool # (/=) :: AuthorInfo -> AuthorInfo -> Bool #
type Rep AuthorInfo #
Instance details Defined in Data.Configuration type Rep AuthorInfo = D1 ('MetaData "AuthorInfo" "Data.Configuration" "UniHs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "SingularAuthor" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "MultipleAuthors" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty Text))))

data TemplateConfiguration #

A template to specify a directory of files to copy to a new location.

Constructors

TemplateConfiguration

Fields

_authorInfo :: Maybe AuthorInfo
The author of the current template
_templateDirectoryPath :: Path Abs Dir
The absolute path to the directory of files consisting of the template
_relativeOutputPath :: Path Rel Dir
The path relative to the assessment root (or current directory when using --here) where the contents of the template folder will be copied into. An empty path will copy directly into the root directory, without a new folder.
_fileContentReplacementMap :: Map (Path Rel File) (Seq Text)
A mapping of files relative to the template directory with TextReplacementActions to perform. Keys are the relative file paths and values are `Seq Text` of names to TextReplacementActions.

Instances

Instances details

FromJSON TemplateConfiguration #
Instance details Defined in Data.Configuration Methods parseJSON :: Value -> Parser TemplateConfiguration # parseJSONList :: Value -> Parser [TemplateConfiguration] # omittedField :: Maybe TemplateConfiguration #
ToJSON TemplateConfiguration #
Instance details Defined in Data.Configuration Methods toJSON :: TemplateConfiguration -> Value # toEncoding :: TemplateConfiguration -> Encoding # toJSONList :: [TemplateConfiguration] -> Value # toEncodingList :: [TemplateConfiguration] -> Encoding # omitField :: TemplateConfiguration -> Bool #
Generic TemplateConfiguration #
Instance details Defined in Data.Configuration Associated Types type Rep TemplateConfiguration :: Type -> Type # Methods from :: TemplateConfiguration -> Rep TemplateConfiguration x # to :: Rep TemplateConfiguration x -> TemplateConfiguration #
Show TemplateConfiguration #
Instance details Defined in Data.Configuration Methods showsPrec :: Int -> TemplateConfiguration -> ShowS # show :: TemplateConfiguration -> String # showList :: [TemplateConfiguration] -> ShowS #
Eq TemplateConfiguration #
Instance details Defined in Data.Configuration Methods (==) :: TemplateConfiguration -> TemplateConfiguration -> Bool # (/=) :: TemplateConfiguration -> TemplateConfiguration -> Bool #
type Rep TemplateConfiguration #
Instance details Defined in Data.Configuration type Rep TemplateConfiguration = D1 ('MetaData "TemplateConfiguration" "Data.Configuration" "UniHs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "TemplateConfiguration" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_authorInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AuthorInfo)) :: S1 ('MetaSel ('Just "_templateDirectoryPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path Abs Dir))) :: (S1 ('MetaSel ('Just "_relativeOutputPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path Rel Dir)) :*: S1 ('MetaSel ('Just "_fileContentReplacementMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map (Path Rel File) (Seq Text))))))

authorInfo :: Lens' TemplateConfiguration (Maybe AuthorInfo) #

templateDirectoryPath :: Lens' TemplateConfiguration (Path Abs Dir) #

relativeOutputPath :: Lens' TemplateConfiguration (Path Rel Dir) #

fileContentReplacementMap :: Lens' TemplateConfiguration (Map (Path Rel File) (Seq Text)) #

Configuration

data Configuration #

A template configuration used to copy a directory when creating a new assessment.

Constructors

Configuration
Fields _contentReplacementActions :: Seq TextReplacementAction A collection of replacement actions to perform on specified file contents _templateConfigurations :: Map TemplateName TemplateConfiguration A mapping of template configuration names to configurations

Instances

Instances details

FromJSON Configuration #
Instance details Defined in Data.Configuration Methods parseJSON :: Value -> Parser Configuration # parseJSONList :: Value -> Parser [Configuration] # omittedField :: Maybe Configuration #
ToJSON Configuration #
Instance details Defined in Data.Configuration Methods toJSON :: Configuration -> Value # toEncoding :: Configuration -> Encoding # toJSONList :: [Configuration] -> Value # toEncodingList :: [Configuration] -> Encoding # omitField :: Configuration -> Bool #
Generic Configuration #
Instance details Defined in Data.Configuration Associated Types type Rep Configuration :: Type -> Type # Methods from :: Configuration -> Rep Configuration x # to :: Rep Configuration x -> Configuration #
Show Configuration #
Instance details Defined in Data.Configuration Methods showsPrec :: Int -> Configuration -> ShowS # show :: Configuration -> String # showList :: [Configuration] -> ShowS #
Eq Configuration #
Instance details Defined in Data.Configuration Methods (==) :: Configuration -> Configuration -> Bool # (/=) :: Configuration -> Configuration -> Bool #
type Rep Configuration #
Instance details Defined in Data.Configuration type Rep Configuration = D1 ('MetaData "Configuration" "Data.Configuration" "UniHs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "Configuration" 'PrefixI 'True) (S1 ('MetaSel ('Just "_contentReplacementActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq TextReplacementAction)) :*: S1 ('MetaSel ('Just "_templateConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map TemplateName TemplateConfiguration))))

contentReplacementActions :: Lens' Configuration (Seq TextReplacementAction) #

templateConfigurations :: Lens' Configuration (Map TemplateName TemplateConfiguration) #

Other datatypes

data ConfigurationPath #

Constructors

NewConfiguration (Path Abs File)
ExistingConfiguration (Path Abs File)

Instances

Instances details

FromJSON ConfigurationPath #
Instance details Defined in Data.Configuration Methods parseJSON :: Value -> Parser ConfigurationPath # parseJSONList :: Value -> Parser [ConfigurationPath] # omittedField :: Maybe ConfigurationPath #
ToJSON ConfigurationPath #
Instance details Defined in Data.Configuration Methods toJSON :: ConfigurationPath -> Value # toEncoding :: ConfigurationPath -> Encoding # toJSONList :: [ConfigurationPath] -> Value # toEncodingList :: [ConfigurationPath] -> Encoding # omitField :: ConfigurationPath -> Bool #
Generic ConfigurationPath #
Instance details Defined in Data.Configuration Associated Types type Rep ConfigurationPath :: Type -> Type # Methods from :: ConfigurationPath -> Rep ConfigurationPath x # to :: Rep ConfigurationPath x -> ConfigurationPath #
Show ConfigurationPath #
Instance details Defined in Data.Configuration Methods showsPrec :: Int -> ConfigurationPath -> ShowS # show :: ConfigurationPath -> String # showList :: [ConfigurationPath] -> ShowS #
Eq ConfigurationPath #
Instance details Defined in Data.Configuration Methods (==) :: ConfigurationPath -> ConfigurationPath -> Bool # (/=) :: ConfigurationPath -> ConfigurationPath -> Bool #
type Rep ConfigurationPath #
Instance details Defined in Data.Configuration type Rep ConfigurationPath = D1 ('MetaData "ConfigurationPath" "Data.Configuration" "UniHs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "NewConfiguration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path Abs File))) :+: C1 ('MetaCons "ExistingConfiguration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path Abs File))))

configurationPath :: ConfigurationPath -> Path Abs File #

isNewConfiguration :: ConfigurationPath -> Bool #