Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/richardboehme/ruboconf
Opinionated RuboCop configuration for personal projects.
https://github.com/richardboehme/ruboconf
rubocop ruby
Last synced: 13 days ago
JSON representation
Opinionated RuboCop configuration for personal projects.
- Host: GitHub
- URL: https://github.com/richardboehme/ruboconf
- Owner: richardboehme
- License: mit
- Created: 2022-01-21T20:27:45.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-20T21:46:23.000Z (about 2 months ago)
- Last Synced: 2024-10-05T00:41:00.009Z (about 1 month ago)
- Topics: rubocop, ruby
- Language: Ruby
- Homepage:
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ruboconf
Opinionated RuboCop configuration for personal projects.
Those configurations are chosen based on my subjective feelings about some cops. I do not plan to accept Pull Requests, besides for objectively better configuration options.
If you want to use RuboCop Rails you might be interested in [ruboconf-rails](https://github.com/richardboehme/ruboconf-rails).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'ruboconf'
```
And then execute:
$ bundle install
Add the following to your project's `.rubocop.yml`:
```yml
inherit_gem:
ruboconf: ruboconf.yml
```
## Usage
Make sure to execute RuboCop using bundler:
$ bundle exec rubocop
## Development
After checking out the repo, run `bin/setup` to install dependencies. 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 the gemspec, 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](https://rubygems.org).
## Contributing
As stated above, I do not plan to accept Pull Requests. The only exception to this would be discussions about RuboCop updates and objectively better configurations.
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the 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 Ruboconf project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/richardboehme/ruboconf/blob/main/CODE_OF_CONDUCT.md).