https://github.com/jekyll/rubocop-jekyll

A RuboCop extension to enforce common code style in Jekyll and Jekyll plugins
https://github.com/jekyll/rubocop-jekyll

Last synced: 4 months ago
JSON representation

A RuboCop extension to enforce common code style in Jekyll and Jekyll plugins

• Host: GitHub
• URL: https://github.com/jekyll/rubocop-jekyll
• Owner: jekyll
• License: mit
• Created: 2018-07-15T14:59:53.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-24T11:07:29.000Z (about 1 year ago)
• Last Synced: 2025-01-29T13:11:23.875Z (12 months ago)
• Language: Ruby
• Size: 46.9 KB
• Stars: 9
• Watchers: 6
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: History.markdown
  • License: LICENSE

Awesome Lists containing this project

README

          
# RuboCop Jekyll

A RuboCop extension to enforce common code style in Jekyll and Jekyll plugins.

[![Gem Version](https://img.shields.io/gem/v/rubocop-jekyll.svg?label=Latest%20Release&labelColor=000000&style=for-the-badge&logo=rubygems&logoColor=white&color=E9573F)][rubygems]

[![RuboCop Support](https://img.shields.io/badge/RuboCop%20Support-1.57.x-AA0000.svg?style=for-the-badge&labelColor=000000&logo=rubocop)][rubocop-releases]

![Targeted Ruby Version](https://img.shields.io/badge/Targeted%20Ruby%20Version-2.7.x-CC342D.svg?style=for-the-badge&labelColor=000000&logo=ruby)

[rubygems]: https://rubygems.org/gems/rubocop-jekyll

[rubocop-releases]: https://github.com/rubocop-hq/rubocop/releases

## Installation

Just install the `rubocop-jekyll` gem

```

gem install rubocop-jekyll

```

or if you prefer Bundler, add it to your `Gemfile` or `gemspec`

```ruby

# Gemfile

gem "rubocop-jekyll", "~> 0.14.0"

```

```ruby

# .gemspec

spec.add_development_dependency "rubocop-jekyll", "~> 0.14.0"

```

and run `bundle install`

## Usage

You need to tell RuboCop to load the extension and *inherit* the custom RuboCop configuration advocated by

[Jekyll](https://github.com/jekyll).

Place the following at the top of your `.rubocop.yml`.

```yaml

require: rubocop-jekyll

inherit_gem:

  rubocop-jekyll: .rubocop.yml

```

Running `bundle exec rubocop` will now automatically load the `rubocop-jekyll` cops together with the standard cops.

## Customization

You can override any settings inherited from the extension by subsequently redefining the concerned parameters.

## Release Cycle

A new release of this gem is cut based on the adoption of the latest version of RuboCop by the [Jekyll repository](https://github.com/jekyll/jekyll):

  1. RuboCop releases a new version.

  2. The `master` branch of Jekyll repository is updated to the latest RuboCop version along with any updates to their `.rubocop.yml`.

  3. The RuboCop version, and `.rubocop.yml` at this gem's repository is updated **via a pull request**.

  4. Files `lib/rubocop-jekyll/version.rb` and `README.md` at this gem's repository is updated **via a pull request**.

  5. A new minor release is subsequently cut and automatically shipped via GitHub Actions.

*Note: A patch version of this gem will be released if Jekyll repository updates their `.rubocop.yml` independently of

a RuboCop version bump.*