https://github.com/matt-taylor/thor_enhance

https://github.com/matt-taylor/thor_enhance

Last synced: about 14 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/matt-taylor/thor_enhance
• Owner: matt-taylor
• Created: 2023-11-19T05:16:17.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-26T23:59:34.000Z (about 1 year ago)
• Last Synced: 2024-05-10T22:02:06.961Z (8 months ago)
• Language: Ruby
• Size: 44.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this 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:

```ruby

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](docs/hooks.md)

[Hook examples](examples/hooks.md)

### Method option Injection

Method option injection allows you to enhance specific commands. When used inconjunction with [ThorEnhance::Tree](docs/tree.md), the added fields to the method options are avaialable in your code with ease.

[Method option documentation](docs/method_option.md)

### Command option Injection

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

[Command option documentation](docs/command.md)

### 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](docs/autogenerate/Readme.md)

### Initialization

[Refere to documentation](docs/initialization.md)

## Contributing

Bug reports and pull requests are welcome on GitHub at

https://github.com/matt-taylor/thor_enhance.