feat: flexible heredoc support (#1574)

Author: czosel

src/printer.js

@@ -2785,12 +2785,14 @@ function printNode(path, options, print) {
       if (parent.kind === "encapsedpart") {
         const parentParent = path.getParentNode(1);
         let closingTagIndentation = 0;
+        const flexible = isMinVersion(options.phpVersion, "7.3");
+        const linebreak = flexible ? hardline : literalline;
         if (parentParent.type === "heredoc") {
           const lines = parentParent.raw.split(/\r?\n/g);
           closingTagIndentation = lines[lines.length - 1].search(/\S/);
         }
         return join(
-          literalline,
+          linebreak,
           node.raw
             .split(/\r?\n/g)
             .map((s) => s.substring(closingTagIndentation))
@@ -2837,17 +2839,20 @@ function printNode(path, options, print) {
       switch (node.type) {
         case "string":
         case "shell":
-        case "heredoc":
+        case "heredoc": {
+          const flexible = isMinVersion(options.phpVersion, "7.3");
+          const linebreak = flexible ? hardline : literalline;
           return concat([
             getEncapsedQuotes(node),
             // Respect `indent` for `heredoc` nodes
-            node.type === "heredoc" ? literalline : "",
+            node.type === "heredoc" ? linebreak : "",
             concat(path.map(print, "value")),
             getEncapsedQuotes(node, { opening: false }),
             node.type === "heredoc" && docShouldHaveTrailingNewline(path)
               ? hardline
               : "",
           ]);
+        }
         // istanbul ignore next
         default:
           return `Have not implemented kind ${node.type} yet.`;

tests/nowdoc/__snapshots__/jsfmt.spec.js.snap

@@ -3105,35 +3105,35 @@ $str = sprintf(
 
 $str = sprintf(
     <<<EOD
-foo
-EOD
+    foo
+    EOD
     ,
     true,
 );
 
 $str = sprintf(
     sprintf(
         <<<END
-foo
-END
+        foo
+        END
         ,
         true,
     ),
 );
 
 $str = call([
     <<<END
-foo
-END
+    foo
+    END
     ,
     true,
 ]);
 
 $str = [
     [
         <<<END
-foo
-END
+        foo
+        END
         ,
         true,
     ],
@@ -3142,8 +3142,8 @@ END
 $str = [
     call(
         <<<END
-foo
-END
+        foo
+        END
         ,
         true,
     ),

tests/trailing_commas/__snapshots__/jsfmt.spec.js.snap

@@ -1597,30 +1597,30 @@ $expected = [
 // heredoc
 $expected = [
     <<<EOT
-foo
-# bar
-baz
+    foo
+    # bar
+    baz
 
-EOT
+    EOT
 ,
 ];
 $expected = [
     'foo',
     <<<EOT
-foo
-# bar
-baz
+    foo
+    # bar
+    baz
 
-EOT
+    EOT
 ,
 ];
 $expected = [
     <<<EOT
-foo
-# bar
-baz
+    foo
+    # bar
+    baz
 
-EOT
+    EOT
     ,
     'bar',
 ];
@@ -1659,30 +1659,30 @@ $expected = [
 // Associative array with heredoc
 $expected = [
     'key' => <<<EOT
-foo
-# bar
-baz
+    foo
+    # bar
+    baz
 
-EOT
+    EOT
 ,
 ];
 $expected = [
     'foo',
     'key' => <<<EOT
-foo
-# bar
-baz
+    foo
+    # bar
+    baz
 
-EOT
+    EOT
 ,
 ];
 $expected = [
     'key' => <<<EOT
-foo
-# bar
-baz
+    foo
+    # bar
+    baz
 
-EOT
+    EOT
     ,
     'bar',
 ];
@@ -1720,28 +1720,28 @@ $expected = [
 // Nested with heredoc
 $expected = [
     'test' => <<<EOT
-foo
-# bar
-baz
+    foo
+    # bar
+    baz
 
-EOT
+    EOT
     ,
     'collection' => [
         [
             'one' => <<<EOT
-foo
-# bar
-baz
+            foo
+            # bar
+            baz
 
-EOT
+            EOT
         ,
         ],
         [
             'two' => <<<EOT
-foo
-# bar
-baz
-EOT
+            foo
+            # bar
+            baz
+            EOT
         ,
         ],
     ],
@@ -3327,10 +3327,10 @@ call(
 
 call(
     <<<EOT
-My name is "$name". I am printing some $foo->foo.
-Now, I am printing some {$foo->bar[1]}.
-This should not print a capital 'A': \\x41
-EOT
+    My name is "$name". I am printing some $foo->foo.
+    Now, I am printing some {$foo->bar[1]}.
+    This should not print a capital 'A': \\x41
+    EOT
     ,
 );