0.0
No release in over a year
Have you ever wanted your thor commands to tell a story of what they are? Or have you ever wanted to deprecate an option over time easily? ThorEnhance allows to to annote methods and commands in a human readable way
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

 Project Readme

ThorEnhance

ThorEnhance enhances thor's capabiltiies. It allows customizable method options and task options.

Additionally it provides hooks into each method option that allows deprecation dynamically.

Installation

Add this line to your application's Gemfile:

gem 'thor_enhance'

Usage

Hooks

Hooks allow you to deprecate, warn, or do some other custimizable action when a user calls thor with the specific option

Hook documentation Hook examples

Method option Injection

Method option injection allows you to enhance specific commands. When used inconjunction with ThorEnhance::Tree, the added fields to the method options are avaialable in your code with ease.

Method option documentation

Command option Injection

Command option injection is very powerful. This allows add low level documentation in line with the actual code.

Command option documentation

Automatic ReadMe Generation

The beauty of ThorEnhance is that it forces all your documentation to live with the code. As your code changes, the documentation naturally changes with it.

ThorEnhance can automatically generate your code bases Readme for you.

Autogenerate Readme

Initialization

Refere to documentation

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/matt-taylor/thor_enhance.