Code Monkey home page Code Monkey logo

Comments (4)

ndmitchell avatar ndmitchell commented on May 6, 2024

You mean if the user doesn't type --foo=1 then it raises an error? You'll need to check that yourself as "normal" command line programs don't typically require flags, so it isn't supported by default.

from cmdargs.

Magicloud avatar Magicloud commented on May 6, 2024

Thanks for the reply. So tradition req in getopt is not mapped to a thing here?

from cmdargs.

ndmitchell avatar ndmitchell commented on May 6, 2024

Sorry for the seriously long delay in replying!

In getopt, req is equivalent to banning --foo unless you write --foo=test with some argument.

In cmdargs, req is the default, you always have to write --foo=test (unless you are using a boolean flag, or a Maybe), and you can remove the "req" feature by writing opt "default" - which makes --foo equivalent to --foo=default.

from cmdargs.

OsePedro avatar OsePedro commented on May 6, 2024

Would it be worth adding support for Either a b (for any supported atomic type b), as a more informative alternative to Maybe b? That would allow us to write things like:

data MyCmdArgs = MyCmdArgs {mandatoryInt :: Either String Int, optionalInt :: Int}

myCmdArgs = 
  MyCmdArgs {
    mandatoryInt = Left "You must specify --mandatoryInt",
    optionalInt = def
  }

which would help to reduce some of the work involved in telling the user which mandatory flags they've omitted.

"normal" command line programs don't typically require flags

With some applications that take multiple mandatory command-line inputs that are used in different ways, you can improve the user experience by using flags to name some of the mandatory arguments, so that the user won't have to provide them in a fixed order (which can lead to useless output, or even data loss, if they get the order wrong). Also, with applications like ffmpeg that can take arbitrary numbers of input and output files, you need at least one flag to distinguish between the two types of files (e.g. in ffmpeg, you identify each input video with the -i flag).

from cmdargs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.