Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/packsaddle/ruby-saddler-reporter-support
Interface for saddler-reporter. And utilities for saddler-reporter.
https://github.com/packsaddle/ruby-saddler-reporter-support
Last synced: about 2 months ago
JSON representation
Interface for saddler-reporter. And utilities for saddler-reporter.
- Host: GitHub
- URL: https://github.com/packsaddle/ruby-saddler-reporter-support
- Owner: packsaddle
- License: mit
- Created: 2015-02-24T09:22:36.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-03-05T11:41:23.000Z (almost 3 years ago)
- Last Synced: 2024-10-31T13:40:18.141Z (about 2 months ago)
- Language: Ruby
- Homepage: http://packsaddle.org
- Size: 34.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Saddler::Reporter::Support
[![Gem version][gem-image]][gem-url] [![CI Status][ci-image]][ci-url] [![yard docs][docs-image]][docs-url]
> Interface for saddler-reporter. And utilities for saddler-reporter.
## API
Interface for saddler-reporter.
### #initialize(output)
#### output
Type: `#puts`
output interface (defaults to: $stdout)
### #report(messages, options) -> void
#### messages
Type: `String`
reporting message. checkstyle format.
#### options
Type: `Hash`
options from saddler cli.
And more *[details][docs-url]*.
## Changelog
[changelog.md](./changelog.md).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'saddler-reporter-support'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install saddler-reporter-support
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
1. Fork it ( https://github.com/packsaddle/ruby-saddler-reporter-support/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## License
© [sanemat](http://sane.jp)
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
[ci-url]: https://circleci.com/gh/packsaddle/ruby-saddler-reporter-support
[ci-image]: https://img.shields.io/circleci/build/github/packsaddle/ruby-saddler-reporter-support?style=flat-square
[gem-url]: https://rubygems.org/gems/saddler-reporter-support
[gem-image]: http://img.shields.io/gem/v/saddler-reporter-support.svg?style=flat-square
[docs-url]: http://www.rubydoc.info/gems/saddler-reporter-support
[docs-image]: https://img.shields.io/badge/yard-docs-blue.svg?style=flat-square