Headroom.Command.Types

This module contains data types for Headroom.Command module.

Documentation

data Command

Application command.

Constructors

Run [FilePath] [Regex] Bool (Maybe LicenseType) [TemplateRef] [Text] (Maybe RunMode) Bool Bool

run command

Gen Bool (Maybe (LicenseType, FileType))

gen command

Init LicenseType [FilePath]

init command

Instances

Show Command

Defined in Headroom.Command.Types

Methods

showsPrec :: Int -> Command -> ShowS

show :: Command -> String

showList :: [Command] -> ShowS

newtype CommandGenOptions

Options for the gen command.

Constructors

CommandGenOptions

Fields

• cgoGenMode :: GenMode

  selected mode

Instances

Show CommandGenOptions

Defined in Headroom.Command.Types

Methods

showsPrec :: Int -> CommandGenOptions -> ShowS

show :: CommandGenOptions -> String

showList :: [CommandGenOptions] -> ShowS

data CommandInitOptions

Options for the init command.

Constructors

CommandInitOptions

Fields

• cioSourcePaths :: [FilePath]

  paths to source code files

• cioLicenseType :: LicenseType

  license type

Instances

Show CommandInitOptions

Defined in Headroom.Command.Types

Methods

showsPrec :: Int -> CommandInitOptions -> ShowS

show :: CommandInitOptions -> String

showList :: [CommandInitOptions] -> ShowS

Has CommandInitOptions Env

Defined in Headroom.Command.Init

Methods

getter :: Env -> CommandInitOptions

modifier :: (CommandInitOptions -> CommandInitOptions) -> Env -> Env

hasLens :: Lens' Env CommandInitOptions

viewL :: MonadReader Env m => m CommandInitOptions

data CommandRunOptions

Options for the run command.

Constructors

CommandRunOptions

Fields

• croRunMode :: Maybe RunMode

  used Run command mode

• croSourcePaths :: [FilePath]

  source code file paths

• croExcludedPaths :: [Regex]

  source paths to exclude

• croExcludeIgnoredPaths :: Bool

  whether to exclude ignored paths

• croBuiltInTemplates :: Maybe LicenseType

  whether to use built-in templates

• croTemplateRefs :: [TemplateRef]

  template references

• croVariables :: [Text]

  raw variables

• croDebug :: Bool

  whether to run in debug mode

• croDryRun :: Bool

  whether to perform dry run

Instances

Eq CommandRunOptions

Defined in Headroom.Command.Types

Methods

(==) :: CommandRunOptions -> CommandRunOptions -> Bool

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

Show CommandRunOptions

Defined in Headroom.Command.Types

Methods

showsPrec :: Int -> CommandRunOptions -> ShowS

show :: CommandRunOptions -> String

showList :: [CommandRunOptions] -> ShowS