hovancik/BSDSec

Checks whether comments have a leading space after the # denoting the start of the comment. The leading space is not required for some RDoc special syntax, like #++, #--, #:nodoc, =begin- and =end comments, "shebang" directives, or rackup options.

Example:

# bad
#Some comment
 
# good
# Some comment

Example: AllowDoxygenCommentStyle: false (default)

# bad
 
#**
# Some comment
# Another line of comment
#*

Example: AllowDoxygenCommentStyle: true

# good
 
#**
# Some comment
# Another line of comment
#*

Example: AllowGemfileRubyComment: false (default)

# bad
 
#ruby=2.7.0
#ruby-gemset=myproject

Example: AllowGemfileRubyComment: true

# good
 
#ruby=2.7.0
#ruby-gemset=myproject

Helps you transition from mutable string literals to frozen string literals. It will add the # frozen_string_literal: true magic comment to the top of files to enable frozen string literals. Frozen string literals may be default in future Ruby. The comment will be added below a shebang and encoding comment. The frozen string literal comment is only valid in Ruby 2.3+.

Note that the cop will accept files where the comment exists but is set to false instead of true.

To require a blank line after this comment, please see Layout/EmptyLineAfterMagicComment cop.

Safety:

This cop's autocorrection is unsafe since any strings mutations will change from being accepted to raising FrozenError, as all strings will become frozen by default, and will need to be manually refactored.

Example: EnforcedStyle: always (default)

# 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
 
# good
# frozen_string_literal: false
 
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

Example: EnforcedStyle: always_true

# The `always_true` style enforces that the frozen string literal
# comment is set to `true`. This is a stricter option than `always`
# and forces projects to use frozen string literals.
# bad
# frozen_string_literal: false
 
module Baz
  # ...
end
 
# bad
module Baz
  # ...
end
 
# good
# frozen_string_literal: true
 
module Bar
  # ...
end

Checks whether comments have a leading space after the # denoting the start of the comment. The leading space is not required for some RDoc special syntax, like #++, #--, #:nodoc, =begin- and =end comments, "shebang" directives, or rackup options.

Example:

# bad
#Some comment
 
# good
# Some comment

Example: AllowDoxygenCommentStyle: false (default)

# bad
 
#**
# Some comment
# Another line of comment
#*

Example: AllowDoxygenCommentStyle: true

# good
 
#**
# Some comment
# Another line of comment
#*

Example: AllowGemfileRubyComment: false (default)

# bad
 
#ruby=2.7.0
#ruby-gemset=myproject

Example: AllowGemfileRubyComment: true

# good
 
#ruby=2.7.0
#ruby-gemset=myproject