Merge pull request #1744 from ruby/uk-improve-erb-comment-gen

Improve comment generation in templates
ruby · Oct 30, 2023 · 5ac0d77 · 5ac0d77
2 parents 4ff8fe2 + dee76b5
commit 5ac0d77
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 5 deletions.
diff --git a/templates/java/org/prism/Nodes.java.erb b/templates/java/org/prism/Nodes.java.erb
@@ -174,7 +174,11 @@ public abstract class Nodes {
 <%# NODES -%>
     <%- nodes.each do |node| -%>
 
-    <%= "#{node.comment.split("\n").map { |line| "// #{line}" }.join("\n    ")}\n" if node.comment -%>
+    /**
+    <%- node.comment.each_line do |line| -%>
+     *<%= line.prepend(" ").rstrip %>
+    <%- end -%>
+     */
     public static final class <%= node.name -%> extends Node {
         <%- if node.needs_serialized_length? -%>
         public final int serializedLength;

diff --git a/templates/javascript/src/nodes.js.erb b/templates/javascript/src/nodes.js.erb
@@ -42,7 +42,9 @@ const <%= flag.name %> = {
 <%- nodes.each do |node| -%>
 
 /**
-<%= "#{node.comment.split("\n").map { |line| line.empty? ? " *" : " * #{line}" }.join("\n")}" %>
+<%- node.comment.each_line do |line| -%>
+ *<%= line.prepend(" ").rstrip %>
+<%- end -%>
  */
 export class <%= node.name -%> {
   <%- node.fields.each do |field| -%>

diff --git a/templates/lib/prism/node.rb.erb b/templates/lib/prism/node.rb.erb
@@ -32,7 +32,10 @@ module Prism
   end
   <%- nodes.each do |node| -%>
 
-  <%= "#{node.comment.split("\n").map { |line| line.empty? ? "#" : "# #{line}" }.join("\n  ")}\n  " if node.comment %>class <%= node.name -%> < Node
+  <%- node.comment.each_line do |line| -%>
+  #<%= line.prepend(" ").rstrip %>
+  <%- end -%>
+  class <%= node.name -%> < Node
     <%- node.fields.each do |field| -%>
     # attr_reader <%= field.name %>: <%= field.rbs_class %>
     <%= "private " if field.is_a?(Prism::FlagsField) %>attr_reader :<%= field.name %>

diff --git a/templates/rbi/prism.rbi.erb b/templates/rbi/prism.rbi.erb
@@ -1,7 +1,10 @@
 
 module Prism
   <%- nodes.each do |node| -%>
-  <%= "#{node.comment.split("\n").map { |line| line.empty? ? "#" : "# #{line}" }.join("\n  ")}\n  " if node.comment %>class <%= node.name -%> < Node
+  <%- node.comment.each_line do |line| -%>
+  #<%= line.prepend(" ").rstrip %>
+  <%- end -%>
+  class <%= node.name -%> < Node
     <%- node.fields.each do |field| -%>
     sig { returns(<%= field.rbi_class %>) }
     attr_reader :<%= field.name %>

diff --git a/templates/sig/prism.rbs.erb b/templates/sig/prism.rbs.erb
@@ -1,6 +1,9 @@
 module Prism
   <%- nodes.each do |node| -%>
-  <%= "#{node.comment.split("\n").map { |line| line.empty? ? "#" : "# #{line}" }.join("\n  ")}\n  " if node.comment %>class <%= node.name -%> < Node
+  <%- node.comment.each_line do |line| -%>
+  #<%= line.prepend(" ").rstrip %>
+  <%- end -%>
+  class <%= node.name -%> < Node
     <%- node.fields.each do |field| -%>
     attr_reader <%= field.name %>: <%= field.rbs_class %>
     <%- end -%>