- Notifications
You must be signed in to change notification settings - Fork0
Shared, minimal rubocop config
License
nxt-insurance/nxt_cop
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Getsafe shared Rubocop Config.
Add this line to your application's Gemfile:
group:test,:developmentdogem'nxt_cop'end
Or, for a Ruby library, add this to your gemspec:
spec.add_development_dependency'nxt_cop'
And then run:
$ bundle install
Create a.rubocop.yml
with the following directives:
inherit_gem:nxt_cop: -default.yml
Now, run:
$ bundleexec rubocop
You do not need to include rubocop directly in your application's dependencies. nxt_cop will include a specific version ofrubocop
that is shared across all projects.
It is also possible to override styles or add styles to your application.
NOTE: Don't configureAllCops
as it will override many of the rules in this gem.
inherit_gem: nxt_cop: - default.ymlLint/Style: Exclude: - db/schema.rb - db/migrate/*.rb
After checking out the repo, runbin/setup
to install dependencies. Then, runrake spec
to run the tests. You can also runbin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, runbundle exec rake install
.
bundle configset gem.push_key rubygems
Add to~/.gem/credentials
(create if it doesn't exist):
:rubygems:<your Rubygems API key>
- Merge all Depfu updates
- Run
bundle install
to update dependencies - Run
rubocop
to see if new rules were added- If yes, add them to
default.yml
to prevent "New rules" warning
- If yes, add them to
- Update the version number in
version.rb
- Run
bundle install
again to update the version in Gemfile.lock - Update the
CHANGELOG.md
- Open the PR, merge everything to
main
Once PR is merged, switch to main and runbundle exec rake release
which will create a git tag for the version, push git commits and tags, and push the.gem
file torubygems.org.
Bug reports and pull requests are welcome on GitHub athttps://github.com/nxt-insurance/nxt_cop.
The gem is available as open source under the terms of theMIT License.
About
Shared, minimal rubocop config