Termonad.Cli

This module exposes Termonad's CLI argument parsing functionality.

The main function for parsing CLI arguments is parseCliArgs. The function that knows how to combine CLI arguments with normal ConfigOptions is applyCliArgs.

Documentation

data CliArgs

A data type that contains arguments from the command line.

Constructors

CliArgs

Fields

• cliConfigOptions :: CliConfigOptions
• extraCliArgs :: ExtraCliArgs

Instances

Show CliArgs

Defined in Termonad.Cli

Methods

showsPrec :: Int -> CliArgs -> ShowS

show :: CliArgs -> String

showList :: [CliArgs] -> ShowS

Eq CliArgs

Defined in Termonad.Cli

Methods

(==) :: CliArgs -> CliArgs -> Bool

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

defaultCliArgs :: CliArgs

The default CliArgs. This corresponds to the value CliArgs will become when no CLI arguments have been passed.

>>> :{
  let defCliArgs =
        CliArgs
          { cliConfigOptions = defaultCliConfigOptions
          , extraCliArgs = defaultExtraCliArgs
          }
  in defaultCliArgs == defCliArgs
:}
True

data CliConfigOptions

CLI arguments that correspond to fields in ConfigOptions.

See ConfigOptions for what each of these options mean.

Constructors

CliConfigOptions

Fields

• cliConfFontFamily :: !(Option Text)
• cliConfFontSize :: !(Option FontSize)
• cliConfShowScrollbar :: !(Option ShowScrollbar)
• cliConfScrollbackLen :: !(Option Integer)
• cliConfConfirmExit :: !(Option Bool)
• cliConfWordCharExceptions :: !(Option Text)
• cliConfShowMenu :: !(Option Bool)
• cliConfShowTabBar :: !(Option ShowTabBar)
• cliConfCursorBlinkMode :: !(Option CursorBlinkMode)
• cliConfBoldIsBright :: !(Option Bool)
• cliConfEnableSixel :: !(Option Bool)
• cliConfAllowBold :: !(Option Bool)

Instances

Show CliConfigOptions

Defined in Termonad.Cli

Methods

showsPrec :: Int -> CliConfigOptions -> ShowS

show :: CliConfigOptions -> String

showList :: [CliConfigOptions] -> ShowS

Eq CliConfigOptions

Defined in Termonad.Cli

Methods

(==) :: CliConfigOptions -> CliConfigOptions -> Bool

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

defaultCliConfigOptions :: CliConfigOptions

The default CliConfigOptions. All Options are Unset, which means they won't override options from ConfigOptions in applyCliArgs.

>>> :{
  let defCliConfOpt =
        CliConfigOptions
          { cliConfFontFamily = Unset
          , cliConfFontSize = Unset
          , cliConfShowScrollbar = Unset
          , cliConfScrollbackLen = Unset
          , cliConfConfirmExit = Unset
          , cliConfWordCharExceptions = Unset
          , cliConfShowMenu = Unset
          , cliConfShowTabBar = Unset
          , cliConfCursorBlinkMode = Unset
          , cliConfBoldIsBright = Unset
          , cliConfEnableSixel = Unset
          , cliConfAllowBold = Unset
          }
  in defaultCliConfigOptions == defCliConfOpt
:}
True

data ExtraCliArgs

Extra CLI arguments for values that don't make sense in ConfigOptions.

Constructors

ExtraCliArgs

Instances

Show ExtraCliArgs

Defined in Termonad.Cli

Methods

showsPrec :: Int -> ExtraCliArgs -> ShowS

show :: ExtraCliArgs -> String

showList :: [ExtraCliArgs] -> ShowS

Eq ExtraCliArgs

Defined in Termonad.Cli

Methods

(==) :: ExtraCliArgs -> ExtraCliArgs -> Bool

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

defaultExtraCliArgs :: ExtraCliArgs

The default ExtraCliArgs.

>>> :{
  let defExtraCliArgs =
        ExtraCliArgs
  in defaultExtraCliArgs == defExtraCliArgs
:}
True

strOption' :: IsString s => Mod OptionFields (Option s) -> Parser (Option s)

Similar to strOption, but specifically work on a value that is an Option.

option' :: ReadM a -> Mod OptionFields (Option a) -> Parser (Option a)

Similar to option, but specifically work on a value that is an Option.

maybeTextReader :: (Text -> Maybe a) -> ReadM a

Similar to maybeReader, but work on Text instead of String.

optionFlag

Arguments

:: a

Value when specified without no- prefix.

-> a

Value when specified with no- prefix.

-> Char

Short flag for without no- prefix.

-> Char

Short flag for with no- prefix.

-> String

Long flag.

-> String

Help text for without no- prefix option.

-> String

Help text for with no- prefix option.

-> Parser (Option a)

Helper for making a flag CLI argument that optionally takes a no- prefix.

Example:

'optionFlag' 'True' 'False' 'f' 'n' "foo" "Does foo" "Does not do foo" :: Parser (Option Bool)

This creates a Parser that accepts both a --foo and a --no-foo flag. Passing --foo returns Set True, while passing --no-foo returns Set False. Passing neither --foo nor --no-foo returns Unset.

TODO: This doesn't quite work. If the user passes both --foo and --no-foo flags, this should ideally take the value of the last flag passed. However, it appears that if you pass both flags, the second flag is just not recognized and optparse-applicative raises an error.

cliConfigOptionsParser :: Parser CliConfigOptions

fontFamilyParser :: Parser (Option Text)

fontSizeParser :: Parser (Option FontSize)

showScrollbarParser :: Parser (Option ShowScrollbar)

scrollbackLenParser :: Parser (Option Integer)

confirmExitParser :: Parser (Option Bool)

wordCharExceptionsParser :: Parser (Option Text)

showMenuParser :: Parser (Option Bool)

showTabBarParser :: Parser (Option ShowTabBar)

cursorBlinkModeParser :: Parser (Option CursorBlinkMode)

boldIsBrightParser :: Parser (Option Bool)

enableSixelParser :: Parser (Option Bool)

allowBoldParser :: Parser (Option Bool)

extraCliArgsParser :: Parser ExtraCliArgs

cliArgsParser :: Parser CliArgs

cliArgsParserInfo :: ParserInfo CliArgs

parseCliArgs :: IO CliArgs

Parse and return CliArguments.

applyCliArgs :: CliArgs -> ConfigOptions -> ConfigOptions

Overwrite the arguments in ConfigOptions that have been Set in CliArgs.

>>> import Termonad.Types (defaultConfigOptions)
>>> let cliConfOpts = defaultCliConfigOptions { cliConfScrollbackLen = Set 50 }
>>> let cliArgs = defaultCliArgs { cliConfigOptions = cliConfOpts }
>>> let overwrittenConfOpts = defaultConfigOptions { scrollbackLen = 50 }
>>> applyCliArgs cliArgs defaultConfigOptions == overwrittenConfOpts
True