Merge pull request #8224 from JRI98/fix-multiline-strings-fmt

JRI98 · web-flow · commit 5226b6d43a6a · 2025-08-26T00:37:04.000+01:00
Fix fuzz crashes related multiline strings by adding a newline after them
diff --git a/src/fmt/fmt.zig b/src/fmt/fmt.zig
@@ -719,16 +719,7 @@ const Formatter = struct {
             }
             _ = try formatter(fmt, item_idx);
             if (multiline) {
-                // special case for multiline_strings
-                var node = fmt.ast.store.nodes.get(@enumFromInt(@intFromEnum(item_idx)));
-                if (node.tag == .record_field) {
-                    const field = fmt.ast.store.getRecordField(@enumFromInt(@intFromEnum(item_idx)));
-                    if (field.value) |v| {
-                        node = fmt.ast.store.nodes.get(@enumFromInt(@intFromEnum(v)));
-                    }
-                }
-                if (node.tag == .multiline_string) {
-                    try fmt.ensureNewline();
+                if (fmt.has_newline) {
                     try fmt.pushIndent();
                 }
                 try fmt.push(',');
@@ -853,6 +844,7 @@ const Formatter = struct {
                         },
                     }
                 }
+                try fmt.ensureNewline();
             },
             .single_quote => |s| {
                 try fmt.pushTokenText(s.token);
@@ -946,14 +938,8 @@ const Formatter = struct {
                     }
                     const field_region = try fmt.formatRecordField(field_idx);
                     if (multiline) {
-                        const field = fmt.ast.store.getRecordField(field_idx);
-                        if (field.value) |v| {
-                            const node = fmt.ast.store.nodes.get(@enumFromInt(@intFromEnum(v)));
-                            // special case for multiline_strings
-                            if (node.tag == .multiline_string) {
-                                try fmt.ensureNewline();
-                                try fmt.pushIndent();
-                            }
+                        if (fmt.has_newline) {
+                            try fmt.pushIndent();
                         }
                         try fmt.push(',');
                         _ = try fmt.flushCommentsAfter(field_region.end);
@@ -1931,7 +1917,7 @@ const Formatter = struct {
 
     fn flushComments(fmt: *Formatter, between_text: []const u8) !bool {
         var found_comment = false;
-        var newline_count: usize = 0;
+        var newline_count: usize = if (fmt.has_newline) 1 else 0;
         var i: usize = 0;
         while (i < between_text.len) {
             if (between_text[i] == '#') {
diff --git a/test/snapshots/can_import_nested_modules.md b/test/snapshots/can_import_nested_modules.md
@@ -508,7 +508,6 @@ import json.Parser
 import http.Client
 
 
-
 # Test multi-level type qualification
 parseConfig : Config.Settings -> Str
 parseConfig = |settings| Config.toString(settings)
diff --git a/test/snapshots/fuzz_crash/fuzz_crash_009.md b/test/snapshots/fuzz_crash/fuzz_crash_009.md
@@ -125,7 +125,6 @@ StringStart(6:5-6:6),StringPart(6:6-6:12),EndOfFile(6:12-6:12),
 ~~~roc
 
 
-
 foo = 
 
 	"onmo %"
diff --git a/test/snapshots/fuzz_crash/fuzz_crash_021.md b/test/snapshots/fuzz_crash/fuzz_crash_021.md
@@ -168,7 +168,6 @@ UpperIdent(3:1-3:5),NoSpaceOpenRound(3:5-3:6),LowerIdent(3:6-3:7),Comma(3:7-3:8)
 # FORMATTED
 ~~~roc
 
-
 <malformed> : 
 ~~~
 # CANONICALIZE
diff --git a/test/snapshots/fuzz_crash/fuzz_crash_022.md b/test/snapshots/fuzz_crash/fuzz_crash_022.md
@@ -194,7 +194,6 @@ OpUnaryMinus(8:1-8:2),LowerIdent(8:2-8:6),OpAssign(8:7-8:8),OpBar(8:9-8:10),Unde
 ~~~roc
 f : 
 
-
 UserId : U64
 
 ser : UserId -> Str
diff --git a/test/snapshots/fuzz_crash/fuzz_crash_024.md b/test/snapshots/fuzz_crash/fuzz_crash_024.md
@@ -208,7 +208,6 @@ KwVar(7:1-7:4),LowerIdent(7:5-7:6),OpAssign(7:6-7:7),Int(7:8-7:9),EndOfFile(7:9-
 module []
 pf : 
 
-
 # el
 t = 
 
diff --git a/test/snapshots/fuzz_crash/fuzz_crash_025.md b/test/snapshots/fuzz_crash/fuzz_crash_025.md
@@ -247,12 +247,10 @@ b = 65535
 c : U32
 c = 429496729
 
-
 e : U128
 e = 3402823669209384634633746074317682114553.14
 
 
-
 g : I16
 g = -32768
 
diff --git a/test/snapshots/fuzz_crash/fuzz_crash_026.md b/test/snapshots/fuzz_crash/fuzz_crash_026.md
diff --git a/test/snapshots/fuzz_crash/fuzz_crash_027.md b/test/snapshots/fuzz_crash/fuzz_crash_027.md
@@ -1659,8 +1659,8 @@ main! = |_| { # Yeah Ie
 	tag_with = Ok(number)
 	ited = "Hello, ${world}"
 	list = [
-		, # afarg
-		,
+				, # afarg
+				,
 		456, # ee
 	]
 	for n in list {
diff --git a/test/snapshots/fuzz_crash/fuzz_crash_031.md b/test/snapshots/fuzz_crash/fuzz_crash_031.md
@@ -108,7 +108,6 @@ LowerIdent(4:1-4:6),LowerIdent(4:7-4:8),OpAssign(4:8-4:9),MalformedSingleQuoteUn
 # FORMATTED
 ~~~roc
 
-
 # el
 t = 
 ~~~
diff --git a/test/snapshots/fuzz_crash/fuzz_crash_032.md b/test/snapshots/fuzz_crash/fuzz_crash_032.md
@@ -305,15 +305,14 @@ module [tus, r]
 
 LocalStatus : lue => Loc
 
-
 olor : _ -> tus
 olor = |color| {
 		Color.RGB
 
 	match color {
 		RGB => LocalStatus.Pending
 		Green => LocalStatus
-		 => Complete
+					=> Complete
 		B.Blue => LocalStatus.Pending
 	}
 }
diff --git a/test/snapshots/fuzz_crash/fuzz_crash_044.md b/test/snapshots/fuzz_crash/fuzz_crash_044.md
@@ -142,7 +142,6 @@ app [] { f: platform "" }
 
 
 
-
 ~~~
 # CANONICALIZE
 ~~~clojure
diff --git a/test/snapshots/let_polymorphism_lists.md b/test/snapshots/let_polymorphism_lists.md
@@ -320,7 +320,6 @@ all_str_list = str_list +
 
 all_float_list = float_list + 
 
-
 # Function returning empty list
 get_empty = |_| []
 
diff --git a/test/snapshots/match_expr/guards_1.md b/test/snapshots/match_expr/guards_1.md
@@ -386,13 +386,13 @@ CloseCurly(5:1-5:2),EndOfFile(5:2-5:2),
 ~~~roc
 match value {
 	x => 
-	 => 
-	 => 
-	 => 
+			=> 
+			=> 
+			=> 
 	x => 
-	 => 
-	 => 
-	 => 
+			=> 
+			=> 
+			=> 
 	_ => "other"
 }
 ~~~
diff --git a/test/snapshots/match_expr/guards_2.md b/test/snapshots/match_expr/guards_2.md
@@ -403,13 +403,13 @@ CloseCurly(5:1-5:2),EndOfFile(5:2-5:2),
 ~~~roc
 match value {
 	[first, .. as rest] => 
-	 => 
-	 => 
-	 => 
+			=> 
+			=> 
+			=> 
 	[x, y] => 
-	 => 
-	 => 
-	 => 
+			=> 
+			=> 
+			=> 
 	_ => "other"
 }
 ~~~
diff --git a/test/snapshots/multi_qualified_import.md b/test/snapshots/multi_qualified_import.md
@@ -343,7 +343,6 @@ module [json_encoder]
 
 import json.Core
 
-
 json_encoder : Encoder
 json_encoder = Json.Core.Utf8.defaultEncoder
 
diff --git a/test/snapshots/multiline_string_complex.md b/test/snapshots/multiline_string_complex.md
@@ -40,17 +40,53 @@ value5 = {
 		"""multiline
 		,
 	],
+	d: (
+		0 - """
+		,
+	),
+	e: !"""
+	,
 }
 
 x = {
-	"""
-	"""
+	s = """
+		"""
+
+	s
 }
 ~~~
 # EXPECTED
-NIL
+TYPE MISMATCH - multiline_string_complex.md:37:7:37:10
+TYPE MISMATCH - multiline_string_complex.md:40:5:40:9
 # PROBLEMS
-NIL
+**TYPE MISMATCH**
+This expression is used in an unexpected way:
+**multiline_string_complex.md:37:7:37:10:**
+```roc
+		0 - """
+```
+		    ^^^
+
+It has the type:
+    _Str_
+
+But here it's being used as:
+    _Num(_size)_
+
+**TYPE MISMATCH**
+This expression is used in an unexpected way:
+**multiline_string_complex.md:40:5:40:9:**
+```roc
+	e: !"""
+```
+	   ^^^^
+
+It has the type:
+    _Bool_
+
+But here it's being used as:
+    _Str_
+
 # TOKENS
 ~~~zig
 KwPackage(1:1-1:8),
@@ -82,15 +118,22 @@ LowerIdent(32:2-32:3),OpColon(32:3-32:4),OpenSquare(32:5-32:6),
 MultilineStringStart(33:3-33:6),StringPart(33:6-33:15),
 Comma(34:3-34:4),
 CloseSquare(35:2-35:3),Comma(35:3-35:4),
-CloseCurly(36:1-36:2),
-LowerIdent(38:1-38:2),OpAssign(38:3-38:4),OpenCurly(38:5-38:6),
-MultilineStringStart(39:2-39:5),StringPart(39:5-39:5),
-MultilineStringStart(40:2-40:5),StringPart(40:5-40:5),
-CloseCurly(41:1-41:2),EndOfFile(41:2-41:2),
+LowerIdent(36:2-36:3),OpColon(36:3-36:4),OpenRound(36:5-36:6),
+Int(37:3-37:4),OpBinaryMinus(37:5-37:6),MultilineStringStart(37:7-37:10),StringPart(37:10-37:10),
+Comma(38:3-38:4),
+CloseRound(39:2-39:3),Comma(39:3-39:4),
+LowerIdent(40:2-40:3),OpColon(40:3-40:4),OpBang(40:5-40:6),MultilineStringStart(40:6-40:9),StringPart(40:9-40:9),
+Comma(41:2-41:3),
+CloseCurly(42:1-42:2),
+LowerIdent(44:1-44:2),OpAssign(44:3-44:4),OpenCurly(44:5-44:6),
+LowerIdent(45:2-45:3),OpAssign(45:4-45:5),MultilineStringStart(45:6-45:9),StringPart(45:9-45:9),
+MultilineStringStart(46:3-46:6),StringPart(46:6-46:6),
+LowerIdent(48:2-48:3),
+CloseCurly(49:1-49:2),EndOfFile(49:2-49:2),
 ~~~
 # PARSE
 ~~~clojure
-(file @1.1-41.2
+(file @1.1-49.2
 	(package @1.1-6.3
 		(exposes @2.2-2.4)
 		(packages @3.2-6.3
@@ -122,9 +165,9 @@ CloseCurly(41:1-41:2),EndOfFile(41:2-41:2),
 				(e-string-part @21.5-21.5 (raw ""))
 				(e-ident @21.7-21.13 (raw "value2"))
 				(e-string-part @21.14-21.14 (raw ""))))
-		(s-decl @23.1-36.2
+		(s-decl @23.1-42.2
 			(p-ident @23.1-23.7 (raw "value5"))
-			(e-record @23.10-36.2
+			(e-record @23.10-42.2
 				(field (field "a")
 					(e-multiline-string @24.5-24.17
 						(e-string-part @24.8-24.17 (raw "Multiline"))))
@@ -137,14 +180,27 @@ CloseCurly(41:1-41:2),EndOfFile(41:2-41:2),
 				(field (field "c")
 					(e-list @32.5-35.3
 						(e-multiline-string @33.3-33.15
-							(e-string-part @33.6-33.15 (raw "multiline")))))))
-		(s-decl @38.1-41.2
-			(p-ident @38.1-38.2 (raw "x"))
-			(e-block @38.5-41.2
+							(e-string-part @33.6-33.15 (raw "multiline")))))
+				(field (field "d")
+					(e-tuple @36.5-39.3
+						(e-binop @37.3-37.10 (op "-")
+							(e-int @37.3-37.4 (raw "0"))
+							(e-multiline-string @37.7-37.10
+								(e-string-part @37.10-37.10 (raw ""))))))
+				(field (field "e")
+					(unary "!"
+						(e-multiline-string @40.6-40.9
+							(e-string-part @40.9-40.9 (raw "")))))))
+		(s-decl @44.1-49.2
+			(p-ident @44.1-44.2 (raw "x"))
+			(e-block @44.5-49.2
 				(statements
-					(e-multiline-string @39.2-40.5
-						(e-string-part @39.5-39.5 (raw ""))
-						(e-string-part @40.5-40.5 (raw ""))))))))
+					(s-decl @45.2-46.6
+						(p-ident @45.2-45.3 (raw "s"))
+						(e-multiline-string @45.6-46.6
+							(e-string-part @45.9-45.9 (raw ""))
+							(e-string-part @46.6-46.6 (raw ""))))
+					(e-ident @48.2-48.3 (raw "s")))))))
 ~~~
 # FORMATTED
 ~~~roc
@@ -181,7 +237,7 @@ NO CHANGE
 				(p-assign @10.1-10.7 (ident "value2")))))
 	(d-let
 		(p-assign @23.1-23.7 (ident "value5"))
-		(e-record @23.10-36.2
+		(e-record @23.10-42.2
 			(fields
 				(field (name "a")
 					(e-string @24.5-24.17
@@ -197,12 +253,23 @@ NO CHANGE
 					(e-list @32.5-35.3
 						(elems
 							(e-string @33.3-33.15
-								(e-literal @33.6-33.15 (string "multiline")))))))))
+								(e-literal @33.6-33.15 (string "multiline"))))))
+				(field (name "d")
+					(e-binop @37.3-37.10 (op "sub")
+						(e-int @37.3-37.4 (value "0"))
+						(e-string @37.7-37.10)))
+				(field (name "e")
+					(e-unary-not @40.5-40.9
+						(e-string @40.6-40.9))))))
 	(d-let
-		(p-assign @38.1-38.2 (ident "x"))
-		(e-block @38.5-41.2
-			(e-string @39.2-40.5
-				(e-literal @40.2-40.5 (string "\n"))))))
+		(p-assign @44.1-44.2 (ident "x"))
+		(e-block @44.5-49.2
+			(s-let @45.2-46.6
+				(p-assign @45.2-45.3 (ident "s"))
+				(e-string @45.6-46.6
+					(e-literal @46.3-46.6 (string "\n"))))
+			(e-lookup-local @48.2-48.3
+				(p-assign @45.2-45.3 (ident "s"))))))
 ~~~
 # TYPES
 ~~~clojure
@@ -212,13 +279,13 @@ NO CHANGE
 		(patt @10.1-10.7 (type "Str"))
 		(patt @13.1-13.7 (type "Str"))
 		(patt @17.1-17.7 (type "Str"))
-		(patt @23.1-23.7 (type "{ a: Str, b: (Str, Str), c: List(Str) }"))
-		(patt @38.1-38.2 (type "Str")))
+		(patt @23.1-23.7 (type "{ a: Str, b: (Str, Str), c: List(Str), d: Num(_size), e: Error }"))
+		(patt @44.1-44.2 (type "Str")))
 	(expressions
 		(expr @8.10-8.50 (type "Str"))
 		(expr @11.2-11.42 (type "Str"))
 		(expr @13.10-15.14 (type "Str"))
 		(expr @18.2-21.14 (type "Str"))
-		(expr @23.10-36.2 (type "{ a: Str, b: (Str, Str), c: List(Str) }"))
-		(expr @38.5-41.2 (type "Str"))))
+		(expr @23.10-42.2 (type "{ a: Str, b: (Str, Str), c: List(Str), d: Num(_size), e: Error }"))
+		(expr @44.5-49.2 (type "Str"))))
 ~~~
diff --git a/test/snapshots/multiline_string_expr.md b/test/snapshots/multiline_string_expr.md
diff --git a/test/snapshots/nominal/nominal_import_long_package.md b/test/snapshots/nominal/nominal_import_long_package.md
diff --git a/test/snapshots/nominal/nominal_import_wildcard.md b/test/snapshots/nominal/nominal_import_wildcard.md
diff --git a/test/snapshots/qualified_type_canonicalization.md b/test/snapshots/qualified_type_canonicalization.md
diff --git a/test/snapshots/unicode_single_quotes.md b/test/snapshots/unicode_single_quotes.md
diff --git a/test/snapshots/where_clause/where_clauses_error_cases.md b/test/snapshots/where_clause/where_clauses_error_cases.md

-Original file line number
+Diff line change
 ~~~roc
+-
 foo =
 	"onmo %"