This is a Ruby gem that allows you to build structured error objects in a flexible and configurable way.
Before you begin, ensure you have met the following requirements:
- Ruby version 3.1.0 or newer. You can check your Ruby version by running
ruby -v. - Bundler installed. You can install Bundler with
gem install bundler.
Install the gem and add to the application's Gemfile by executing:
$ bundle add error_craft
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install error_craft
If you have to use in Rails:
- Add to
Gemfile
gem 'error_craft'- Run
bundle i
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. Then, eun rake rubocop to run the rubocop. 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 the created tag, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/mmarusyk/error_craft. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct. You can find a list of contributors in the CONTRIBUTORS.md file.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the error_craft project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.