BenMusch/nu-tab

Checks for a newline after the final magic comment.

Example:

# good
# frozen_string_literal: true
 
# Some documentation for Person
class Person
  # Some code
end
 
# bad
# frozen_string_literal: true
# Some documentation for Person
class Person
  # Some code
end

Checks for a newline after the final magic comment.

Example:

# good
# frozen_string_literal: true
 
# Some documentation for Person
class Person
  # Some code
end
 
# bad
# frozen_string_literal: true
# Some documentation for Person
class Person
  # Some code
end

This cop enforces the consistent usage of %-literal delimiters.

Specify the 'default' key to set all preferred delimiters at once. You can continue to specify individual preferred delimiters to override the default.

Example:

# Style/PercentLiteralDelimiters:
#   PreferredDelimiters:
#     default: '[]'
#     '%i':    '()'
 
# good
%w[alpha beta] + %i(gamma delta)
 
# bad
%W(alpha #{beta})
 
# bad
%I(alpha beta)

Checks for a newline after the final magic comment.

Example:

# good
# frozen_string_literal: true
 
# Some documentation for Person
class Person
  # Some code
end
 
# bad
# frozen_string_literal: true
# Some documentation for Person
class Person
  # Some code
end

Checks for a newline after the final magic comment.

Example:

# good
# frozen_string_literal: true
 
# Some documentation for Person
class Person
  # Some code
end
 
# bad
# frozen_string_literal: true
# Some documentation for Person
class Person
  # Some code
end

This cop can check for array literals made up of symbols that are not using the %i() syntax.

Alternatively, it checks for symbol arrays using the %i() syntax on projects which do not want to use that syntax.

Configuration option: MinSize If set, arrays with fewer elements than this value will not trigger the cop. For example, a MinSize of3` will not enforce a style on an array of 2 or fewer elements.

Example: EnforcedStyle: percent (default)

# good
%i[foo bar baz]
 
# bad
[:foo, :bar, :baz]

Example: EnforcedStyle: brackets

# good
[:foo, :bar, :baz]
 
# bad
%i[foo bar baz]

This cop checks for the formatting of empty method definitions. By default it enforces empty method definitions to go on a single line (compact style), but it can be configured to enforce the end to go on its own line (expanded style).

Note: A method definition is not considered empty if it contains comments.

Example: EnforcedStyle: compact (default)

# bad
def foo(bar)
end
 
def self.foo(bar)
end
 
# good
def foo(bar); end
 
def foo(bar)
  # baz
end
 
def self.foo(bar); end

Example: EnforcedStyle: expanded

# bad
def foo(bar); end
 
def self.foo(bar); end
 
# good
def foo(bar)
end
 
def self.foo(bar)
end

This cop is designed to help upgrade to Ruby 3.0. It will add the comment # frozen_string_literal: true to the top of files to enable frozen string literals. Frozen string literals may be default in Ruby 3.0. The comment will be added below a shebang and encoding comment. The frozen string literal comment is only valid in Ruby 2.3+.

Example: EnforcedStyle: when_needed (default)

# The `when_needed` style will add the frozen string literal comment
# to files only when the `TargetRubyVersion` is set to 2.3+.
# bad
module Foo
  # ...
end
 
# good
# frozen_string_literal: true
 
module Foo
  # ...
end

Example: EnforcedStyle: always

# The `always` style will always add the frozen string literal comment
# to a file, regardless of the Ruby version or if `freeze` or `<<` are
# called on a string literal.
# bad
module Bar
  # ...
end
 
# good
# frozen_string_literal: true
 
module Bar
  # ...
end

Example: EnforcedStyle: never

# The `never` will enforce that the frozen string literal comment does
# not exist in a file.
# bad
# frozen_string_literal: true
 
module Baz
  # ...
end
 
# good
module Baz
  # ...
end

Checks for a newline after the final magic comment.

Example:

# good
# frozen_string_literal: true
 
# Some documentation for Person
class Person
  # Some code
end
 
# bad
# frozen_string_literal: true
# Some documentation for Person
class Person
  # Some code
end

Checks for a newline after the final magic comment.

Example:

# good
# frozen_string_literal: true
 
# Some documentation for Person
class Person
  # Some code
end
 
# bad
# frozen_string_literal: true
# Some documentation for Person
class Person
  # Some code
end

This cop is designed to help upgrade to Ruby 3.0. It will add the comment # frozen_string_literal: true to the top of files to enable frozen string literals. Frozen string literals may be default in Ruby 3.0. The comment will be added below a shebang and encoding comment. The frozen string literal comment is only valid in Ruby 2.3+.

Example: EnforcedStyle: when_needed (default)

# The `when_needed` style will add the frozen string literal comment
# to files only when the `TargetRubyVersion` is set to 2.3+.
# bad
module Foo
  # ...
end
 
# good
# frozen_string_literal: true
 
module Foo
  # ...
end

Example: EnforcedStyle: always

# The `always` style will always add the frozen string literal comment
# to a file, regardless of the Ruby version or if `freeze` or `<<` are
# called on a string literal.
# bad
module Bar
  # ...
end
 
# good
# frozen_string_literal: true
 
module Bar
  # ...
end

Example: EnforcedStyle: never

# The `never` will enforce that the frozen string literal comment does
# not exist in a file.
# bad
# frozen_string_literal: true
 
module Baz
  # ...
end
 
# good
module Baz
  # ...
end

Access modifiers should be surrounded by blank lines.

Example:

# bad
class Foo
  def bar; end
  private
  def baz; end
end
 
# good
class Foo
  def bar; end
 
  private
 
  def baz; end
end

This cop checks for the formatting of empty method definitions. By default it enforces empty method definitions to go on a single line (compact style), but it can be configured to enforce the end to go on its own line (expanded style).

Note: A method definition is not considered empty if it contains comments.

Example: EnforcedStyle: compact (default)

# bad
def foo(bar)
end
 
def self.foo(bar)
end
 
# good
def foo(bar); end
 
def foo(bar)
  # baz
end
 
def self.foo(bar); end

Example: EnforcedStyle: expanded

# bad
def foo(bar); end
 
def self.foo(bar); end
 
# good
def foo(bar)
end
 
def self.foo(bar)
end

This cop checks the indentation of the method name part in method calls that span more than one line.

Example: EnforcedStyle: aligned

# bad
while myvariable
.b
  # do something
end
 
# good
while myvariable
      .b
  # do something
end
 
# good
Thing.a
     .b
     .c

Example: EnforcedStyle: indented

# good
while myvariable
  .b
 
  # do something
end

Example: EnforcedStyle: indentedrelativeto_receiver

# good
while myvariable
        .a
        .b
 
  # do something
end
 
# good
myvariable = Thing
               .a
               .b
               .c

Checks if uses of quotes match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"
 
# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

Example: EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'
 
# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"