https://github.com/ohbarye/rusky
💎 + 🐶 = Rusky, it helps you to manage Git hooks easily.
https://github.com/ohbarye/rusky
gem git githook hooks ruby
Last synced: 7 months ago
JSON representation
💎 + 🐶 = Rusky, it helps you to manage Git hooks easily.
- Host: GitHub
- URL: https://github.com/ohbarye/rusky
- Owner: ohbarye
- License: mit
- Created: 2017-08-30T14:14:39.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T14:57:58.000Z (almost 2 years ago)
- Last Synced: 2025-03-24T12:21:52.220Z (8 months ago)
- Topics: gem, git, githook, hooks, ruby
- Language: Ruby
- Homepage: https://rubygems.org/gems/rusky
- Size: 44.9 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Rusky
Rusky is a lightweight library which helps you to manage Git hooks easily. Once you set up Rusky, it would be beneficial for all your team.
This library is inspired an awesome npm library, [husky](https://github.com/typicode/husky). So Rusky = Ruby + husky.
If you don't know Git hooks well, [the official document](https://git-scm.com/docs/githooks) would help you.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'rusky', group: :development
```
And then execute:
```console
$ bundle
```
Or install it yourself as:
```console
$ gem install rusky
```
After installation, Rusky automatically creates git hook scripts in `.git/hooks` directory. It does not remove existing files.
## Usage
1. Add the following lines into your `Rakefile` (or [any other rake file](https://github.com/ruby/rake/blob/68ef9140c11d083d8bb7ee5da5b0543e3a7df73d/lib/rake/application.rb#L41-L46)). It defines rake tasks to be executed on Git hook. The task names are `"rusky:#{git_hook_name}"`.
```ruby
require "rusky/task"
Rusky::Task.install
```
2. Create `.rusky` file and define what you want on Git hooks as YAML. Keys should be Git hook name. Values should be an array of shell commands. Rusky executes those commands on Git hook.
```yaml
# .rusky
pre-commit:
- rubocop
pre-push:
- bundle exec rspec
```
### Manual installation
Although Rusky automatically creates necessary files, it provides CLI for (un)installation as well. It would be useful when you want to retry (un)install.
```console
rusky -h
Commands:
rusky help [COMMAND] # Describe available commands or one specific command
rusky install # Generate Git hooks and .rusky files
rusky uninstall # Remove files generated by rusky
rusky version # Show current version
Options:
-h, [--help], [--no-help] # Show help message.
-v, [--version], [--no-version] # Show current version
```
### Customizable callback rake task
You can write your own rake task as a callback of Git hook.
```ruby
# Rakefile
require "rusky/task"
namespace :rusky do
task :pre_commit do
# Your awesome task
end
end
Rusky::Task.install
```
NOTE: You have to call `Rusky::Task.install` after your task definition. Otherwise, the task is defined twice. According to the current Rake spec, such a duplicated task does not overwrite a former one, both run when calling the task.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ohbarye/rusky. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).