gitlab-styles 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a19ea1a58af0f1003976693c7a0a9d426819d12
-  data.tar.gz: '0963b84173710161b30e7d4606ca8c2947b61e47'
+  metadata.gz: 7a42799e70b411a155cfd1c8560070ec9d392b27
+  data.tar.gz: ff2d1e7abf77741598dd6b3daf7ae72ac070c01e
 SHA512:
-  metadata.gz: 8043c785a50c1df883fc1d6f20a3a765e57a59e9d21c1454a3afacf5fa28befb823c53ebb01d24aaad97726436ea28dda5a53af6976cfa282b4611c5c6a02229
-  data.tar.gz: '09d9b3dc0d274b6536bdde93bf4efcded2a998a63033d2d37a9297b241d4a7e355eea421d5ed73a01a8d8991c460a40849fe2b5b4e2b4e0c5e89d37b315b1f04'
+  metadata.gz: 062e71d3c7368f5b579a2f310d30d5fcdf9e7cfaf5c5a0b1ebea68745ea39dd15c8f470c30292119a37ce0bc95704a7337e0d715792fd5772ba53d7bef4213e5
+  data.tar.gz: 16be6ea7882ca778c10fea2710f795c021aae30a3cfb7f32fc9f1da8ad91c8eb4c8dd457d97977c6f68cfb7cf70876ef153420cc0f1e3c1331597753fb37ad8c

data/.rubocop.yml

@@ -1 +1 @@
-inherit_from: default.yml
+inherit_from: rubocop-default.yml

data/README.md

@@ -1,15 +1,14 @@
-# Gitlab::Rubocop
+# Gitlab::Styles
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gitlab/rubocop`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+`Gitlab::Styles` centralizes some shared GitLab's styles config (only RuboCop
+for now), as well as custom RuboCop cops.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'gitlab-rubocop'
+gem 'gitlab-styles', require: false
 ```
 
 And then execute:
@@ -18,26 +17,46 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install gitlab-rubocop
+    $ gem install gitlab-styles
 
 ## Usage
 
-TODO: Write usage instructions here
+### RuboCop
+
+Include the following in your `.rubocop.yml` and remove all the rules that are
+already in `rubocop-default.yml`:
+
+```yaml
+inherit_gem:
+  gitlab-rubocop:
+    - rubocop-default.yml
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gitlab-rubocop. 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.
+Bug reports and merge requests are welcome on GitLab at
+https://gitlab.com/gitlab-org/gitlab-styles. 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.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Gitlab::Rubocop project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gitlab-rubocop/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the `Gitlab::Styles` project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://gitlab.com/gitlab-org/gitlab-styles/blob/master/CODE_OF_CONDUCT.md).

data/lib/gitlab/styles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Styles
-    VERSION = '0.1.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/{default.yml → rubocop-default.yml}

@@ -254,12 +254,59 @@ Layout/TrailingBlankLines:
 Layout/TrailingWhitespace:
   Enabled: true
 
-# Style #######################################################################
+# Naming ######################################################################
 
 # Check the naming of accessor methods for get_/set_.
-Style/AccessorMethodName:
+Naming/AccessorMethodName:
   Enabled: false
 
+# Use only ascii symbols in identifiers.
+Naming/AsciiIdentifiers:
+  Enabled: true
+
+# When defining binary operators, name the argument other.
+Naming/BinaryOperatorParameterName:
+  Enabled: true
+
+# Use CamelCase for classes and modules.'
+Naming/ClassAndModuleCamelCase:
+  Enabled: true
+
+# Constants should use SCREAMING_SNAKE_CASE.
+Naming/ConstantName:
+  Enabled: true
+
+# Use snake_case for source file names.
+Naming/FileName:
+  Enabled: true
+
+# Use the configured style when naming methods.
+Naming/MethodName:
+  Enabled: true
+
+# Use `spam?` instead of `is_spam?`
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+Naming/PredicateName:
+  Enabled: true
+  NamePrefixBlacklist: is_
+  Exclude:
+    - 'spec/**/*'
+    - 'features/**/*'
+
+# Use the configured style when naming variables.
+Naming/VariableName:
+  EnforcedStyle: snake_case
+  Enabled: true
+
+# Use the configured style when numbering variables.
+Naming/VariableNumber:
+  Enabled: false
+
+# Style #######################################################################
+
 # Use alias_method instead of alias.
 Style/Alias:
   EnforcedStyle: prefer_alias_method
@@ -278,10 +325,6 @@ Style/ArrayJoin:
 Style/AsciiComments:
   Enabled: true
 
-# Use only ascii symbols in identifiers.
-Style/AsciiIdentifiers:
-  Enabled: true
-
 # Checks for uses of Module#attr.
 Style/Attr:
   Enabled: true
@@ -312,10 +355,6 @@ Style/CaseEquality:
 Style/CharacterLiteral:
   Enabled: true
 
-# Use CamelCase for classes and modules.'
-Style/ClassAndModuleCamelCase:
-  Enabled: true
-
 # Checks style of children classes and modules.
 Style/ClassAndModuleChildren:
   Enabled: false
@@ -348,10 +387,6 @@ Style/CommentAnnotation:
 Style/ConditionalAssignment:
   Enabled: true
 
-# Constants should use SCREAMING_SNAKE_CASE.
-Style/ConstantName:
-  Enabled: true
-
 # Use def with parentheses when there are arguments.
 Style/DefWithParentheses:
   Enabled: true
@@ -374,10 +409,6 @@ Style/EndBlock:
 Style/EvenOdd:
   Enabled: true
 
-# Use snake_case for source file names.
-Style/FileName:
-  Enabled: true
-
 # Checks for flip flops.
 Style/FlipFlop:
   Enabled: true
@@ -432,10 +463,6 @@ Style/LambdaCall:
 Style/MethodDefParentheses:
   Enabled: true
 
-# Use the configured style when naming methods.
-Style/MethodName:
-  Enabled: true
-
 # Checks for usage of `extend self` in modules.
 Style/ModuleFunction:
   Enabled: false
@@ -498,10 +525,6 @@ Style/NumericLiterals:
 Style/OneLineConditional:
   Enabled: true
 
-# When defining binary operators, name the argument other.
-Naming/BinaryOperatorParameterName:
-  Enabled: true
-
 # Don't use parentheses around the condition of an if/unless/while.
 Style/ParenthesesAroundCondition:
   Enabled: true
@@ -573,15 +596,6 @@ Style/UnneededPercentQ:
 Style/VariableInterpolation:
   Enabled: true
 
-# Use the configured style when naming variables.
-Style/VariableName:
-  EnforcedStyle: snake_case
-  Enabled: true
-
-# Use the configured style when numbering variables.
-Style/VariableNumber:
-  Enabled: false
-
 # Use when x then ... for one-line cases.
 Style/WhenThen:
   Enabled: true
@@ -606,18 +620,6 @@ Style/YodaCondition:
 Style/Proc:
   Enabled: true
 
-# Use `spam?` instead of `is_spam?`
-# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
-# NamePrefix: is_, has_, have_
-# NamePrefixBlacklist: is_, has_, have_
-# NameWhitelist: is_a?
-Style/PredicateName:
-  Enabled: true
-  NamePrefixBlacklist: is_
-  Exclude:
-    - 'spec/**/*'
-    - 'features/**/*'
-
 # Metrics #####################################################################
 
 # A calculated magnitude based on number of assignments,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-styles
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - GitLab
@@ -112,7 +112,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- default.yml
 - gitlab-styles.gemspec
 - lib/gitlab/styles.rb
 - lib/gitlab/styles/rubocop.rb
@@ -142,6 +141,7 @@ files:
 - lib/gitlab/styles/rubocop/migration_helpers.rb
 - lib/gitlab/styles/rubocop/model_helpers.rb
 - lib/gitlab/styles/version.rb
+- rubocop-default.yml
 homepage: https://github.com/gitlab-org/gitlab-styles
 licenses:
 - MIT