Git Product home page Git Product logo

rubocop-commsworld's Introduction

rubocop-commsworld

Common rubocop configuration and custom cops. Replaces commsworld/house-style which was config-only.

Installation

Add the gem as a dependency to your project's Gemfile:

gem "rubocop-commsworld", github: "commsworld/rubocop-commsworld", group: [:development, :test]

And install with bundle install.

Usage

Configure rubocop in your project by creating a file in the root directory of the project, .rubocop.yml:

require:
  - rubocop-commsworld
  - rubocop-rails
  - rubocop-rspec

Cops

Commsworld/UnspecifiedModelPrivacy

Issues an offence when a class is defined within a module which does not have an adjacent privacy definition. By default, configured to only run on app/models.

The motivation is to enforce the use of Private ActiveRecord models where appropriate.

# bad
module Things
  class Thing < ApplicationRecord
  end
end

# good
module Things
  class Thing < ApplicationRecord
  end

  private_constant :Thing # or public_constant
end

License

The gem is available as open source under the terms of the [MIT License].

rubocop-commsworld's People

Contributors

lewiseason avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.