Merge pull request #23 from tablexi/update_rubocop_defaults

Update rubocop defaults

Author: benlinton

README.md

@@ -61,7 +61,7 @@ For detailed instructions on the rubocop generator and its options, [check out t
 
 ### Generator: Unicorn
 
-    bundle exec rails g tablexi_dev:rubocop
+    bundle exec rails g tablexi_dev:unicorn
 
 The unicorn generator sets up a project's unicorn configuration files.
 

lib/generators/tablexi_dev/rubocop_generator/files/dot_rubocop-txi.yml

@@ -3,17 +3,41 @@
 # You should NOT make any changes to this file, as it will be overwritten
 # the next time we update the tablexi_dev-generators gem and run
 # `rails generate tablexi_dev:rubocop`
+#
+# Please keep cops in alphabetical order so they're easy to find/scan.
 AllCops:
   DisplayCopNames: true
   Exclude:
-    - "db/schema.rb" # You can't touch this
     - ".bundle/**/*" # Auto-generated
     - "bin/**/*"     # Auto-generated
+    - "db/schema.rb" # You can't touch this
     - "vendor/**/*"  # We cannot solve the world's problems
   TargetRubyVersion: 2.4
   TargetRailsVersion: 5.1
-Rails:
-  Enabled: true
+
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    # These are naturally DSL-y, and so let's be lenient.
+    - "lib/tasks/*.rake"
+    - "spec/**/*"
+
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+  Exclude:
+    - "db/**/*" # Migrations are compact by default, and it's not worth the wrestle.
+
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines
+
+Layout/ExtraSpacing:
+  Exclude:
+    - "db/migrate/*" # Generated migrations often have extra spacing
+
+Layout/SpaceBeforeFirstArg:
+  Exclude:
+    # We often add extra spaces for alignment in factories.
+    - "db/migrate/*" # We often add extra spaces for alignment in migrations.
+    - "spec/factories/**/*"
 
 Lint/HandleExceptions:
   Exclude:
@@ -24,55 +48,52 @@ Metrics/AbcSize:
   Exclude:
     - "db/**/*" # Sometimes migrations are complex.
 
+Metrics/BlockLength:
+  Exclude:
+    # These are naturally DSL-y, and so let's be lenient.
+    - "config/routes.rb"
+    - "db/seeds/**/*"
+    - "spec/**/*"
+
 Metrics/LineLength:
   Max: 120
+  Exclude:
+    - "config/initializers/**/*" # Some generated initializers are long.
 
 Metrics/MethodLength:
   Max: 20
   Exclude:
     - "db/**/*" # Again, sometimes DB migrations are long.
 
-Metrics/BlockLength:
-  Exclude:
-    # These are naturally DSL-y, and so let's be lenient.
-    - "spec/**/*"
-    - "config/routes.rb"
+Rails:
+  Enabled: true
 
-Style/ClassAndModuleChildren:
+Rails/ApplicationRecord:
   Exclude:
-    - "app/controllers/**/*" # We generally use compact style here
+    - "db/**/*" # Migrations should be isolated, models defined there should NOT inherit from ApplicationRecord
 
-Style/Documentation:
+Rails/Output:
   Exclude:
-    - "db/**/*" # No need to require migrations to be documented.
+    - "db/seeds/**/*" # Allow `puts` from inside seed files
 
-Layout/EmptyLinesAroundBlockBody:
-  Exclude:
-    # These are naturally DSL-y, and so let's be lenient.
-    - "spec/**/*"
-    - "lib/tasks/*.rake"
+Rails/UnknownEnv:
+  Environments:
+    - development
+    - production
+    - stage
+    - test
 
-Layout/EmptyLinesAroundClassBody:
-  EnforcedStyle: empty_lines
+Style/ClassAndModuleChildren:
   Exclude:
-    - "db/**/*" # Migrations are compact by default, and it's not worth the wrestle.
-
-Layout/EmptyLinesAroundModuleBody:
-  EnforcedStyle: empty_lines
+    - "app/controllers/**/*" # We generally use compact style here
 
-Layout/ExtraSpacing:
+Style/Documentation:
   Exclude:
-    - "db/migrate/*" # Generated migrations often have extra spacing
+    - "db/**/*" # No need to require migrations to be documented.
 
 Style/SignalException:
   EnforcedStyle: only_raise
 
-Layout/SpaceBeforeFirstArg:
-  Exclude:
-    # We often add extra spaces for alignment in factories.
-    - "spec/factories/**/*"
-    - "db/migrate/*" # We often add extra spaces for alignment in migrations.
-
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
@@ -87,14 +108,3 @@ Style/TrailingCommaInHashLiteral:
 
 Style/TrivialAccessors:
   ExactNameMatch: true
-
-Rails/UnknownEnv:
-  Environments:
-    - production
-    - development
-    - test
-    - stage
-
-Rails/ApplicationRecord:
-  Exclude:
-    - "db/**/*" # Migrations should be isolated, models defined there should NOT inherit from ApplicationRecord