Class: RuboCop::MagicComment::EmacsComment

Inherits:

EditorComment

• Object
• RuboCop::MagicComment
• EditorComment
• RuboCop::MagicComment::EmacsComment

Defined in:

lib/rubocop/magic_comment.rb

Overview

Wrapper for Emacs style magic comments.

Examples:

Emacs style comment

comment = RuboCop::MagicComment.parse(
  '# -*- encoding: ASCII-8BIT -*-'
)

comment.encoding # => 'ascii-8bit'

See Also:

• https://www.gnu.org/software/emacs/manual/html_node/emacs/Specify-Coding.html
• Emacs handling in parse.y

Constant Summary

REGEXP =

/-\*-(?<token>.+)-\*-/.freeze

FORMAT =

'# -*- %s -*-'

SEPARATOR =

';'

OPERATOR =

':'

Constants inherited from RuboCop::MagicComment

KEYWORDS, TOKEN

Instance Method Summary

• #new_frozen_string_literal(value) ⇒ Object

Methods inherited from EditorComment

#encoding, #without

Methods inherited from RuboCop::MagicComment

#any?, #encoding_specified?, #frozen_string_literal, #frozen_string_literal?, #frozen_string_literal_specified?, #initialize, parse, #shareable_constant_value, #shareable_constant_value_specified?, #typed, #typed_specified?, #valid?, #valid_literal_value?, #valid_shareable_constant_value?

Constructor Details

This class inherits a constructor from RuboCop::MagicComment

Instance Method Details

#new_frozen_string_literal(value) ⇒ Object

# File 'lib/rubocop/magic_comment.rb', line 196

def new_frozen_string_literal(value)
  "# -*- frozen_string_literal: #{value} -*-"
end