standardising all assignment types (#1437)

Janther · web-flow · commit 29647cbcb607 · 2026-03-04T12:27:29.000-03:00
diff --git a/src/binary-operator-printers/assignment.js b/src/binary-operator-printers/assignment.js
@@ -1,4 +1,5 @@
 import { doc } from 'prettier';
+import { printAssignmentRightSide } from '../common/printer-helpers.js';
 
 const { group, line, indent } = doc.builders;
 
@@ -19,10 +20,7 @@ export const assignment = {
     ].includes(op),
   print: (node, path, print) => [
     path.call(print, 'left'),
-    ' ',
-    node.operator,
-    node.right.type === 'BinaryOperation'
-      ? group(indent([line, path.call(print, 'right')]))
-      : [' ', path.call(print, 'right')]
+    ` ${node.operator}`,
+    printAssignmentRightSide(path.call(print, 'right'), node.right)
   ]
 };
diff --git a/src/common/printer-helpers.js b/src/common/printer-helpers.js
@@ -98,3 +98,14 @@ export const printSeparatedList = (
     lastSeparator,
     grouped
   });
+
+export const printAssignmentRightSide = (document, value) =>
+  [
+    'TupleExpression',
+    'FunctionCall',
+    'IndexAccess',
+    'NameValueExpression',
+    'MemberAccess'
+  ].includes(value.type)
+    ? [' ', document]
+    : group(indent([line, document]));
diff --git a/src/nodes/Conditional.js b/src/nodes/Conditional.js
@@ -55,11 +55,7 @@ const experimentalTernaries = (node, path, print, options) => {
         })
   ];
 
-  const document = group([conditionAndTrueExpressionGroup, falseExpressionDoc]);
-
-  return parent.type === 'VariableDeclarationStatement'
-    ? indent([softline, document])
-    : document;
+  return group([conditionAndTrueExpressionGroup, falseExpressionDoc]);
 };
 
 const traditionalTernaries = (path, print) =>
diff --git a/src/nodes/FileLevelConstant.js b/src/nodes/FileLevelConstant.js
@@ -1,10 +1,15 @@
+import { printAssignmentRightSide } from '../common/printer-helpers.js';
+
 export const FileLevelConstant = {
   print: ({ node, path, print }) => [
     path.call(print, 'typeName'),
     ' constant ',
     node.name,
-    ' = ',
-    path.call(print, 'initialValue'),
+    ' =',
+    printAssignmentRightSide(
+      path.call(print, 'initialValue'),
+      node.initialValue
+    ),
     ';'
   ]
 };
diff --git a/src/nodes/StateVariableDeclaration.js b/src/nodes/StateVariableDeclaration.js
@@ -1,17 +1,17 @@
-import { doc } from 'prettier';
-
-const { group, indent, line } = doc.builders;
+import { printAssignmentRightSide } from '../common/printer-helpers.js';
 
 const initialValue = (node, path, print) => {
   if (!node.initialValue) {
     return '';
   }
 
-  if (node.initialValue.type === 'TupleExpression') {
-    return [' = ', path.call(print, 'initialValue')];
-  }
-
-  return group([' =', indent([line, path.call(print, 'initialValue')])]);
+  return [
+    ' =',
+    printAssignmentRightSide(
+      path.call(print, 'initialValue'),
+      node.initialValue
+    )
+  ];
 };
 
 export const StateVariableDeclaration = {
diff --git a/src/nodes/VariableDeclarationStatement.js b/src/nodes/VariableDeclarationStatement.js
@@ -1,13 +1,27 @@
 import { doc } from 'prettier';
-import { printSeparatedList } from '../common/printer-helpers.js';
+import {
+  printAssignmentRightSide,
+  printSeparatedList
+} from '../common/printer-helpers.js';
 
-const { group, indentIfBreak } = doc.builders;
+const { group, indentIfBreak, line } = doc.builders;
 
 const embraceVariables = (document, embrace) =>
   embrace ? ['(', printSeparatedList(document), ')'] : document;
 
-const initialValue = (node, path, print) =>
-  node.initialValue ? [' = ', path.call(print, 'initialValue')] : '';
+const initialValue = (node, path, print) => {
+  if (!node.initialValue) {
+    return '';
+  }
+
+  return [
+    ' =',
+    printAssignmentRightSide(
+      path.call(print, 'initialValue'),
+      node.initialValue
+    )
+  ];
+};
 
 export const VariableDeclarationStatement = {
   print: ({ node, path, print }) => {
diff --git a/src/slang-nodes/AssignmentExpression.ts b/src/slang-nodes/AssignmentExpression.ts
@@ -1,11 +1,8 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
-import { isBinaryOperation } from '../slang-utils/is-binary-operation.js';
-import { printIndentedGroupOrSpacedDocument } from '../slang-printers/print-indented-group-or-spaced-document.js';
 import { extractVariant } from '../slang-utils/extract-variant.js';
-import { isMultilineString } from '../slang-utils/is-multiline-string.js';
+import { printAssignmentRightSide } from '../slang-printers/print-assignment-right-side.js';
 import { SlangNode } from './SlangNode.js';
 import { Expression } from './Expression.js';
-import { TerminalNode } from './TerminalNode.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
 import type { AstPath, Doc, ParserOptions } from 'prettier';
@@ -43,11 +40,9 @@ export class AssignmentExpression extends SlangNode {
     return [
       path.call(print, 'leftOperand'),
       ` ${this.operator}`,
-      printIndentedGroupOrSpacedDocument(
+      printAssignmentRightSide(
         path.call(print, 'rightOperand'),
-        !(this.rightOperand instanceof TerminalNode) &&
-          (isBinaryOperation(this.rightOperand) ||
-            isMultilineString(this.rightOperand))
+        this.rightOperand
       )
     ];
   }
diff --git a/src/slang-nodes/ConditionalExpression.ts b/src/slang-nodes/ConditionalExpression.ts
@@ -10,7 +10,7 @@ import type { AstPath, Doc, ParserOptions } from 'prettier';
 import type { CollectedMetadata, PrintFunction } from '../types.d.ts';
 import type { AstNode, StrictAstNode } from './types.d.ts';
 
-const { group, hardline, ifBreak, indent, line, softline } = doc.builders;
+const { group, hardline, ifBreak, indent, line } = doc.builders;
 
 function experimentalTernaries(
   node: ConditionalExpression,
@@ -73,11 +73,7 @@ function experimentalTernaries(
         )
   ];
 
-  const document = group([conditionAndTrueExpressionGroup, falseExpressionDoc]);
-
-  return parent.kind === NonterminalKind.VariableDeclarationValue
-    ? group(indent([softline, document]))
-    : document;
+  return group([conditionAndTrueExpressionGroup, falseExpressionDoc]);
 }
 
 function traditionalTernaries(
diff --git a/src/slang-nodes/ConstantDefinition.ts b/src/slang-nodes/ConstantDefinition.ts
@@ -1,5 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { extractVariant } from '../slang-utils/extract-variant.js';
+import { printAssignmentRightSide } from '../slang-printers/print-assignment-right-side.js';
 import { SlangNode } from './SlangNode.js';
 import { TypeName } from './TypeName.js';
 import { TerminalNode } from './TerminalNode.js';
@@ -40,8 +41,8 @@ export class ConstantDefinition extends SlangNode {
       path.call(print, 'typeName'),
       ' constant ',
       path.call(print, 'name'),
-      ' = ',
-      path.call(print, 'value'),
+      ' =',
+      printAssignmentRightSide(path.call(print, 'value'), this.value),
       ';'
     ];
   }
diff --git a/src/slang-nodes/MemberAccessExpression.ts b/src/slang-nodes/MemberAccessExpression.ts
@@ -1,31 +1,25 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { doc } from 'prettier';
 import { isLabel } from '../slang-utils/is-label.js';
-import { createKindCheckFunction } from '../slang-utils/create-kind-check-function.js';
 import { extractVariant } from '../slang-utils/extract-variant.js';
+import { isChainableExpression } from '../slang-utils/is-chainable-expression.js';
 import { SlangNode } from './SlangNode.js';
 import { Expression } from './Expression.js';
 import { TerminalNode } from './TerminalNode.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
 import type { AstPath, Doc, ParserOptions } from 'prettier';
 import type { CollectedMetadata, PrintFunction } from '../types.d.ts';
-import type { AstNode, StrictAstNode } from './types.d.ts';
+import type { AstNode } from './types.d.ts';
 
 const { group, indent, label, softline } = doc.builders;
 
-const isChainableExpression = createKindCheckFunction([
-  NonterminalKind.FunctionCallExpression,
-  NonterminalKind.IndexAccessExpression,
-  NonterminalKind.MemberAccessExpression
-]);
-
 function isEndOfChain(
   node: MemberAccessExpression,
-  path: AstPath<StrictAstNode>
+  path: AstPath<Expression['variant']>
 ): boolean {
   for (
-    let i = 1, current: StrictAstNode = node, parent = path.getNode(i);
+    let i = 1, current: Expression['variant'] = node, parent = path.getNode(i);
     parent && isChainableExpression(parent);
     i++, current = parent, parent = path.getNode(i)
   ) {
diff --git a/src/slang-nodes/StateVariableDefinitionValue.ts b/src/slang-nodes/StateVariableDefinitionValue.ts
@@ -1,5 +1,5 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
-import { printIndentedGroupOrSpacedDocument } from '../slang-printers/print-indented-group-or-spaced-document.js';
+import { printAssignmentRightSide } from '../slang-printers/print-assignment-right-side.js';
 import { extractVariant } from '../slang-utils/extract-variant.js';
 import { SlangNode } from './SlangNode.js';
 import { Expression } from './Expression.js';
@@ -32,10 +32,7 @@ export class StateVariableDefinitionValue extends SlangNode {
   ): Doc {
     return [
       ' =',
-      printIndentedGroupOrSpacedDocument(
-        path.call(print, 'value'),
-        this.value.kind !== NonterminalKind.ArrayExpression
-      )
+      printAssignmentRightSide(path.call(print, 'value'), this.value)
     ];
   }
 }
diff --git a/src/slang-nodes/VariableDeclarationValue.ts b/src/slang-nodes/VariableDeclarationValue.ts
@@ -1,10 +1,8 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
+import { printAssignmentRightSide } from '../slang-printers/print-assignment-right-side.js';
 import { extractVariant } from '../slang-utils/extract-variant.js';
-import { printIndentedGroupOrSpacedDocument } from '../slang-printers/print-indented-group-or-spaced-document.js';
-import { isMultilineString } from '../slang-utils/is-multiline-string.js';
 import { SlangNode } from './SlangNode.js';
 import { Expression } from './Expression.js';
-import { TerminalNode } from './TerminalNode.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
 import type { AstPath, Doc, ParserOptions } from 'prettier';
@@ -33,11 +31,7 @@ export class VariableDeclarationValue extends SlangNode {
   print(path: AstPath<VariableDeclarationValue>, print: PrintFunction): Doc {
     return [
       ' =',
-      printIndentedGroupOrSpacedDocument(
-        path.call(print, 'expression'),
-        !(this.expression instanceof TerminalNode) &&
-          isMultilineString(this.expression)
-      )
+      printAssignmentRightSide(path.call(print, 'expression'), this.expression)
     ];
   }
 }
diff --git a/src/slang-printers/print-assignment-right-side.ts b/src/slang-printers/print-assignment-right-side.ts
@@ -0,0 +1,17 @@
+import { NonterminalKind } from '@nomicfoundation/slang/cst';
+import { isChainableExpression } from '../slang-utils/is-chainable-expression.js';
+import { printIndentedGroupOrSpacedDocument } from './print-indented-group-or-spaced-document.js';
+
+import type { Doc, doc } from 'prettier';
+import type { Expression } from '../slang-nodes/Expression.js';
+
+export function printAssignmentRightSide(
+  document: Doc,
+  value: Expression['variant']
+): doc.builders.Group | [' ', Doc] {
+  return printIndentedGroupOrSpacedDocument(
+    document,
+    value.kind !== NonterminalKind.ArrayExpression &&
+      !isChainableExpression(value)
+  );
+}
diff --git a/src/slang-utils/is-chainable-expression.ts b/src/slang-utils/is-chainable-expression.ts
@@ -0,0 +1,10 @@
+import { NonterminalKind } from '@nomicfoundation/slang/cst';
+import { createKindCheckFunction } from './create-kind-check-function.js';
+
+import type { Expression } from '../slang-nodes/Expression.js';
+
+export const isChainableExpression = createKindCheckFunction([
+  NonterminalKind.FunctionCallExpression,
+  NonterminalKind.IndexAccessExpression,
+  NonterminalKind.MemberAccessExpression
+]) as (node: Expression['variant']) => boolean;
diff --git a/src/slang-utils/is-multiline-string.ts b/src/slang-utils/is-multiline-string.ts
diff --git a/tests/config/run-format-test.js b/tests/config/run-format-test.js
@@ -85,8 +85,6 @@ 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 why this test doesn't match.
-    "MultipartStrings/MultipartStrings.sol",
   ].map((fixture) => {
     const [file, compareBytecode = () => true] = Array.isArray(fixture)
       ? fixture
diff --git a/tests/format/BinaryOperators/__snapshots__/format.test.js.snap b/tests/format/BinaryOperators/__snapshots__/format.test.js.snap
@@ -482,10 +482,11 @@ contract ComparisonOperators {
             a = veryVeryVeryVeryVeryLongVariableCalledA;
             veryVeryVeryVeryVeryLongVariableCalledB
             >= veryVeryVeryVeryVeryLongVariableCalledA;
-            a += veryVeryVeryVeryVeryLongVariableCalledA
-                || veryVeryVeryVeryVeryLongVariableCalledB
-                ? 1
-                : 2
+            a +=
+                veryVeryVeryVeryVeryLongVariableCalledA
+                    || veryVeryVeryVeryVeryLongVariableCalledB
+                    ? 1
+                    : 2
         ) {}
         a(
             veryVeryVeryVeryVeryLongVariableCalledA
@@ -635,10 +636,11 @@ contract LogicalOperators {
         for (
             a = veryVeryVeryVeryVeryLongVariableCalledA;
             a <= veryVeryVeryVeryVeryLongVariableCalledA;
-            a += veryVeryVeryVeryVeryLongVariableCalledA
-                || veryVeryVeryVeryVeryLongVariableCalledB
-                ? 1
-                : 2
+            a +=
+                veryVeryVeryVeryVeryLongVariableCalledA
+                    || veryVeryVeryVeryVeryLongVariableCalledB
+                    ? 1
+                    : 2
         ) {}
         a(
             veryVeryVeryVeryVeryLongVariableCalledA
@@ -1163,10 +1165,11 @@ contract ComparisonOperators {
             a = veryVeryVeryVeryVeryLongVariableCalledA;
             veryVeryVeryVeryVeryLongVariableCalledB >=
             veryVeryVeryVeryVeryLongVariableCalledA;
-            a += veryVeryVeryVeryVeryLongVariableCalledA ||
-                veryVeryVeryVeryVeryLongVariableCalledB
-                ? 1
-                : 2
+            a +=
+                veryVeryVeryVeryVeryLongVariableCalledA ||
+                    veryVeryVeryVeryVeryLongVariableCalledB
+                    ? 1
+                    : 2
         ) {}
         a(
             veryVeryVeryVeryVeryLongVariableCalledA ==
@@ -1316,10 +1319,11 @@ contract LogicalOperators {
         for (
             a = veryVeryVeryVeryVeryLongVariableCalledA;
             a <= veryVeryVeryVeryVeryLongVariableCalledA;
-            a += veryVeryVeryVeryVeryLongVariableCalledA ||
-                veryVeryVeryVeryVeryLongVariableCalledB
-                ? 1
-                : 2
+            a +=
+                veryVeryVeryVeryVeryLongVariableCalledA ||
+                    veryVeryVeryVeryVeryLongVariableCalledB
+                    ? 1
+                    : 2
         ) {}
         a(
             veryVeryVeryVeryVeryLongVariableCalledA ||
diff --git a/tests/format/Conditional/__snapshots__/format.test.js.snap b/tests/format/Conditional/__snapshots__/format.test.js.snap
@@ -38,9 +38,8 @@ pragma solidity ^0.4.24;
 
 contract Conditional {
     function foo() {
-        address contextAddress = longAddress_ == address(0)
-            ? msg.sender
-            : currentContextAddress_;
+        address contextAddress =
+            longAddress_ == address(0) ? msg.sender : currentContextAddress_;
         asset == ETH
             ? require(
                 address(uint160(msg.sender)).send(quantity),
diff --git a/tests/format/ExperimentalTernaries/__snapshots__/format.test.js.snap b/tests/format/ExperimentalTernaries/__snapshots__/format.test.js.snap
diff --git a/tests/format/StringLiteral/__snapshots__/format.test.js.snap b/tests/format/StringLiteral/__snapshots__/format.test.js.snap
diff --git a/tests/format/strings/__snapshots__/format.test.js.snap b/tests/format/strings/__snapshots__/format.test.js.snap
