Skip to content

Commit

Permalink
Add more inline comments/documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jgarber623-cargosense committed Jan 8, 2024
1 parent 878dbb1 commit 1d966a2
Show file tree
Hide file tree
Showing 8 changed files with 43 additions and 0 deletions.
5 changes: 5 additions & 0 deletions config/rubocop-layout.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Layout cops inspect your code for consistent use of indentation, alignment,
# and white space.
#
# @see https://docs.rubocop.org/rubocop/cops_layout.html

Layout/ClassStructure:
Enabled: true
ExpectedOrder:
Expand Down
4 changes: 4 additions & 0 deletions config/rubocop-lint.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
# Lint cops check for ambiguities and possible errors in your code.
#
# @see https://docs.rubocop.org/rubocop/cops_lint.html

Lint/HeredocMethodCallPosition:
Enabled: true
5 changes: 5 additions & 0 deletions config/rubocop-metrics.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Metrics cops deal with properties of the source code that can be measured,
# such as class length, method length, etc.
#
# @see https://docs.rubocop.org/rubocop/cops_metrics.html

Metrics/BlockLength:
CountAsOne:
- array
Expand Down
5 changes: 5 additions & 0 deletions config/rubocop-naming.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Naming cops check for naming issue of your code, such as method name, constant
# name, file name, etc.
#
# @see https://docs.rubocop.org/rubocop/cops_naming.html

Naming/InclusiveLanguage:
Enabled: true

Expand Down
7 changes: 7 additions & 0 deletions config/rubocop-performance.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# A collection of RuboCop cops to check for performance optimizations in Ruby
# code.
#
# @see https://rubygems.org/gems/rubocop-performance
# @see https://docs.rubocop.org/rubocop-performance
# @see https://github.com/rubocop/rubocop-performance

require: rubocop-performance

Performance/ChainArrayAllocation:
Expand Down
5 changes: 5 additions & 0 deletions config/rubocop-rake.yml
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
# A RuboCop plugin for Rake.
#
# @see https://rubygems.org/gems/rubocop-rake
# @see https://github.com/rubocop/rubocop-rake

require: rubocop-rake
5 changes: 5 additions & 0 deletions config/rubocop-style.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Style cops check for stylistic consistency of your code. Many of the them are
# based on the Ruby Style Guide.
#
# @see https://docs.rubocop.org/rubocop/cops_style.html

Style/ArrayCoercion:
Enabled: true

Expand Down
7 changes: 7 additions & 0 deletions config/rubocop.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# RuboCop is a Ruby code style checking and code formatting tool. It aims to
# enforce the community-driven Ruby Style Guide.
#
# @see https://rubygems.org/gems/rubocop
# @see https://docs.rubocop.org/rubocop
# @see https://github.com/rubocop/rubocop

inherit_from:
- ./rubocop-layout.yml
- ./rubocop-lint.yml
Expand Down

0 comments on commit 1d966a2

Please sign in to comment.