Giter Site home page Giter Site logo

Comments (5)

alecthomas avatar alecthomas commented on August 16, 2024

There is already a .Dispatch() hook on flags and commands. Is this sufficient?

eg.

cmd := app.Command("greet", "Greet a user").Dispatch(func(*ParseContext) error {
  println("hi")
})

Also, you don't need to duplicate string constants. Just use cmd.FullCommand() in the case statements.

from kingpin.

fluffysquirrels avatar fluffysquirrels commented on August 16, 2024

Dispatch looks good. On glancing at the code the ParseContext parameter type made me think it was for dispatching parsing, not running the commands themselves. I'd like to add documentation to this.

I'd missed cmd.FullCommand(), yes that would help things. I see it's used in README.md but missing in the godoc example. I'd like to update the godoc example as well.

Those two are a big improvement, thanks for pointing them out.

This still doesn't get rid of the switch statement, which I think would be a big improvement. Would you be interested in a PR to add the documentation I mentioned above and dispatch automagically to your commands' Dispatch handlers?

from kingpin.

alecthomas avatar alecthomas commented on August 16, 2024

More documentation is always better!

Dispatch() is called after a command is parsed, so you shouldn't need a switch statement AFAICT. Unless I'm missing something?

from kingpin.

fluffysquirrels avatar fluffysquirrels commented on August 16, 2024

I'm so sorry for wasting your time on this. I was scanning the code by using the Github search tool with the keyword dispatch, which it turns out only shows a few matches per file. That'll teach me for not using grep! Looking again I can see the unit test to verify cmd.Dispatch() is called.

I'll submit a PR to update some of the documentation, which will hopefully make these best practices more discoverable.

from kingpin.

alecthomas avatar alecthomas commented on August 16, 2024

No problem! As you say, documentation is a bit lacking :)

from kingpin.

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.