Giter VIP home page Giter VIP logo

thor-hollaback's Introduction

Thor::Hollaback

Build Status Gem Version

Adds callbacks to thor commands.

Installation

Add this line to your application's Gemfile:

gem "thor-hollaback"

And then execute:

$ bundle

Or install it yourself as:

$ gem install thor-hollaback

Usage

Uses the hollaback gem to add callbacks to thor commands. You can set CLI-level callbacks with the macros class_before, class_after, and class_around. You can set command-level callbacks with before, after, and around. Example below.

class CLI < Thor
  class_before :say_hello
  class_after :say_goodbye

  desc "first_test", "First test command"
  around :say
  def first_test
    puts "How are you?"
  end

  desc "second_test", "Second test command"
  def second_test
    puts "How are you?"
  end

  no_commands do
    def say_hello
      puts "Hello!"
    end

    def say_goodbye
      puts "Goodbye!"
    end

    def say
      puts "Speaking..."
      yield
      puts "...done."
    end
  end
end

When invoked, the above CLI results with:

irb(main):001:0> CLI.start(["first_test"])
Hello!
Speaking...
How are you?
...done.
Goodbye!
=> nil

and

irb(main):001:0> CLI.start(["second_test"])
Hello!
How are you?
Goodbye!
=> nil

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kddnewton/thor-hollaback.

License

The gem is available as open source under the terms of the MIT License.

thor-hollaback's People

Contributors

azim-koshoiev avatar dependabot-preview[bot] avatar dependabot[bot] avatar github-actions[bot] avatar kddnewton avatar localytics-raphael avatar mergify[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

thor-hollaback's Issues

Doesn't appear to work with subcommands

class_after is working nicely on top-level commands, but we also utilise thor subcommands and I noticed that the hollaback callback doesn't fire after running them. We're using thor-hollaback v0.2.1.

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.