FP.API

Documentation

themeToString :: Theme -> String

Convert a theme to a string.

themeName :: Theme -> String

Get a human-readable name for a theme.

themeDescription :: Theme -> String

Get a human-readable description of a string.

enumerateThemes :: [Theme]

Similar to [minBound..maxBound], with our own custom ordering.

defaultTheme :: Theme

The default theme to use when there is no existing theme.

defaultFontSize :: Int

The default font size to use.

defaultSearchStyle :: Bool

defaultLicense :: IdeLicense

Default license to use upon initialization.

invalidSettingsError :: Text

Error that can be returned by some commands, which indicates that the command requires that the settings file be valid.

serverSessionNotReadyError :: Text

Error that can be returned by GetProjectMessages, which indicates that the backend server hasn't started yet. In order to cause the server to run, some normal command needs to be executed (not a project messages poll, though).

projectSettingsPath :: Text

The filepath used for the settings file.

validGitBranch :: String -> Bool

Determine whether a git branch name is valid.

TODO: This could be better. See, e.g. the regexes here: http://stackoverflow.com/a/12093994/1164871

data Action

Action that roles can perform.

Constructors

DoBuildExecutables

DoDeployment

DoPrivateProjects

DoMakeCommercialProducts

DoGitStuff

DoExternalEditor

Instances

Eq Action

Show Action

Generic Action

Serialize Action

type Rep Action

describeAction :: Action -> Text

Give a human readable description for actions that could be used in a sentence.

canDo :: IdeLicense -> Action -> Bool

Can the given role do the given action?

licenseName :: IdeLicense -> Text

Get the name of the license, for use in code IDs and such.

module FP.API.Types