navi
Safe HaskellNone
LanguageGHC2021

Navi.Args

Description

Provides functionality for parsing command-line arguments.

Synopsis

Documentation

newtype Args (f :: Type -> Type) Source #

Represents command-line arguments. We use the "higher-kinded data" approach for:

  1. Parsing optional arguments (Args Maybe).
  2. Filling missing arguments with defaults (Args Identity).

Constructors

MkArgs 

Fields

Instances

Instances details
(k ~ An_Iso, a ~ f1 OsPath, b ~ f2 OsPath) => LabelOptic "configFile" k (Args f1) (Args f2) a b Source # 
Instance details

Defined in Navi.Args

Methods

labelOptic :: Optic k NoIx (Args f1) (Args f2) a b Source #

Show1 f => Show (Args f) Source # 
Instance details

Defined in Navi.Args

Methods

showsPrec :: Int -> Args f -> ShowS #

show :: Args f -> String #

showList :: [Args f] -> ShowS #

getArgs :: (HasCallStack, MonadOptparse m, MonadPathReader m) => m (Args Identity) Source #

Parses cli args and fills in defaults. These defaults are based on the detected XDG Base Directory and default names.