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; frozen_string_literal: true -*-'
)

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

See Also:

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

Constant Summary

FORMAT =

/\-\*\-(.+)\-\*\-/

SEPARATOR =

';'.freeze

OPERATOR =

':'.freeze

Constants inherited from RuboCop::MagicComment

TOKEN

Instance Method Summary

• #encoding ⇒ Object

Methods inherited from RuboCop::MagicComment

#frozen_string_literal, #frozen_string_literal?, #frozen_string_literal_specified?, #initialize, parse

Constructor Details

This class inherits a constructor from RuboCop::MagicComment

Instance Method Details

#encoding ⇒ Object

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

def encoding
  match('encoding')
end