Skip to content

Adding Parentheses on consecutive equality operators #1132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Janther merged 2 commits into from
Jun 6, 2025
Merged

Adding Parentheses on consecutive equality operators #1132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d46833c
Adding Parentheses on consecutive equality operators
Janther Mar 10, 2025
dcf09e4
updating snaptshots
Janther May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/parser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,10 @@ function parse(text, _parsers, options = _parsers) {
'&'
]);
break;
case '==':
case '!=':
ctx.left = tryHug(ctx.left, ['==', '!=']);
break;
case '||':
ctx.left = tryHug(ctx.left, ['&&']);
ctx.right = tryHug(ctx.right, ['&&']);
Expand Down
5 changes: 5 additions & 0 deletions src/slang-nodes/EqualityExpression.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { NonterminalKind } from '@nomicfoundation/slang/cst';
import { printComparisonOperation } from '../slang-printers/print-comparison-operation.js';
import { createHugFunction } from '../slang-utils/create-hug-function.js';
import { getNodeMetadata, updateMetadata } from '../slang-utils/metadata.js';
import { Expression } from './Expression.js';

Expand All @@ -8,6 +9,8 @@ import type { AstPath, Doc, ParserOptions } from 'prettier';
import type { AstNode } from './types.d.ts';
import type { PrintFunction, SlangNode } from '../types.d.ts';

const tryToHug = createHugFunction(['==', '!=']);

export class EqualityExpression implements SlangNode {
readonly kind = NonterminalKind.EqualityExpression;

Expand All @@ -32,6 +35,8 @@ export class EqualityExpression implements SlangNode {

this.comments = metadata.comments;
this.loc = metadata.loc;

this.leftOperand = tryToHug(this.leftOperand);
}

print(
Expand Down
24 changes: 12 additions & 12 deletions tests/format/BinaryOperationHierarchy/__snapshots__/format.test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1029,10 +1029,10 @@ contract Group {
veryVeryVeryLongUint256A ==
veryVeryVeryLongUint256B ^ veryVeryVeryLongUint256C;
resultBoolean =
veryVeryVeryLongUint256A == veryVeryVeryLongUint256B ==
(veryVeryVeryLongUint256A == veryVeryVeryLongUint256B) ==
veryVeryVeryLongBooleanC;
resultBoolean =
veryVeryVeryLongUint256A == veryVeryVeryLongUint256B !=
(veryVeryVeryLongUint256A == veryVeryVeryLongUint256B) !=
veryVeryVeryLongBooleanC;
resultBoolean =
veryVeryVeryLongBooleanA ==
Expand Down Expand Up @@ -1083,10 +1083,10 @@ contract Group {
veryVeryVeryLongUint256A !=
veryVeryVeryLongUint256B ^ veryVeryVeryLongUint256C;
resultBoolean =
veryVeryVeryLongUint256A != veryVeryVeryLongUint256B ==
(veryVeryVeryLongUint256A != veryVeryVeryLongUint256B) ==
veryVeryVeryLongBooleanC;
resultBoolean =
veryVeryVeryLongUint256A != veryVeryVeryLongUint256B !=
(veryVeryVeryLongUint256A != veryVeryVeryLongUint256B) !=
veryVeryVeryLongBooleanC;
resultBoolean =
veryVeryVeryLongBooleanA !=
Expand Down Expand Up @@ -2515,12 +2515,12 @@ contract Indent {
veryVeryVeryExtremelyExtremelyLongUint256B ^
veryVeryVeryExtremelyExtremelyLongUint256C;
resultBoolean =
veryVeryVeryExtremelyExtremelyLongUint256A ==
veryVeryVeryExtremelyExtremelyLongUint256B ==
(veryVeryVeryExtremelyExtremelyLongUint256A ==
veryVeryVeryExtremelyExtremelyLongUint256B) ==
veryVeryVeryExtremelyExtremelyLongBooleanC;
resultBoolean =
veryVeryVeryExtremelyExtremelyLongUint256A ==
veryVeryVeryExtremelyExtremelyLongUint256B !=
(veryVeryVeryExtremelyExtremelyLongUint256A ==
veryVeryVeryExtremelyExtremelyLongUint256B) !=
veryVeryVeryExtremelyExtremelyLongBooleanC;
resultBoolean =
veryVeryVeryExtremelyExtremelyLongBooleanA ==
Expand Down Expand Up @@ -2586,12 +2586,12 @@ contract Indent {
veryVeryVeryExtremelyExtremelyLongUint256B ^
veryVeryVeryExtremelyExtremelyLongUint256C;
resultBoolean =
veryVeryVeryExtremelyExtremelyLongUint256A !=
veryVeryVeryExtremelyExtremelyLongUint256B ==
(veryVeryVeryExtremelyExtremelyLongUint256A !=
veryVeryVeryExtremelyExtremelyLongUint256B) ==
veryVeryVeryExtremelyExtremelyLongBooleanC;
resultBoolean =
veryVeryVeryExtremelyExtremelyLongUint256A !=
veryVeryVeryExtremelyExtremelyLongUint256B !=
(veryVeryVeryExtremelyExtremelyLongUint256A !=
veryVeryVeryExtremelyExtremelyLongUint256B) !=
veryVeryVeryExtremelyExtremelyLongBooleanC;
resultBoolean =
veryVeryVeryExtremelyExtremelyLongBooleanA !=
Expand Down
108 changes: 108 additions & 0 deletions tests/format/Parentheses/EqualParentheses.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;

contract EqualParentheses {
function notEqualAdd(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a == b + c;
}

function notEqualSub(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a == b - c;
}

function notEqualMul(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a == b * c;
}

function notEqualDiv(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a == b / c;
}

function notEqualMod(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a == b % c;
}

function notEqualExp(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a == b ** c;
}

function notEqualShiftL(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a == b << c;
}

function notEqualShiftR(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a == b >> c;
}

function notEqualBitAnd(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a == b & c;
}

function notEqualBitOr(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a == b | c;
}

function notEqualBitXor(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a == b ^ c;
}

function notEqualEqual(bool a, bool b, bool c)
public
pure
returns (bool)
{
return a == b == c;
}

function notEqualNotEqual(bool a, bool b, bool c)
public
pure
returns (bool)
{
return a == b != c;
}
}
16 changes: 16 additions & 0 deletions tests/format/Parentheses/LogicNoParentheses.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,20 @@ contract LogicNoParentheses {
function andAnd(bool a, bool b, bool c) public pure returns (bool) {
return a && b && c;
}

function equalEqual(bool a, bool b, bool c) public pure returns (bool) {
return a == b == c;
}

function equalNotEqual(bool a, bool b, bool c) public pure returns (bool) {
return a == b != c;
}

function notEqualEqual(bool a, bool b, bool c) public pure returns (bool) {
return a != b == c;
}

function notEqualNotEqual(bool a, bool b, bool c) public pure returns (bool) {
return a != b != c;
}
}
108 changes: 108 additions & 0 deletions tests/format/Parentheses/NotEqualParentheses.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;

contract NotEqualParentheses {
function notEqualAdd(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a != b + c;
}

function notEqualSub(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a != b - c;
}

function notEqualMul(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a != b * c;
}

function notEqualDiv(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a != b / c;
}

function notEqualMod(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a != b % c;
}

function notEqualExp(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a != b ** c;
}

function notEqualShiftL(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a != b << c;
}

function notEqualShiftR(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a != b >> c;
}

function notEqualBitAnd(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a != b & c;
}

function notEqualBitOr(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a != b | c;
}

function notEqualBitXor(uint256 a, uint256 b, uint256 c)
public
pure
returns (bool)
{
return a != b ^ c;
}

function notEqualEqual(bool a, bool b, bool c)
public
pure
returns (bool)
{
return a != b == c;
}

function notEqualNotEqual(bool a, bool b, bool c)
public
pure
returns (bool)
{
return a != b != c;
}
}
Loading