https://github.com/seuros/rubocop-trailblazer
https://github.com/seuros/rubocop-trailblazer
code-quality conventions framework linting rubocop rubocop-extension ruby ruby-gem static-analysis trailblazer
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/seuros/rubocop-trailblazer
- Owner: seuros
- License: mit
- Created: 2024-01-09T21:15:04.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-10T00:03:59.000Z (over 2 years ago)
- Last Synced: 2026-05-31T06:06:15.807Z (19 days ago)
- Topics: code-quality, conventions, framework, linting, rubocop, rubocop-extension, ruby, ruby-gem, static-analysis, trailblazer
- Language: Ruby
- Size: 14.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Rubocop::Trailblazer
`Rubocop::Trailblazer` is a Ruby gem that provides additional RuboCop rules that are specifically useful for enforcing best practices and coding styles within projects using the [Trailblazer](http://trailblazer.to/) architecture.
## Installation
Install `rubocop-trailblazer` gem via the following command:
```sh
$ gem install rubocop-trailblazer
```
If you are using this gem within a project, add the following line in your `Gemfile` or `gems.rb` under the development and test groups:
```ruby
group :development, :test do
gem 'rubocop-trailblazer', require: false
end
```
Then run `bundle install` to install the gem.
## Usage
Instruct RuboCop to load the `Rubocop::Trailblazer` extension. Specify this in your `.rubocop.yml`:
```yaml
require:
rubocop-other-extension
rubocop-trailblazer
```
Alternatively, you can specify this in the command line:
```sh
$ rubocop --require rubocop-trailblazer
```
Or in a Rake task:
```ruby
require 'rubocop/rake_task'
RuboCop::RakeTask.new do |task|
task.requires << 'rubocop-trailblazer'
end
```
## Contributing
We welcome contributions! For bug reports, feature requests, and pull requests, please feel free to visit our GitHub at https://github.com/seuros/rubocop-trailblazer.
When submitting a pull request, please ensure your changes are on a separate branch specific to the feature or issue. All updates should include tests.
## License
This gem is open-source, available under the terms of the [MIT License](https://opensource.org/licenses/MIT).