Use empty lines between class definitions. Open
class Favourite < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use empty lines between class definitions. Open
class Follow < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use empty lines between class definitions. Open
class FollowRequest < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Redundant begin
block detected. Open
begin
- Read upRead up
- Exclude checks
This cop checks for redundant begin
blocks.
Currently it checks for code like this:
Example:
# bad
def redundant
begin
ala
bala
rescue StandardError => e
something
end
end
# good
def preferred
ala
bala
rescue StandardError => e
something
end
# bad
begin
do_something
end
# good
do_something
# bad
# When using Ruby 2.5 or later.
do_something do
begin
something
rescue => ex
anything
end
end
# good
# In Ruby 2.5 or later, you can omit `begin` in `do-end` block.
do_something do
something
rescue => ex
anything
end
# good
# Stabby lambdas don't support implicit `begin` in `do-end` blocks.
-> do
begin
foo
rescue Bar
baz
end
end
Use empty lines between class definitions. Open
class Tombstone < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use empty lines between class definitions. Open
class Mute < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use empty lines between class definitions. Open
class AccountModerationNote < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use underscores(_) as thousands separator and separate every 3 digits with them. Open
Scenic.database.refresh_materialized_view('instances', concurrently: true, cascade: false) if ActiveRecord::Migrator.current_version >= 2020_12_06_004238
- Read upRead up
- Exclude checks
This cop checks for big numeric literals without _ between groups of digits in them.
Example:
# bad
1000000
1_00_000
1_0000
# good
1_000_000
1000
Example: Strict: false (default)
# good
10_000_00 # typical representation of $10,000 in cents
Example: Strict: true
# bad
10_000_00 # typical representation of $10,000 in cents
Use empty lines between class definitions. Open
class PollVote < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use empty lines between class definitions. Open
class CustomEmoji < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Redundant begin
block detected. Open
begin
- Read upRead up
- Exclude checks
This cop checks for redundant begin
blocks.
Currently it checks for code like this:
Example:
# bad
def redundant
begin
ala
bala
rescue StandardError => e
something
end
end
# good
def preferred
ala
bala
rescue StandardError => e
something
end
# bad
begin
do_something
end
# good
do_something
# bad
# When using Ruby 2.5 or later.
do_something do
begin
something
rescue => ex
anything
end
end
# good
# In Ruby 2.5 or later, you can omit `begin` in `do-end` block.
do_something do
something
rescue => ex
anything
end
# good
# Stabby lambdas don't support implicit `begin` in `do-end` blocks.
-> do
begin
foo
rescue Bar
baz
end
end
Use empty lines between class definitions. Open
class Report < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use underscores(_) as thousands separator and separate every 3 digits with them. Open
MIN_SUPPORTED_VERSION = 2019_10_01_213028
- Read upRead up
- Exclude checks
This cop checks for big numeric literals without _ between groups of digits in them.
Example:
# bad
1000000
1_00_000
1_0000
# good
1_000_000
1000
Example: Strict: false (default)
# good
10_000_00 # typical representation of $10,000 in cents
Example: Strict: true
# bad
10_000_00 # typical representation of $10,000 in cents
Use empty lines between class definitions. Open
class AccountDomainBlock < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use empty lines between class definitions. Open
class WebauthnCredential < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use underscores(_) as thousands separator and separate every 3 digits with them. Open
MAX_SUPPORTED_VERSION = 2020_12_18_054746
- Read upRead up
- Exclude checks
This cop checks for big numeric literals without _ between groups of digits in them.
Example:
# bad
1000000
1_00_000
1_0000
# good
1_000_000
1000
Example: Strict: false (default)
# good
10_000_00 # typical representation of $10,000 in cents
Example: Strict: true
# bad
10_000_00 # typical representation of $10,000 in cents
Redundant begin
block detected. Open
begin
- Read upRead up
- Exclude checks
This cop checks for redundant begin
blocks.
Currently it checks for code like this:
Example:
# bad
def redundant
begin
ala
bala
rescue StandardError => e
something
end
end
# good
def preferred
ala
bala
rescue StandardError => e
something
end
# bad
begin
do_something
end
# good
do_something
# bad
# When using Ruby 2.5 or later.
do_something do
begin
something
rescue => ex
anything
end
end
# good
# In Ruby 2.5 or later, you can omit `begin` in `do-end` block.
do_something do
something
rescue => ex
anything
end
# good
# Stabby lambdas don't support implicit `begin` in `do-end` blocks.
-> do
begin
foo
rescue Bar
baz
end
end
Use empty lines between class definitions. Open
class AccountPin < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Redundant begin
block detected. Open
begin
- Read upRead up
- Exclude checks
This cop checks for redundant begin
blocks.
Currently it checks for code like this:
Example:
# bad
def redundant
begin
ala
bala
rescue StandardError => e
something
end
end
# good
def preferred
ala
bala
rescue StandardError => e
something
end
# bad
begin
do_something
end
# good
do_something
# bad
# When using Ruby 2.5 or later.
do_something do
begin
something
rescue => ex
anything
end
end
# good
# In Ruby 2.5 or later, you can omit `begin` in `do-end` block.
do_something do
something
rescue => ex
anything
end
# good
# Stabby lambdas don't support implicit `begin` in `do-end` blocks.
-> do
begin
foo
rescue Bar
baz
end
end
Use underscores(_) as thousands separator and separate every 3 digits with them. Open
if ActiveRecord::Migrator.current_version < 20200620164023
- Read upRead up
- Exclude checks
This cop checks for big numeric literals without _ between groups of digits in them.
Example:
# bad
1000000
1_00_000
1_0000
# good
1_000_000
1000
Example: Strict: false (default)
# good
10_000_00 # typical representation of $10,000 in cents
Example: Strict: true
# bad
10_000_00 # typical representation of $10,000 in cents
Redundant begin
block detected. Open
begin
- Read upRead up
- Exclude checks
This cop checks for redundant begin
blocks.
Currently it checks for code like this:
Example:
# bad
def redundant
begin
ala
bala
rescue StandardError => e
something
end
end
# good
def preferred
ala
bala
rescue StandardError => e
something
end
# bad
begin
do_something
end
# good
do_something
# bad
# When using Ruby 2.5 or later.
do_something do
begin
something
rescue => ex
anything
end
end
# good
# In Ruby 2.5 or later, you can omit `begin` in `do-end` block.
do_something do
something
rescue => ex
anything
end
# good
# Stabby lambdas don't support implicit `begin` in `do-end` blocks.
-> do
begin
foo
rescue Bar
baz
end
end
Use empty lines between class definitions. Open
class Mention < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use empty lines between class definitions. Open
class CustomEmojiCategory < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use empty lines between class definitions. Open
class StatusPin < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use empty lines between class definitions. Open
class Poll < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use empty lines between class definitions. Open
class AccountIdentityProof < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use empty lines between class definitions. Open
class ListAccount < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use empty lines between class definitions. Open
class AnnouncementReaction < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Redundant begin
block detected. Open
begin
- Read upRead up
- Exclude checks
This cop checks for redundant begin
blocks.
Currently it checks for code like this:
Example:
# bad
def redundant
begin
ala
bala
rescue StandardError => e
something
end
end
# good
def preferred
ala
bala
rescue StandardError => e
something
end
# bad
begin
do_something
end
# good
do_something
# bad
# When using Ruby 2.5 or later.
do_something do
begin
something
rescue => ex
anything
end
end
# good
# In Ruby 2.5 or later, you can omit `begin` in `do-end` block.
do_something do
something
rescue => ex
anything
end
# good
# Stabby lambdas don't support implicit `begin` in `do-end` blocks.
-> do
begin
foo
rescue Bar
baz
end
end
Redundant begin
block detected. Open
begin
- Read upRead up
- Exclude checks
This cop checks for redundant begin
blocks.
Currently it checks for code like this:
Example:
# bad
def redundant
begin
ala
bala
rescue StandardError => e
something
end
end
# good
def preferred
ala
bala
rescue StandardError => e
something
end
# bad
begin
do_something
end
# good
do_something
# bad
# When using Ruby 2.5 or later.
do_something do
begin
something
rescue => ex
anything
end
end
# good
# In Ruby 2.5 or later, you can omit `begin` in `do-end` block.
do_something do
something
rescue => ex
anything
end
# good
# Stabby lambdas don't support implicit `begin` in `do-end` blocks.
-> do
begin
foo
rescue Bar
baz
end
end
Use empty lines between class definitions. Open
class Block < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use empty lines between class definitions. Open
class FeaturedTag < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Use empty lines between class definitions. Open
class Bookmark < ApplicationRecord; end
- Read upRead up
- Exclude checks
This cop checks whether class/module/method definitions are separated by one or more empty lines.
NumberOfEmptyLines
can be an integer (default is 1) or
an array (e.g. [1, 2]) to specify a minimum and maximum
number of empty lines permitted.
AllowAdjacentOneLineDefs
configures whether adjacent
one-line definitions are considered an offense.
Example: EmptyLineBetweenMethodDefs: true (default)
# checks for empty lines between method definitions.
# bad
def a
end
def b
end
Example:
# good
def a
end
def b
end
Example: EmptyLineBetweenClassDefs: true (default)
# checks for empty lines between class definitions.
# bad
class A
end
class B
end
def b
end
Example:
# good
class A
end
class B
end
def b
end
Example: EmptyLineBetweenModuleDefs: true (default)
# checks for empty lines between module definitions.
# bad
module A
end
module B
end
def b
end
Example:
# good
module A
end
module B
end
def b
end
Example: AllowAdjacentOneLineDefs: true
# good
class ErrorA < BaseError; end
class ErrorB < BaseError; end
class ErrorC < BaseError; end
Redundant begin
block detected. Open
begin
- Read upRead up
- Exclude checks
This cop checks for redundant begin
blocks.
Currently it checks for code like this:
Example:
# bad
def redundant
begin
ala
bala
rescue StandardError => e
something
end
end
# good
def preferred
ala
bala
rescue StandardError => e
something
end
# bad
begin
do_something
end
# good
do_something
# bad
# When using Ruby 2.5 or later.
do_something do
begin
something
rescue => ex
anything
end
end
# good
# In Ruby 2.5 or later, you can omit `begin` in `do-end` block.
do_something do
something
rescue => ex
anything
end
# good
# Stabby lambdas don't support implicit `begin` in `do-end` blocks.
-> do
begin
foo
rescue Bar
baz
end
end