Allow comments in things. (#714)

spec/examples/array_literal

@@ -53,3 +53,14 @@ component Main {
     <div/>
   }
 }
+-------------------------------------------------------------------------------
+module Test {
+  fun test : Array(String) {
+    [
+      // Start Comment
+      "Item 1",
+      // End comment
+      "Item 2"
+    ] of String
+  }
+}

spec/examples/operation

@@ -151,3 +151,10 @@ component Main {
     "Hello" + "There"
   }
 }
+-------------------------------------------------------------------------------
+component Main {
+  fun render : String {
+    "Hello" // Some comment
+    + "There"
+  }
+}

spec/examples/pipe

@@ -76,3 +76,17 @@ component Main {
     <div/>
   }
 }
+-------------------------------------------------------------------------------
+component Main {
+  fun test (value : String) {
+    value
+  }
+
+  fun render : Html {
+    "test"
+    // Some comment
+    |> test
+
+    <div/>
+  }
+}

spec/formatters/array_with_comments

@@ -0,0 +1,23 @@
+module Test {
+  fun test : Array(String) {
+    [
+      // Item 1 Comment
+      "Item 1",
+      // Item 2 comment
+      "Item 2"
+      // End comment
+    ] of String
+  }
+}
+--------------------------------------------------------------------------------
+module Test {
+  fun test : Array(String) {
+    [
+      // Item 1 Comment
+      "Item 1",
+      // Item 2 comment
+      "Item 2"
+      // End comment
+    ] of String
+  }
+}

spec/formatters/operation_with_comment

@@ -0,0 +1,13 @@
+component Main {
+  fun render : String {
+    "Hello" // Some comment
+    + "There"
+  }
+}
+--------------------------------------------------------------------------------
+component Main {
+  fun render : String {
+    "Hello" // Some comment
+     + "There"
+  }
+}

spec/formatters/pipe_with_comment

@@ -0,0 +1,27 @@
+component Main {
+  fun test (value : String) {
+    value
+  }
+
+  fun render : Html {
+    "test"
+    // Some comment
+    |> test
+
+    <div/>
+  }
+}
+--------------------------------------------------------------------------------
+component Main {
+  fun test (value : String) {
+    value
+  }
+
+  fun render : Html {
+    "test"
+    // Some comment
+    |> test
+
+    <div/>
+  }
+}

spec/formatters/record_update_with_comments

@@ -0,0 +1,33 @@
+type A {
+  a : String
+}
+
+module Test {
+  fun test : A {
+    let x =
+      { a : "Blah" }
+
+    { x|
+      // Comment
+      a:"Hello"
+      // End Comment
+    }
+  }
+}
+--------------------------------------------------------------------------------
+type A {
+  a : String
+}
+
+module Test {
+  fun test : A {
+    let x =
+      { a: "Blah" }
+
+    { x |
+      // Comment
+      a: "Hello"
+      // End Comment
+    }
+  }
+}

spec/formatters/record_with_comments

@@ -0,0 +1,27 @@
+type A {
+  a : String
+}
+
+module Test {
+  fun test : A {
+    {
+      // Comment
+      a:"Hello"
+      // End Comment
+    }
+  }
+}
+--------------------------------------------------------------------------------
+type A {
+  a : String
+}
+
+module Test {
+  fun test : A {
+    {
+      // Comment
+      a: "Hello"
+      // End Comment
+    }
+  }
+}

spec/formatters/tuple_with_comments

@@ -0,0 +1,23 @@
+module Test {
+  fun test : Tuple(String, String) {
+    {
+      // Comment for "Blah"
+      "Blah",
+      // Comment for "Joe"
+      "Joe"
+      // End comment
+    }
+  }
+}
+--------------------------------------------------------------------------------
+module Test {
+  fun test : Tuple(String, String) {
+    {
+      // Comment for "Blah"
+      "Blah",
+      // Comment for "Joe"
+      "Joe"
+      // End comment
+    }
+  }
+}

spec/formatters/type_definition_with_comments

@@ -1,4 +1,6 @@
-/*A*/typeTest{/*B*/a:String,/*C*/b:Blah}
+/*A*/typeTest{
+  /*B*/a:String,/*C*/b:Blah// End comment
+}
 --------------------------------------------------------------------------------
 /* A */
 type Test {
@@ -7,4 +9,6 @@ type Test {
 
   /* C */
   b : Blah
+
+  // End comment
 }

src/ast/array_literal.cr

@@ -1,12 +1,13 @@
 module Mint
   class Ast
     class ArrayLiteral < Node
-      getter items, type
+      getter comment, items, type
 
-      def initialize(@from : Parser::Location,
+      def initialize(@items : Array(CommentedExpression),
+                     @from : Parser::Location,
                      @to : Parser::Location,
                      @file : Parser::File,
-                     @items : Array(Node),
+                     @comment : Comment?,
                      @type : Node?)
       end
     end

src/ast/commented_expression.cr

@@ -0,0 +1,14 @@
+module Mint
+  class Ast
+    class CommentedExpression < Node
+      getter expression, comment
+
+      def initialize(@from : Parser::Location,
+                     @to : Parser::Location,
+                     @file : Parser::File,
+                     @comment : Comment?,
+                     @expression : Node)
+      end
+    end
+  end
+end

src/ast/operation.cr

@@ -1,11 +1,12 @@
 module Mint
   class Ast
     class Operation < Node
-      getter operator, right, left
+      getter operator, comment, right, left
 
       def initialize(@from : Parser::Location,
                      @to : Parser::Location,
                      @file : Parser::File,
+                     @comment : Comment?,
                      @operator : String,
                      @right : Node,
                      @left : Node)

src/ast/pipe.cr

@@ -1,11 +1,12 @@
 module Mint
   class Ast
     class Pipe < Node
-      getter expression, argument
+      getter expression, argument, comment
 
       def initialize(@from : Parser::Location,
                      @to : Parser::Location,
                      @file : Parser::File,
+                     @comment : Comment?,
                      @expression : Node,
                      @argument : Node)
       end

src/ast/record.cr

@@ -1,12 +1,13 @@
 module Mint
   class Ast
     class Record < Node
-      getter fields
+      getter fields, comment
 
       def initialize(@from : Parser::Location,
                      @to : Parser::Location,
                      @fields : Array(Field),
-                     @file : Parser::File)
+                     @file : Parser::File,
+                     @comment : Comment?)
       end
     end
   end

src/ast/record_update.cr

@@ -1,13 +1,14 @@
 module Mint
   class Ast
     class RecordUpdate < Node
-      getter expression, fields
+      getter expression, fields, comment
 
       def initialize(@from : Parser::Location,
                      @expression : Ast::Node,
                      @to : Parser::Location,
                      @fields : Array(Field),
-                     @file : Parser::File)
+                     @file : Parser::File,
+                     @comment : Comment?)
       end
     end
   end

src/ast/tuple_literal.cr

@@ -1,12 +1,13 @@
 module Mint
   class Ast
     class TupleLiteral < Node
-      getter items
+      getter comment, items
 
-      def initialize(@from : Parser::Location,
+      def initialize(@items : Array(CommentedExpression),
+                     @from : Parser::Location,
                      @to : Parser::Location,
                      @file : Parser::File,
-                     @items : Array(Node))
+                     @comment : Comment?)
       end
     end
   end

src/ast/type_definition.cr

@@ -1,11 +1,12 @@
 module Mint
   class Ast
     class TypeDefinition < Node
-      getter parameters, comment, fields, name
+      getter parameters, end_comment, comment, fields, name
 
       def initialize(@fields : Array(TypeDefinitionField) | Array(TypeVariant),
                      @parameters : Array(TypeVariable),
                      @from : Parser::Location,
+                     @end_comment : Comment?,
                      @to : Parser::Location,
                      @file : Parser::File,
                      @comment : Comment?,

src/compilers/commented_expression.cr

@@ -0,0 +1,9 @@
+module Mint
+  class Compiler
+    def compile(node : Ast::CommentedExpression) : Compiled
+      compile node do
+        compile(node.expression)
+      end
+    end
+  end
+end

src/formatter.cr

@@ -47,7 +47,8 @@ module Mint
     #
     record List,
       items : Array(Tuple(Ast::Node, Nodes)),
-      separator : String? = nil
+      separator : String? = nil,
+      comment : Nodes? = nil
 
     # Describes a group of nodes, with start and end characters and a separator
     # character (or characters). The layout of the nodes are determined during
@@ -83,7 +84,8 @@ module Mint
       items : Array(Nodes),
       behavior : Behavior,
       separator : String,
-      pad : Bool
+      pad : Bool,
+      comment : Nodes = [] of Node
 
     # The possibilities on how to format groups.
     enum Behavior
@@ -133,10 +135,6 @@ module Mint
       [Group.new(**params)] of Node
     end
 
-    def list(**params)
-      [List.new(**params)] of Node
-    end
-
     # Actuall formatting things as strings...
 
     def format!(*args, **named) : String