MyNixOS website logo
Description

Extra functions for working with optparse-applicative.

optparse-applicative is a fantastic library

My usage of it has often used the same features wrapped in a parseOpts function along with a version helper.

This package abstracts that code into a re-usable library, minimizing pasting between projects.

optparse-applicative-dex

Synopsis

Extra functions for working with optparse-applicative

Description

optparse-applicative is a fantastic library

My usage of it has often used the same features wrapped in a parseOpts function along with a version helper.

This package abstracts that code into a re-usable library, minimizing pasting between projects.

In most CLI projects I almost always want:

  • A header consisting of the program name and a short description
  • A helper parser to provide -h, --help
  • A version helper to respond to a --version option with shorter output than -h, --help
  • Some additional usage info below the generated switch usage

The parseOpts' and parseOptsWithWidth functions in this library take a parser and arguments for header, footer and the app version as generated by cabal and do all these things automatically.

A simple example:

{- # LANGUAGE OverloadedStrings #-}

import Options.Applicative.Dex
import Paths_your_app (version)

data Options = Options { optA :: String , optB :: Bool }
  deriving Show

parser :: Parser Options
parser = Options
  <$> option str ( short 'a' <> metavar "STR" <> help "The a option, a string" )
  <*> switch ( short 'b' <> help "The b option, a switch")

main :: IO ()
main = do
  opts <- parseOpts' parser "header-info" "footer-info" version
  print opts

Getting source

Source code is available from codeberg at the optparse-applicative-dex project page.

Contact

Dino Morelli [email protected].

Metadata

Version

1.0.1

License

Platforms (76)

    Darwin
    FreeBSD
    Genode
    GHCJS
    Linux
    MMIXware
    NetBSD
    none
    OpenBSD
    Redox
    Solaris
    WASI
    Windows
Show all
  • aarch64-darwin
  • aarch64-freebsd
  • aarch64-genode
  • aarch64-linux
  • aarch64-netbsd
  • aarch64-none
  • aarch64-windows
  • aarch64_be-none
  • arm-none
  • armv5tel-linux
  • armv6l-linux
  • armv6l-netbsd
  • armv6l-none
  • armv7a-linux
  • armv7a-netbsd
  • armv7l-linux
  • armv7l-netbsd
  • avr-none
  • i686-cygwin
  • i686-freebsd
  • i686-genode
  • i686-linux
  • i686-netbsd
  • i686-none
  • i686-openbsd
  • i686-windows
  • javascript-ghcjs
  • loongarch64-linux
  • m68k-linux
  • m68k-netbsd
  • m68k-none
  • microblaze-linux
  • microblaze-none
  • microblazeel-linux
  • microblazeel-none
  • mips-linux
  • mips-none
  • mips64-linux
  • mips64-none
  • mips64el-linux
  • mipsel-linux
  • mipsel-netbsd
  • mmix-mmixware
  • msp430-none
  • or1k-none
  • powerpc-linux
  • powerpc-netbsd
  • powerpc-none
  • powerpc64-linux
  • powerpc64le-linux
  • powerpcle-none
  • riscv32-linux
  • riscv32-netbsd
  • riscv32-none
  • riscv64-linux
  • riscv64-netbsd
  • riscv64-none
  • rx-none
  • s390-linux
  • s390-none
  • s390x-linux
  • s390x-none
  • vc4-none
  • wasm32-wasi
  • wasm64-wasi
  • x86_64-cygwin
  • x86_64-darwin
  • x86_64-freebsd
  • x86_64-genode
  • x86_64-linux
  • x86_64-netbsd
  • x86_64-none
  • x86_64-openbsd
  • x86_64-redox
  • x86_64-solaris
  • x86_64-windows