Summoner.CLI

This module contains functions and data types to parse CLI inputs.

CLI data types

data Command

Represent all available commands

Constructors

New NewOpts

new command creates a new project

Script ScriptOpts

script command creates Haskell script

ShowInfo ShowOpts

show command shows supported licenses or GHC versions

data NewOpts

Options parsed with new command

Constructors

NewOpts

Fields

• newOptsProjectName :: Text

  project name

• newOptsIgnoreFile :: Bool

  ignore all config files if True

• newOptsOffline :: Bool

  Offline mode

• newOptsConfigFile :: Maybe FilePath

  file with custom configuration

• newOptsCliConfig :: PartialConfig

  config gathered during CLI

data ShowOpts

Commands parsed with show command

Constructors

GhcList

LicenseList (Maybe String)

Functions to parse CLI arguments and run summoner

summon :: Version -> (Command -> IO ()) -> IO ()

Main function that parses CLI commands and runs them using given Command handler.

summonCli :: IO ()

Runs summoner in CLI mode.

Runners

runScript :: ScriptOpts -> IO ()

Runs script command.

Usage: summon script BUILD_TOOL (-g|--ghc GHC_VERSION) (-n|--name FILE_NAME)
  Create a new Haskell script

Available options:
  -h,--help                Show this help text
  -g,--ghc GHC_VERSION     Version of the compiler to be used for script
  -n,--name FILE_NAME      Name of the script file

Common helper functions

getFinalConfig :: NewOpts -> IO Config

By the given NewOpts return the final configurations.