Class: SyntaxTree::Formatter

Inherits:
PrettierPrint
  • Object
show all
Defined in:
lib/syntax_tree/formatter.rb

Overview

A slightly enhanced PP that knows how to format recursively including comments.

Constant Summary collapse

OPTIONS =

We want to minimize as much as possible the number of options that are available in syntax tree. For the most part, if users want non-default formatting, they should override the format methods on the specific nodes themselves. However, because of some history with prettier and the fact that folks have become entrenched in their ways, we decided to provide a small amount of configurability.

Note that we’re keeping this in a global-ish hash instead of just overriding methods on classes so that other plugins can reference this if necessary. For example, the RBS plugin references the quote style.

{
  quote: "\"",
  trailing_comma: false,
  target_ruby_version: Gem::Version.new(RUBY_VERSION)
}
COMMENT_PRIORITY = 
1
HEREDOC_PRIORITY = 
2

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, *args, quote: OPTIONS[:quote], trailing_comma: OPTIONS[:trailing_comma], target_ruby_version: OPTIONS[:target_ruby_version]) ⇒ Formatter

Returns a new instance of Formatter.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/syntax_tree/formatter.rb', line 33

def initialize(
  source,
  *args,
  quote: OPTIONS[:quote],
  trailing_comma: OPTIONS[:trailing_comma],
  target_ruby_version: OPTIONS[:target_ruby_version]
)
  super(*args)

  @source = source
  @stack = []

  # Memoizing these values per formatter to make access faster.
  @quote = quote
  @trailing_comma = trailing_comma
  @target_ruby_version = target_ruby_version
end

Instance Attribute Details

#quote ⇒ Object (readonly)

These options are overridden in plugins to we need to make sure they are available here.



30
31
32
 
# File 'lib/syntax_tree/formatter.rb', line 30

def quote
  @quote
end

#source ⇒ Object (readonly)

Returns the value of attribute source.



26
27
28
 
# File 'lib/syntax_tree/formatter.rb', line 26

def source
  @source
end

#stack ⇒ Object (readonly)

Returns the value of attribute stack.



26
27
28
 
# File 'lib/syntax_tree/formatter.rb', line 26

def stack
  @stack
end

#target_ruby_version ⇒ Object (readonly)

These options are overridden in plugins to we need to make sure they are available here.



30
31
32
 
# File 'lib/syntax_tree/formatter.rb', line 30

def target_ruby_version
  @target_ruby_version
end

#trailing_comma ⇒ Object (readonly) Also known as: trailing_comma?

These options are overridden in plugins to we need to make sure they are available here.



30
31
32
 
# File 'lib/syntax_tree/formatter.rb', line 30

def trailing_comma
  @trailing_comma
end

Class Method Details

.format(source, node) ⇒ Object 



51
52
53
54
55
56
 
# File 'lib/syntax_tree/formatter.rb', line 51

def self.format(source, node)
  q = new(source, [])
  q.format(node)
  q.flush
  q.output.join
end

Instance Method Details

#format(node, stackable: true) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/syntax_tree/formatter.rb', line 58

def format(node, stackable: true)
  stack << node if stackable
  doc = nil

  # If there are comments, then we're going to format them around the node
  # so that they get printed properly.
  if node.comments.any?
    leading, trailing = node.comments.partition(&:leading?)

    # Print all comments that were found before the node.
    leading.each do |comment|
      comment.format(self)
      breakable(force: true)
    end

    # If the node has a stree-ignore comment right before it, then we're
    # going to just print out the node as it was seen in the source.
    doc =
      if leading.last&.ignore?
        range = source[node.location.start_char...node.location.end_char]
        separator = -> { breakable(indent: false, force: true) }
        seplist(range.split(/\r?\n/, -1), separator) { |line| text(line) }
      else
        node.format(self)
      end

    # Print all comments that were found after the node.
    trailing.each do |comment|
      line_suffix(priority: COMMENT_PRIORITY) do
        comment.inline? ? text(" ") : breakable
        comment.format(self)
        break_parent
      end
    end
  else
    doc = node.format(self)
  end

  stack.pop if stackable
  doc
end

#format_each(nodes) ⇒ Object 



100
101
102
 
# File 'lib/syntax_tree/formatter.rb', line 100

def format_each(nodes)
  nodes.each { |node| format(node) }
end

#parent ⇒ Object 



104
105
106
 
# File 'lib/syntax_tree/formatter.rb', line 104

def parent
  stack[-2]
end

#parents ⇒ Object 



108
109
110
 
# File 'lib/syntax_tree/formatter.rb', line 108

def parents
  stack[0...-1].reverse_each
end