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

Reusable RuboCop configuration for CargoSense's Ruby projects.
https://github.com/cargosense/rubocop-cargosense

rubocop rubocop-configuration ruby rubygem supporting-software

Last synced: 9 months ago
JSON representation

Reusable RuboCop configuration for CargoSense's Ruby projects.

• Host: GitHub
• URL: https://github.com/cargosense/rubocop-cargosense
• Owner: CargoSense
• License: mit
• Created: 2023-12-21T20:09:38.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-09-01T05:48:13.000Z (10 months ago)
• Last Synced: 2025-09-21T13:53:46.920Z (10 months ago)
• Topics: rubocop, rubocop-configuration, ruby, rubygem, supporting-software
• Language: Ruby
• Homepage: https://rubygems.org/gems/rubocop-cargosense
• Size: 228 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# rubocop-cargosense

**Reusable [RuboCop](https://rubocop.org) configuration for [CargoSense](https://www.cargosense.com)'s Ruby projects.**

[![Gem](https://img.shields.io/gem/v/rubocop-cargosense.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/rubocop-cargosense)

[![Downloads](https://img.shields.io/gem/dt/rubocop-cargosense.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/rubocop-cargosense)

[![Build](https://img.shields.io/github/actions/workflow/status/CargoSense/rubocop-cargosense/ci.yml?logo=github&style=for-the-badge)](https://github.com/CargoSense/rubocop-cargosense/actions/workflows/ci.yml)

## Installation

Add rubocop-cargosense to your project's `Gemfile` and run `bundle install`:

```ruby

gem "rubocop-cargosense", require: false

```

## Usage

Include rubocop-cargosense in your project's `.rubocop.yml` using [RuboCop's `plugins` directive](https://docs.rubocop.org/rubocop/extensions.html#loading-extensions):

```yaml

plugins: rubocop-cargosense

```

Or, inherit rubocop-cargosense's default configuration using [RuboCop's `inherit_gem` directive](https://docs.rubocop.org/rubocop/configuration.html#inheriting-configuration-from-a-dependency-gem):

```yaml

inherit_gem:

  rubocop-cargosense: config/default.yml

```

You may also inherit individual configuration files from rubocop-cargosense:

```yaml

inherit_gem:

  rubocop-cargosense:

    - config/rubocop-layout.yml

    - config/rubocop-performance.yml

```

> [!WARNING]

> While the above piecemeal usage is permissible, we recommend requiring the default configuration in its entirety.

## License

rubocop-cargosense is freely available under the [MIT License](https://opensource.org/licenses/MIT).