An open API service indexing awesome lists of open source software.

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

Default Rubocop configuration used in NoSoloSoftware developments
https://github.com/nosolosoftware/rubocop-nosolosoftware

nosolosoftware rails rubocop rubocop-configuration ruby rules

Last synced: 10 months ago
JSON representation

Default Rubocop configuration used in NoSoloSoftware developments

Awesome Lists containing this project

README

          

# rubocop-nosolosoftware ![Gem](https://img.shields.io/gem/v/rubocop-nosolosoftware.svg)

Common Rubocop config for all our projects.

Please if you are using `rubocop < 1.0` use the branch [0.x](https://github.com/nosolosoftware/rubocop-nosolosoftware/tree/0.x) and `rubocop-nosolosoftware < 1.0`.

## Installation

Add this line to your application's `Gemfile`:

```ruby
gem 'rubocop-nosolosoftware', require: false
```

And then execute:

```bash
$ bundle
```

Or install it yourself as:

```bash
$ gem install rubocop-nosolosoftware
```

## Usage

Include the following in your `.rubocop.yml`

**For Ruby**:

```yaml
inherit_gem:
rubocop-nosolosoftware: rubocop-default.yml
```

**For Rails**:

```yaml
inherit_gem:
rubocop-nosolosoftware:
- rubocop-default.yml
- rubocop-rails.yml
```

**Optional Rake, Faker and Rspec rules**:

```yaml
inherit_gem:
rubocop-nosolosoftware:
- rubocop-default.yml
- rubocop-rails.yml
- rubocop-rake.yml
- rubocop-rspec.yml
- rubocop-faker.yml
```

**For Mongoid projects**:

```yaml
inherit_gem:
rubocop-nosolosoftware:
- rubocop-default.yml
- rubocop-rails.yml
- rubocop-rake.yml
- rubocop-rspec.yml
- rubocop-faker.yml
- rubocop-mongoid.yml
```

### Inheritance of array attributes

Don't forget to include the following in your configuration file:

```yaml
inherit_mode:
merge:
- Exclude
- Prefixes
```

## Contributing

Bug reports and merge requests are welcome on Github at
https://github.com/nosolosoftware/rubocop-nosolosoftware using
[GitHub Flow](https://guides.github.com/introduction/flow/index.html). This project is intended to
be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
[Contributor Covenant](http://contributor-covenant.org) code of conduct.

## Versioning

**rubocop-nosolosoftware** uses [Semantic Versioning 2.0.0](http://semver.org)

## License

Copyright (c) 2019-2020 NoSoloSoftware Network S.L. - Released under [MIT](LICENSE) license.