class SyntaxTree::Comment

Comment represents a comment in the source.

# comment

Attributes

inline [R]

boolean: whether or not there is code on the same line as this comment.

If there is, then inline will be true.

inline? [R]

boolean: whether or not there is code on the same line as this comment.

If there is, then inline will be true.

value [R]

String: the contents of the comment

Public Class Methods

new (value:, inline:, location:)

Source

# File lib/syntax_tree/node.rb, line 3749
def initialize(value:, inline:, location:)
  @value = value
  @inline = inline
  @location = location

  @leading = false
  @trailing = false
end

Public Instance Methods

=== (other)

Source

# File lib/syntax_tree/node.rb, line 3808
def ===(other)
  other.is_a?(Comment) && value === other.value && inline === other.inline
end

accept (visitor)

Source

# File lib/syntax_tree/node.rb, line 3782
def accept(visitor)
  visitor.visit_comment(self)
end

child_nodes ()

Source

# File lib/syntax_tree/node.rb, line 3786
def child_nodes
  []
end

Also aliased as: deconstruct

comments ()

Source

# File lib/syntax_tree/node.rb, line 3778
def comments
  []
end

copy (value: nil, inline: nil, location: nil)

Source

# File lib/syntax_tree/node.rb, line 3790
def copy(value: nil, inline: nil, location: nil)
  Comment.new(
    value: value || self.value,
    inline: inline || self.inline,
    location: location || self.location
  )
end

deconstruct ()

Alias for: child_nodes

deconstruct_keys (_keys)

Source

# File lib/syntax_tree/node.rb, line 3800
def deconstruct_keys(_keys)
  { value: value, inline: inline, location: location }
end

format (q)

Source

# File lib/syntax_tree/node.rb, line 3804
def format(q)
  q.text(value)
end

ignore? ()

Source

# File lib/syntax_tree/node.rb, line 3774
def ignore?
  value.match?(/\A#\s*stree-ignore\s*\z/)
end

leading! ()

Source

# File lib/syntax_tree/node.rb, line 3758
def leading!
  @leading = true
end

leading? ()

Source

# File lib/syntax_tree/node.rb, line 3762
def leading?
  @leading
end

trailing! ()

Source

# File lib/syntax_tree/node.rb, line 3766
def trailing!
  @trailing = true
end

trailing? ()

Source

# File lib/syntax_tree/node.rb, line 3770
def trailing?
  @trailing
end