| Copyright | (c) 2019-2022 Vaclav Svejcar |
|---|---|
| License | BSD-3-Clause |
| Maintainer | vaclav.svejcar@gmail.com |
| Stability | experimental |
| Portability | POSIX |
| Safe Haskell | None |
| Language | Haskell2010 |
Headroom.Meta
Description
Module providing application metadata, such as application name, vendor, version, etc.
Synopsis
- type TemplateType = Mustache
- buildVersion :: Version
- configBreakingChanges :: [Version]
- configFileName :: IsString a => a
- cacheFileName :: IsString a => a
- globalConfigDirName :: IsString a => a
- globalConfigFileName :: IsString a => a
- productDesc :: Text
- productInfo :: Text
- productName :: Text
- productVendor :: IsString a => a
- webDoc :: Version -> Text
- webDocConfigCurr :: Text
- webDocMigration :: Version -> Text
- webRepo :: Text
Documentation
type TemplateType = Mustache Source #
Type of the template format used for license headers.
buildVersion :: Version Source #
Application version, as specified in headroom.cabal file.
configBreakingChanges :: [Version] Source #
List of versions that made breaking changes into YAML configuration and require some migration steps to be performed by end-user.
configFileName :: IsString a => a Source #
Name of the YAML configuration file.
cacheFileName :: IsString a => a Source #
Name of the global cache file.
globalConfigDirName :: IsString a => a Source #
Name of the global configuration directory
globalConfigFileName :: IsString a => a Source #
Name of the YAML global configuration file.
productDesc :: Text Source #
Full product description.
productInfo :: Text Source #
Product info.
productName :: Text Source #
Product name.
productVendor :: IsString a => a Source #
Product vendor.
webDocConfigCurr :: Text Source #
Link to configuration documentation for current version.
webDocMigration :: Version -> Text Source #
Product migration guide for given version.