Documentation

The kind of application interface.

Cases:

• ApplicationCLI — the application has a Command-Line Interface.
• ApplicationGUI — the application has a Graphical-User Interface.

Platform for desktop applications.

The primary fields of ApplicationInformation, from which the rest are derived (via defaultApplicationInformation).

Required fields share type with their namesake field (implicitly under Identity). Optional fields are wrapped under Maybe.

Metadata for a (cross-platform) application.

Fields

Metadata:

• $sel:name:ApplicationInformation — The name of the application. In english, should be capitalized and have spaces.
• $sel:version:ApplicationInformation — The application's (current) version. Should be parseable by base's parseVersion (custom development versions, like injecting a git commit, should be separated from the version numbers by a hyphen).
• $sel:license:ApplicationInformation — The application's license. Should be an SPDX License Identifier.
• $sel:executable:ApplicationInformation — The basename (or shell identifier) of the executable file. Should match the executable stanza in the package's .cabal. For legibility and portability, words should be separated by hyphens (i.e. -) or underscores (i.e. _). $sel:interface:ApplicationInformation — Whether the application has a Command-Line Interface or a Graphical-User Interface.

Platform-specific metadata:

• $sel:platforms:ApplicationInformation — Supported platforms (i.e. that the application is known to run on).
• $sel:posixDirectory:ApplicationInformation — .
• $sel:windowsDirectory:ApplicationInformation — .
• $sel:macintoshDirectory:ApplicationInformation — .

Example

e.g.:

myApplicationInformation :: ApplicationInformation
myApplicationInformation = ApplicationInformation{..}
  where

  $sel:name:ApplicationInformation                  = "My Application"
  $sel:version:ApplicationInformation               = "0.0.0"
  $sel:license:ApplicationInformation               = "GPL-3.0-or-later"
  $sel:vendor:ApplicationInformation                = "sboosali.io"
  $sel:executable:ApplicationInformation            = "my-application"

  $sel:interface:ApplicationInformation             = ApplicationCLI
  $sel:platforms:ApplicationInformation             = allDesktopPlatforms
                              -- [ DesktopLinux, DesktopWindows, DesktopMacintosh ]

  $sel:posixDirectory:ApplicationInformation     = "myapplication/"
  $sel:windowsDirectory:ApplicationInformation   = "sboosaliMy Application"
  $sel:macintoshDirectory:ApplicationInformation = "io.sboosali.My-Application/"

Default ApplicationInformation.

May call:

• asExecutableName
• allDesktopPlatforms
• asPosixDirectory
• $sel:windowsDirectory:ApplicationInformation
• $sel:macintoshDirectory:ApplicationInformation

Required fields are "". Optional fields are Nothing.

the input FilePath must be strictly relative. i.e.:

• no ../

Creates any (non-existant) parent directories (in Bash, like a mkdir -p on the dirname).

Construct a $sel:executable:ApplicationInformation from a $sel:name:ApplicationInformation.

Examples

>>> asExecutableName "My Application"
"my-application"

Construct a $sel:posixDirectory:ApplicationInformation from a $sel:name:ApplicationInformation.

Examples

>>> import qualified Prelude
>>> asPosixDirectory "My Application" Prelude.undefined
"myapplication/"

Construct a $sel:windowsDirectory:ApplicationInformation from a $sel:vendor:ApplicationInformation and a $sel:name:ApplicationInformation.

Examples

>>> asWindowsDirectory "My Application" "www.sboosali.com"
"sboosali/My Application/"

Construct a $sel:macintoshDirectory:ApplicationInformation from a $sel:vendor:ApplicationInformation and a $sel:name:ApplicationInformation.

Examples

>>> asMacintoshDirectory "My Application" "www.sboosali.com"
"com.sboosali.www.My-Application/"

Convert multiple whitespace characters to a single hyphen character.

Examples

>>> convertSpacesToHyphens " phrase with     spaces "
"phrase-with-spaces"