Patch assignment (#1454)

* Edge case for assignments

* patch version

* fix lint

* ignoring comparison with ANTLR

Author: Janther

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "prettier-plugin-solidity",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "A Prettier Plugin for automatically formatting your Solidity code.",
   "type": "module",
   "main": "./dist/index.js",

package.json

@@ -12,6 +12,7 @@ export function printAssignmentRightSide(
   return printIndentedGroupOrSpacedDocument(
     document,
     value.kind !== NonterminalKind.ArrayExpression &&
+      value.kind !== NonterminalKind.TupleExpression &&
       !isChainableExpression(value)
   );
 }

src/slang-printers/print-assignment-right-side.ts

@@ -85,6 +85,8 @@ const antlrMismatchTests = new Map(
     // ANTLR doesn't support UntypedTupleMember with a storage location, which
     // is valid Slang, but not in Solidity.
     "AllSolidityFeaturesV0.4.26/AllSolidityFeatures.sol",
+    // TODO Review how ANTLR is formatting chained assignments
+    "Assignments/Assignments.sol",
   ].map((fixture) => {
     const [file, compareBytecode = () => true] = Array.isArray(fixture)
       ? fixture

tests/config/run-format-test.js

@@ -0,0 +1,8 @@
+contract Assignments {
+    address payable public inParentheses = (contractPointer.functionCall(data.data1,data.data2,IERC20(data.token).decimals(),currency));
+    uint[] internal longArray = [item1,item2,item3,item4,item5,item6,item7,item8,item9,itema,itemb,itemc,itemd,iteme];
+    // TODO research what we want to do with chained assignments
+    function chainedAssignments() returns (bytes32 variableA, bytes32 variableB) { 
+    variableA = variableB = 0x1234567890abcdef1234567890abcdef ^ 0x1234567890abcdef1234567890abcdef;
+    }
+}

tests/format/Assignments/Assignments.sol

@@ -0,0 +1,56 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`Assignments.sol format 1`] = `
+====================================options=====================================
+parsers: ["slang"]
+printWidth: 80
+                                                                                | printWidth
+=====================================input======================================
+contract Assignments {
+    address payable public inParentheses = (contractPointer.functionCall(data.data1,data.data2,IERC20(data.token).decimals(),currency));
+    uint[] internal longArray = [item1,item2,item3,item4,item5,item6,item7,item8,item9,itema,itemb,itemc,itemd,iteme];
+    // TODO research what we want to do with chained assignments
+    function chainedAssignments() returns (bytes32 variableA, bytes32 variableB) { 
+    variableA = variableB = 0x1234567890abcdef1234567890abcdef ^ 0x1234567890abcdef1234567890abcdef;
+    }
+}
+
+=====================================output=====================================
+contract Assignments {
+    address payable public inParentheses = (
+        contractPointer.functionCall(
+            data.data1,
+            data.data2,
+            IERC20(data.token).decimals(),
+            currency
+        )
+    );
+    uint[] internal longArray = [
+        item1,
+        item2,
+        item3,
+        item4,
+        item5,
+        item6,
+        item7,
+        item8,
+        item9,
+        itema,
+        itemb,
+        itemc,
+        itemd,
+        iteme
+    ];
+    // TODO research what we want to do with chained assignments
+    function chainedAssignments()
+        returns (bytes32 variableA, bytes32 variableB)
+    {
+        variableA =
+            variableB =
+                0x1234567890abcdef1234567890abcdef ^
+                0x1234567890abcdef1234567890abcdef;
+    }
+}
+
+================================================================================
+`;

tests/format/Assignments/__snapshots__/format.test.js.snap

@@ -0,0 +1 @@
+runFormatTest(import.meta, ['slang']);