https://github.com/ydah/rubocop-committee
A RuboCop extension focused on enforcing committee.
https://github.com/ydah/rubocop-committee
committee formatting linting linting-rules rubocop
Last synced: over 1 year ago
JSON representation
A RuboCop extension focused on enforcing committee.
- Host: GitHub
- URL: https://github.com/ydah/rubocop-committee
- Owner: ydah
- License: mit
- Created: 2022-12-28T12:36:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-02T14:27:18.000Z (over 1 year ago)
- Last Synced: 2025-04-10T18:10:59.799Z (over 1 year ago)
- Topics: committee, formatting, linting, linting-rules, rubocop
- Language: Ruby
- Homepage: https://www.rubydoc.info/gems/rubocop-committee
- Size: 87.9 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: MIT-LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# RuboCop Committee [](https://badge.fury.io/rb/rubocop-committee) [](https://github.com/ydah/rubocop-committee/actions/workflows/ci.yml)
[Committee](https://github.com/interagent/committee)-specific analysis for your projects, as an extension to
[RuboCop](https://github.com/rubocop/rubocop).
## Installation
Just install the `rubocop-committee` gem
```bash
gem install rubocop-committee
```
or if you use bundler put this in your `Gemfile`
```
gem 'rubocop-committee', require: false
```
## Usage
You need to tell RuboCop to load the Committee extension. There are two
ways to do this:
### RuboCop configuration file
Put this into your `.rubocop.yml`.
```yaml
plugins: rubocop-committee
```
Alternatively, use the following array notation when specifying multiple extensions.
```yaml
plugins:
- rubocop-other-extension
- rubocop-committee
```
Now you can run `rubocop` and it will automatically load the RuboCop Committee
cops together with the standard cops.
> [!NOTE]
> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
### Command line
```bash
rubocop --plugin rubocop-committee
```
### Rake task
```ruby
RuboCop::RakeTask.new do |task|
task.plugins << 'rubocop-committee'
end
```
## Documentation
You can read more about RuboCop Committee in its [official manual](https://ydah.github.io/rubocop.docs/rubocop-committee/).
## The Cops
All cops are located under
[`lib/rubocop/cop/committee`](lib/rubocop/cop/committee), and contain
examples/documentation.
In your `.rubocop.yml`, you may treat the Committee cops just like any other
cop. For example:
```yaml
Committee/FilePath:
Exclude:
- spec/my_poorly_named_spec_file.rb
```
## Contributing
Checkout the [contribution guidelines](.github/CONTRIBUTING.md).
## License
`rubocop-committee` is MIT licensed. [See the accompanying file](MIT-LICENSE.md) for
the full text.