GithubHelp home page GithubHelp logo

Comments (4)

mdub avatar mdub commented on August 19, 2024

Thanks for the kind words.

I can kind of see what you mean. If you miss a required option or parameter, Clamp emits a short message:

$ ./examples/word 
ERROR: parameter 'WORD': no value provided

See: 'word --help'

So, it might make sense to do something similar for missing subcommands:

$ ./examples/gitdown 
ERROR: no subcommand provided

See: 'gitdown --help'

On the other hand, I played with a few popular CLI tools that have subcommands - git, docker, and kubectl - and note that all of them show exactly the same behaviour for CMD and CMD --help.

So, I'm a bit torn about whether to change Clamp's default behaviour.

Meanwhile, you could use this trick:

Clamp do

  # ...

  self.default_subcommand = "barf"

  def subcommand_missing(name)
    signal_usage_error "no subcommand specified" if name == "barf"
    super
  end

end

from clamp.

DannyBen avatar DannyBen commented on August 19, 2024

I see your point. I never actually made the distinction between CLI with subcommands, and without.

from clamp.

mdub avatar mdub commented on August 19, 2024

I'm still torn on this one. I'm tempted to change the default behaviour as suggested, ie.

$ ./examples/gitdown 
ERROR: no subcommand provided

See: 'gitdown --help'

from clamp.

mdub avatar mdub commented on August 19, 2024

I'm going to default to the devil we know, i.e. not changing current behaviour.

from clamp.

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.