Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fnando/rubocop-fnando


https://github.com/fnando/rubocop-fnando

rubocop rubocop-rails ruby

Last synced: about 17 hours ago
JSON representation

Awesome Lists containing this project

README

        

# Rubocop

The way I like my Ruby code to be formatted. Period.

## Installation

Add this line to your application's Gemfile:

```ruby
gem "rubocop-fnando"
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install rubocop-fnando

## Usage

Create a `.rubocop.yml` and add the following lines:

```yaml
---
inherit_gem:
rubocop-fnando: .rubocop.yml

AllCops:
TargetRubyVersion: 3.2
```

If you're using Rails, then use the following lines:

```yaml
---
inherit_gem:
rubocop-fnando: .rubocop-rails.yml

AllCops:
TargetRubyVersion: 3.2
TargetRailsVersion: 7.0
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run
`rake test` 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/fnando/rubocop-fnando. 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](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Rubocop::Fnando project’s codebases, issue trackers,
chat rooms and mailing lists is expected to follow the
[code of conduct](https://github.com/fnando/rubocop-fnando/blob/main/CODE_OF_CONDUCT.md).