Function calls set group (#524)

* including the last ')' in the group so if the call reaches the charLimit with the ')' it will break * function calls now set up a groupId and expose it via labels * MemberAccess reacts accordingly to the function calls groupId
prettier-solidity · Jun 5, 2021 · 594c158 · 594c158
1 parent 562d00f
commit 594c158
Show file tree

Hide file tree

Showing 4 changed files with 80 additions and 58 deletions.
diff --git a/src/nodes/FunctionCall.js b/src/nodes/FunctionCall.js
@@ -1,40 +1,59 @@
 const {
   doc: {
-    builders: { group, line, softline }
+    builders: { label, line, softline }
   }
 } = require('prettier/standalone');
 
 const printSeparatedList = require('./print-separated-list');
 
-const printObject = (node, path, print, options) =>
-  group([
-    '{',
-    printSeparatedList(
-      path
-        .map(print, 'arguments')
-        .map((arg, index) => [node.names[index], ': ', arg]),
-      { firstSeparator: options.bracketSpacing ? line : softline }
-    ),
-    '}'
-  ]);
+let functionCallId = 0;
 
-const printArguments = (node, path, print, options) => {
-  if (node.names && node.names.length > 0) {
-    return printObject(node, path, print, options);
-  }
-  if (node.arguments && node.arguments.length > 0) {
-    return printSeparatedList(path.map(print, 'arguments'));
-  }
-  return '';
-};
+const printObject = (node, path, print, options, groupId) => [
+  '{',
+  printSeparatedList(
+    path
+      .map(print, 'arguments')
+      .map((arg, index) => [node.names[index], ': ', arg]),
+    {
+      groupId,
+      firstSeparator: options.bracketSpacing ? line : softline,
+      lastSeparator: [options.bracketSpacing ? line : softline, '})']
+    }
+  )
+];
+
+const printArguments = (path, print, groupId) =>
+  printSeparatedList(path.map(print, 'arguments'), {
+    groupId,
+    lastSeparator: [softline, ')']
+  });
 
 const FunctionCall = {
-  print: ({ node, path, print, options }) => [
-    path.call(print, 'expression'),
-    '(',
-    printArguments(node, path, print, options),
-    ')'
-  ]
+  print: ({ node, path, print, options }) => {
+    let argumentsDoc = ')';
+    const functionCallLabel = { type: 'FunctionCall', groupId: null };
+    if (node.arguments && node.arguments.length > 0) {
+      functionCallLabel.groupId = `FunctionCall-${functionCallId}`;
+      functionCallId += 1;
+      if (node.names && node.names.length > 0) {
+        argumentsDoc = printObject(
+          node,
+          path,
+          print,
+          options,
+          functionCallLabel.groupId
+        );
+      } else {
+        argumentsDoc = printArguments(path, print, functionCallLabel.groupId);
+      }
+    }
+
+    return label(JSON.stringify(functionCallLabel), [
+      path.call(print, 'expression'),
+      '(',
+      argumentsDoc
+    ]);
+  }
 };
 
 module.exports = FunctionCall;
diff --git a/src/nodes/MemberAccess.js b/src/nodes/MemberAccess.js
@@ -1,6 +1,6 @@
 const {
   doc: {
-    builders: { group, indent, softline }
+    builders: { group, ifBreak, indent, softline }
   }
 } = require('prettier/standalone');
 
@@ -33,11 +33,22 @@ const shallIndent = (path) => {
 
 const MemberAccess = {
   print: ({ node, path, print }) => {
+    const expressionDoc = path.call(print, 'expression');
+    let separator = [softline, '.'];
+    let labelData;
+    if (expressionDoc.label) {
+      labelData = JSON.parse(expressionDoc.label);
+    }
+    if (labelData && labelData.groupId) {
+      separator = ifBreak('.', [softline, '.'], {
+        groupId: labelData.groupId
+      });
+    }
+
     const doc = [
-      path.call(print, 'expression'),
-      shallIndent(path)
-        ? indent([softline, '.', node.memberName])
-        : [softline, '.', node.memberName]
+      expressionDoc,
+      shallIndent(path) ? indent(separator) : separator,
+      node.memberName
     ];
 
     return isBeginnigOfChain(path) ? group(doc) : doc;

diff --git a/src/nodes/print-separated-list.js b/src/nodes/print-separated-list.js
@@ -14,10 +14,14 @@ const {
 const printSeparatedList = (
   list,
   {
+    groupId = undefined,
     firstSeparator = softline,
     separator = [',', line],
     lastSeparator = firstSeparator
   } = {}
-) => group([indent([firstSeparator, join(separator, list)]), lastSeparator]);
-
+) =>
+  group(
+    [indent([firstSeparator, join(separator, list)]), lastSeparator],
+    groupId ? { id: groupId } : {}
+  );
 module.exports = printSeparatedList;
diff --git a/tests/FunctionCalls/__snapshots__/jsfmt.spec.js.snap b/tests/FunctionCalls/__snapshots__/jsfmt.spec.js.snap
@@ -81,8 +81,7 @@ contract FunctionCalls {
                         keccak256(req.data)
                     )
                 )
-            )
-            ._hashTypedDataV2(
+            )._hashTypedDataV2(
                 keccak256(
                     abi.encode(
                         TYPEHASH,
@@ -94,8 +93,7 @@ contract FunctionCalls {
                         keccak256(req.data)
                     )
                 )
-            )
-            ._hashTypedDataV3(
+            )._hashTypedDataV3(
                 keccak256(
                     abi.encode(
                         TYPEHASH,
@@ -107,8 +105,7 @@ contract FunctionCalls {
                         keccak256(req.data)
                     )
                 )
-            )
-            .recover(signature);
+            ).recover(signature);
         signer = _hashTypedDataV1(
             keccak256(
                 abi.encode(
@@ -121,8 +118,7 @@ contract FunctionCalls {
                     keccak256(req.data)
                 )
             )
-        )
-        ._hashTypedDataV2(
+        )._hashTypedDataV2(
             keccak256(
                 abi.encode(
                     TYPEHASH,
@@ -134,8 +130,7 @@ contract FunctionCalls {
                     keccak256(req.data)
                 )
             )
-        )
-        ._hashTypedDataV3(
+        )._hashTypedDataV3(
             keccak256(
                 abi.encode(
                     TYPEHASH,
@@ -147,8 +142,7 @@ contract FunctionCalls {
                     keccak256(req.data)
                 )
             )
-        )
-        .recover(signature);
+        ).recover(signature);
         return _nonces[req.from] == req.nonce && signer == req.from;
     }
 }
@@ -236,8 +230,7 @@ contract FunctionCalls {
                         keccak256(req.data)
                     )
                 )
-            )
-            ._hashTypedDataV2(
+            )._hashTypedDataV2(
                 keccak256(
                     abi.encode(
                         TYPEHASH,
@@ -249,8 +242,7 @@ contract FunctionCalls {
                         keccak256(req.data)
                     )
                 )
-            )
-            ._hashTypedDataV3(
+            )._hashTypedDataV3(
                 keccak256(
                     abi.encode(
                         TYPEHASH,
@@ -262,8 +254,7 @@ contract FunctionCalls {
                         keccak256(req.data)
                     )
                 )
-            )
-            .recover(signature);
+            ).recover(signature);
         signer = _hashTypedDataV1(
             keccak256(
                 abi.encode(
@@ -276,8 +267,7 @@ contract FunctionCalls {
                     keccak256(req.data)
                 )
             )
-        )
-        ._hashTypedDataV2(
+        )._hashTypedDataV2(
             keccak256(
                 abi.encode(
                     TYPEHASH,
@@ -289,8 +279,7 @@ contract FunctionCalls {
                     keccak256(req.data)
                 )
             )
-        )
-        ._hashTypedDataV3(
+        )._hashTypedDataV3(
             keccak256(
                 abi.encode(
                     TYPEHASH,
@@ -302,8 +291,7 @@ contract FunctionCalls {
                     keccak256(req.data)
                 )
             )
-        )
-        .recover(signature);
+        ).recover(signature);
         return _nonces[req.from] == req.nonce && signer == req.from;
     }
 }