noboru-i/findbugs_translate_checkstyle_format

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# FindbugsTranslateCheckstyleFormat

[![Gem Version](https://badge.fury.io/rb/findbugs_translate_checkstyle_format.svg)](http://badge.fury.io/rb/findbugs_translate_checkstyle_format)
[![Build Status](https://travis-ci.org/noboru-i/findbugs_translate_checkstyle_format.svg?branch=master)](https://travis-ci.org/noboru-i/findbugs_translate_checkstyle_format)
[![Code Climate](https://codeclimate.com/github/noboru-i/findbugs_translate_checkstyle_format/badges/gpa.svg)](https://codeclimate.com/github/noboru-i/findbugs_translate_checkstyle_format)
[![Coverage Status](https://coveralls.io/repos/noboru-i/findbugs_translate_checkstyle_format/badge.svg)](https://coveralls.io/r/noboru-i/findbugs_translate_checkstyle_format)

Translate findbugs format into checkstyle format.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'findbugs_translate_checkstyle_format'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install findbugs_translate_checkstyle_format

## Usage

### Use pipe

```
cat findbugs.xml | findbugs_translate_checkstyle_format translate
```

### Use command-line option

```
findbugs_translate_checkstyle_format translate --file="findbugs.xml"
```

### Use from ruby script

```ruby
require 'findbugs_translate_checkstyle_format'
findbugs_xml = ::FindbugsTranslateCheckstyleFormat::Script.translate('<?xml ...')
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake 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/[USERNAME]/findbugs_translate_checkstyle_format. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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).