Stack.Types.TemplateName

Template name handling.

Documentation

data TemplateName

A template name.

Instances

Eq TemplateName

Defined in Stack.Types.TemplateName

Methods

(==) :: TemplateName -> TemplateName -> Bool

(/=) :: TemplateName -> TemplateName -> Bool

Ord TemplateName

Defined in Stack.Types.TemplateName

Methods

compare :: TemplateName -> TemplateName -> Ordering

(<) :: TemplateName -> TemplateName -> Bool

(<=) :: TemplateName -> TemplateName -> Bool

(>) :: TemplateName -> TemplateName -> Bool

(>=) :: TemplateName -> TemplateName -> Bool

max :: TemplateName -> TemplateName -> TemplateName

min :: TemplateName -> TemplateName -> TemplateName

Show TemplateName

Defined in Stack.Types.TemplateName

Methods

showsPrec :: Int -> TemplateName -> ShowS

show :: TemplateName -> String

showList :: [TemplateName] -> ShowS

FromJSON TemplateName

Defined in Stack.Types.TemplateName

Methods

parseJSON :: Value -> Parser TemplateName

parseJSONList :: Value -> Parser [TemplateName]

data RepoTemplatePath

Details for how to access a template from a remote repo.

Constructors

RepoTemplatePath

Fields

• rtpService :: RepoService
• rtpUser :: Text
• rtpTemplate :: Text

Instances

Eq RepoTemplatePath

Defined in Stack.Types.TemplateName

Methods

(==) :: RepoTemplatePath -> RepoTemplatePath -> Bool

(/=) :: RepoTemplatePath -> RepoTemplatePath -> Bool

Ord RepoTemplatePath

Defined in Stack.Types.TemplateName

Methods

compare :: RepoTemplatePath -> RepoTemplatePath -> Ordering

(<) :: RepoTemplatePath -> RepoTemplatePath -> Bool

(<=) :: RepoTemplatePath -> RepoTemplatePath -> Bool

(>) :: RepoTemplatePath -> RepoTemplatePath -> Bool

(>=) :: RepoTemplatePath -> RepoTemplatePath -> Bool

max :: RepoTemplatePath -> RepoTemplatePath -> RepoTemplatePath

min :: RepoTemplatePath -> RepoTemplatePath -> RepoTemplatePath

Show RepoTemplatePath

Defined in Stack.Types.TemplateName

Methods

showsPrec :: Int -> RepoTemplatePath -> ShowS

show :: RepoTemplatePath -> String

showList :: [RepoTemplatePath] -> ShowS

data RepoService

Services from which templates can be retrieved from a repository.

Constructors

Github

Gitlab

Bitbucket

Instances

Eq RepoService

Defined in Stack.Types.TemplateName

Methods

(==) :: RepoService -> RepoService -> Bool

(/=) :: RepoService -> RepoService -> Bool

Ord RepoService

Defined in Stack.Types.TemplateName

Methods

compare :: RepoService -> RepoService -> Ordering

(<) :: RepoService -> RepoService -> Bool

(<=) :: RepoService -> RepoService -> Bool

(>) :: RepoService -> RepoService -> Bool

(>=) :: RepoService -> RepoService -> Bool

max :: RepoService -> RepoService -> RepoService

min :: RepoService -> RepoService -> RepoService

Show RepoService

Defined in Stack.Types.TemplateName

Methods

showsPrec :: Int -> RepoService -> ShowS

show :: RepoService -> String

showList :: [RepoService] -> ShowS

data TemplatePath

Constructors

AbsPath (Path Abs File)

an absolute path on the filesystem

RelPath String (Path Rel File)

a relative path on the filesystem, or relative to the template repository. To avoid path separator conversion on Windows, the raw command-line parameter passed is also given as the first field (possibly with .hsfiles appended).

UrlPath String

a full URL

RepoPath RepoTemplatePath

Instances

Eq TemplatePath

Defined in Stack.Types.TemplateName

Methods

(==) :: TemplatePath -> TemplatePath -> Bool

(/=) :: TemplatePath -> TemplatePath -> Bool

Ord TemplatePath

Defined in Stack.Types.TemplateName

Methods

compare :: TemplatePath -> TemplatePath -> Ordering

(<) :: TemplatePath -> TemplatePath -> Bool

(<=) :: TemplatePath -> TemplatePath -> Bool

(>) :: TemplatePath -> TemplatePath -> Bool

(>=) :: TemplatePath -> TemplatePath -> Bool

max :: TemplatePath -> TemplatePath -> TemplatePath

min :: TemplatePath -> TemplatePath -> TemplatePath

Show TemplatePath

Defined in Stack.Types.TemplateName

Methods

showsPrec :: Int -> TemplatePath -> ShowS

show :: TemplatePath -> String

showList :: [TemplatePath] -> ShowS

templateName :: TemplateName -> Text

Get a text representation of the template name.

templatePath :: TemplateName -> TemplatePath

Get the path of the template.

parseTemplateNameFromString :: String -> Either String TemplateName

Parse a template name from a string.

parseRepoPathWithService :: RepoService -> Text -> Maybe RepoTemplatePath

Parses a template path of the form user/template, given a service

templateNameArgument :: Mod ArgumentFields TemplateName -> Parser TemplateName

An argument which accepts a template name of the format foo.hsfiles or foo, ultimately normalized to foo.

templateParamArgument :: Mod OptionFields (Text, Text) -> Parser (Text, Text)

An argument which accepts a key:value pair for specifying parameters.

defaultTemplateName :: TemplateName

The default template name you can use if you don't have one.