A RuboCop extension to enforce common code style in Jekyll and Jekyll plugins.
Just install the
gem install rubocop-jekyll
or if you prefer Bundler, add it to your
# Gemfile gem "rubocop-jekyll", "~> 0.10.0"
# <plugin>.gemspec spec.add_development_dependency "rubocop-jekyll", "~> 0.10.0"
You need to tell RuboCop to load the extension and inherit the custom RuboCop configuration advocated by Jekyll.
Place the following at the top of your
require: rubocop-jekyll inherit_gem: rubocop-jekyll: .rubocop.yml
bundle exec rubocop will now automatically load the
rubocop-jekyll cops together with the standard cops.
You can override any settings inherited from the extension by subsequently redefining the concerned parameters.
A new release of this gem is manually cut based on the adoption of the latest version of RuboCop by the Jekyll repository:
- RuboCop releases a new version.
masterbranch of Jekyll repository is updated to the latest RuboCop version along with any updates to their
- The RuboCop version and
.rubocop.ymlat this gem's repository is updated via a pull request.
- A new minor release is subsequently cut and shipped.
Note: A patch version of this gem will be released if Jekyll repository updates their
.rubocop.yml independently of
a RuboCop version bump.