Merge pull request #4384 from onflow/bastian/improve-pretty-printing

Improve pretty printing

Author: turbolent

ast/expression.go

@@ -276,8 +276,25 @@ func (e *StringTemplateExpression) Doc() prettier.Doc {
 		return prettier.Text(QuoteString(e.Values[0]))
 	}
 
-	// TODO: must reproduce expressions as literals
-	panic("not implemented")
+	concat := make(prettier.Concat, 0, 2+len(e.Values)+(3*len(e.Expressions)))
+	concat = append(concat, prettier.Text(`"`))
+	for i, value := range e.Values {
+		var sb strings.Builder
+		QuoteStringInner(value, &sb)
+		concat = append(concat, prettier.Text(sb.String()))
+
+		if i < len(e.Expressions) {
+			e := e.Expressions[i]
+			concat = append(
+				concat,
+				prettier.Text(`\(`),
+				e.Doc(),
+				prettier.Text(`)`),
+			)
+		}
+	}
+	concat = append(concat, prettier.Text(`"`))
+	return concat
 }
 
 func (e *StringTemplateExpression) MarshalJSON() ([]byte, error) {

ast/expression_test.go

@@ -5709,3 +5709,112 @@ func TestFunctionExpression_String(t *testing.T) {
 		)
 	})
 }
+
+func TestStringTemplateExpression_MarshalJSON(t *testing.T) {
+
+	t.Parallel()
+
+	expr := &StringTemplateExpression{
+		Values: []string{"Hello, ", "!"},
+		Expressions: []Expression{
+			&IdentifierExpression{
+				Identifier: Identifier{
+					Identifier: "name",
+					Pos:        Position{Offset: 1, Line: 2, Column: 3},
+				},
+			},
+		},
+		Range: Range{
+			StartPos: Position{Offset: 4, Line: 5, Column: 6},
+			EndPos:   Position{Offset: 7, Line: 8, Column: 9},
+		},
+	}
+
+	actual, err := json.Marshal(expr)
+	require.NoError(t, err)
+
+	assert.JSONEq(t,
+		// language=json
+		`
+          {
+              "Type": "StringTemplateExpression",
+              "Values": ["Hello, ", "!"],
+              "Expressions": [
+                  {
+                      "Type": "IdentifierExpression",
+                      "Identifier": {
+                          "Identifier": "name",
+                          "StartPos": {"Offset": 1, "Line": 2, "Column": 3},
+                          "EndPos": {"Offset": 4, "Line": 2, "Column": 6}
+                      },
+                      "StartPos": {"Offset": 1, "Line": 2, "Column": 3},
+                      "EndPos": {"Offset": 4, "Line": 2, "Column": 6}
+                  }
+              ],
+              "StartPos": {"Offset": 4, "Line": 5, "Column": 6},
+              "EndPos": {"Offset": 7, "Line": 8, "Column": 9}
+          }
+        `,
+		string(actual),
+	)
+}
+
+func TestStringExpressionTemplate_Doc(t *testing.T) {
+
+	t.Parallel()
+
+	expr := &StringTemplateExpression{
+		Values: []string{"Hello, ", "!"},
+		Expressions: []Expression{
+			&IdentifierExpression{
+				Identifier: Identifier{
+					Identifier: "name",
+					Pos:        Position{Offset: 1, Line: 2, Column: 3},
+				},
+			},
+		},
+		Range: Range{
+			StartPos: Position{Offset: 4, Line: 5, Column: 6},
+			EndPos:   Position{Offset: 7, Line: 8, Column: 9},
+		},
+	}
+
+	assert.Equal(t,
+		prettier.Concat{
+			prettier.Text(`"`),
+			prettier.Text(`Hello, `),
+			prettier.Text(`\(`),
+			prettier.Text(`name`),
+			prettier.Text(`)`),
+			prettier.Text(`!`),
+			prettier.Text(`"`),
+		},
+		expr.Doc(),
+	)
+}
+
+func TestStringExpressionTemplate_String(t *testing.T) {
+
+	t.Parallel()
+
+	expr := &StringTemplateExpression{
+		Values: []string{"Hello, ", "!"},
+		Expressions: []Expression{
+			&IdentifierExpression{
+				Identifier: Identifier{
+					Identifier: "name",
+					Pos:        Position{Offset: 1, Line: 2, Column: 3},
+				},
+			},
+		},
+		Range: Range{
+			StartPos: Position{Offset: 4, Line: 5, Column: 6},
+			EndPos:   Position{Offset: 7, Line: 8, Column: 9},
+		},
+	}
+
+	assert.Equal(t,
+		`"Hello, \(name)!"`,
+		expr.String(),
+	)
+}

ast/string.go

@@ -27,6 +27,12 @@ import (
 func QuoteString(s string) string {
 	var b strings.Builder
 	b.WriteByte('"')
+	QuoteStringInner(s, &b)
+	b.WriteByte('"')
+	return b.String()
+}
+
+func QuoteStringInner(s string, b *strings.Builder) {
 	for _, r := range s {
 		switch r {
 		case 0:
@@ -56,6 +62,4 @@ func QuoteString(s string) string {
 			}
 		}
 	}
-	b.WriteByte('"')
-	return b.String()
 }

ast/transfer.go

@@ -67,6 +67,7 @@ func (f Transfer) MarshalJSON() ([]byte, error) {
 var copyTransferDoc prettier.Doc = prettier.Text("=")
 var moveTransferDoc prettier.Doc = prettier.Text("<-")
 var forceMoveTransferDoc prettier.Doc = prettier.Text("<-!")
+var noTransferDoc prettier.Doc = prettier.Text("$noTransfer")
 
 func (f Transfer) Doc() prettier.Doc {
 	switch f.Operation {
@@ -76,6 +77,9 @@ func (f Transfer) Doc() prettier.Doc {
 		return moveTransferDoc
 	case TransferOperationMoveForced:
 		return forceMoveTransferDoc
+	case TransferOperationInternalNoTransfer:
+		return noTransferDoc
+	// no transfer operation, e.g. in a variable declaration
 	case TransferOperationUnknown:
 		return prettier.Text("")
 	}