Merge pull request #909 from claytonrcarter/php-block-print-width

Author: shufo

__tests__/formatter.test.ts

@@ -5339,4 +5339,82 @@ describe('formatter', () => {
 
     await util.doubleFormatCheck(content, expected);
   });
+
+  test('@php blocks should wrap long statements (#908)', async () => {
+    const content = [
+      `@php`,
+      `$categories = App\\Models\\Category::whereIn('id', $catids)`,
+      `->orderBy('description')`,
+      `->orderBy('description')`,
+      `->orderBy('description')`,
+      `->get();`,
+      `@endphp`,
+    ].join('\n');
+
+    const expected = [
+      `@php`,
+      `    $categories = App\\Models\\Category::whereIn('id', $catids)`,
+      `        ->orderBy('description')`,
+      `        ->orderBy('description')`,
+      `        ->orderBy('description')`,
+      `        ->get();`,
+      `@endphp`,
+      ``,
+    ].join('\n');
+
+    await util.doubleFormatCheck(content, expected);
+  });
+
+  test('@php blocks should attempt to respect to current indent level', async () => {
+    // This statement is 119 chars long and should fit on 1 line w/ the default print width of 120.
+    // Once it's indented within the @php block, though, the line will exceed 120, so it should have
+    // been indented.
+    let content = [
+      `@php`,
+      `$categories = App\\Models\\Category::whereIn('idss', $catids)`,
+      `->orderBy('description')`,
+      `->orderBy('description')`,
+      `->getNone();`,
+      `@endphp`,
+    ].join('\n');
+
+    let expected = [
+      `@php`,
+      `    $categories = App\\Models\\Category::whereIn('idss', $catids)`,
+      `        ->orderBy('description')`,
+      `        ->orderBy('description')`,
+      `        ->getNone();`,
+      `@endphp`,
+      ``,
+    ].join('\n');
+
+    await util.doubleFormatCheck(content, expected);
+
+    // Now wrap the @php in a <div> and make the PHP statement 4 chars shorter to confirm that it
+    // still works at higher indent levels.
+    content = [
+      `<div>`,
+      `@php`,
+      `$categories = App\\Models\\Category::whereIn('idss', $catids)`,
+      `->orderBy('description')`,
+      `->orderBy('description')`,
+      `->get();`,
+      `@endphp`,
+      `</div>`,
+    ].join('\n');
+
+    expected = [
+      `<div>`,
+      `    @php`,
+      `        $categories = App\\Models\\Category::whereIn('idss', $catids)`,
+      `            ->orderBy('description')`,
+      `            ->orderBy('description')`,
+      `            ->get();`,
+      `    @endphp`,
+      `</div>`,
+      ``,
+    ].join('\n');
+
+    await util.doubleFormatCheck(content, expected);
+  });
 });

src/formatter.ts

@@ -1293,11 +1293,28 @@ export default class Formatter {
         const matchedLine = content.match(new RegExp(`^(.*?)${placeholder}`, 'gmi')) ?? [''];
         const indent = detectIndent(matchedLine[0]);
 
-        if (this.isInline(rawBlock) && (await this.isMultilineStatement(rawBlock))) {
+        const isOnSingleLine = this.isInline(rawBlock);
+        const isMultipleStatements = await this.isMultilineStatement(rawBlock);
+        if (isOnSingleLine && isMultipleStatements) {
+          // multiple statements on a single line
           rawBlock = (await util.formatStringAsPhp(`<?php\n${rawBlock}\n?>`, this.options)).trim();
-        } else if (rawBlock.split('\n').length > 1) {
+        } else if (isMultipleStatements) {
+          // multiple statments on mult lines
+
+          const indentLevel = (indent.amount + 1) * this.indentSize;
+
+          rawBlock = (
+            await util.formatStringAsPhp(`<?php${rawBlock}?>`, {
+              ...this.options,
+              useProjectPrintWidth: true,
+              adjustPrintWidthBy: indentLevel,
+            })
+          ).trimEnd();
+        } else if (!isOnSingleLine) {
+          // single statement on mult lines
           rawBlock = (await util.formatStringAsPhp(`<?php${rawBlock}?>`, this.options)).trimEnd();
         } else {
+          // single statement on single line
           rawBlock = `<?php${rawBlock}?>`;
         }
 

src/util.ts

@@ -65,10 +65,12 @@ export async function formatStringAsPhp(content: any, params: FormatPhpOption =
     ...params,
   };
 
+  const adjust = params.adjustPrintWidthBy ?? 0;
+  const printWidth = params.useProjectPrintWidth ? options.printWidth - adjust : printWidthForInline;
   try {
     return await prettier.format(content.replace(/\n$/, ''), {
       parser: 'php',
-      printWidth: 1000,
+      printWidth,
       singleQuote: !options.noSingleQuote,
       // @ts-ignore
       phpVersion: options.phpVersion,