Merge remote-tracking branch 'origin/main' into v2

# Conflicts:
#	package-lock.json
#	package.json
#	tests/format/Comments/__snapshots__/format.test.js.snap
#	tests/format/InheritanceSpecifier/__snapshots__/format.test.js.snap

Author: Janther

FUNDING.json

@@ -0,0 +1,8 @@
+{
+  "drips": {
+    "ethereum": { "ownedBy": "0x2E4BE2aEd637E1EbC712f8169f25f0b48e1cbb58" }
+  },
+  "opRetro": {
+    "projectId": "0xc6cac7cd3793888032cc8a9e5aef92550beeec2598f86f1ec6972ffd5b82a990"
+  }
+}

funding.json

@@ -91,7 +91,7 @@
     "c8": "^10.1.3",
     "cross-env": "^7.0.3",
     "eslint": "^9.25.1",
-    "eslint-config-prettier": "10.1.2",
+    "eslint-config-prettier": "^10.1.2",
     "esm-utils": "^4.3.0",
     "jest": "^29.7.0",
     "jest-light-runner": "^0.7.8",
@@ -109,7 +109,7 @@
   },
   "dependencies": {
     "@nomicfoundation/slang": "1.0.0",
-    "@solidity-parser/parser": "^0.19.0",
+    "@solidity-parser/parser": "^0.20.1",
     "semver": "^7.7.1"
   },
   "peerDependencies": {

package-lock.json

@@ -27,10 +27,19 @@ function handleContractDefinitionComments({
   );
 
   // The comment is behind the start of the Block `{}` or behind a base contract
-  if (followingNode?.type === 'InheritanceSpecifier' || nextCharacter === '{') {
+  if (
+    (followingNode &&
+      (followingNode.type === 'InheritanceSpecifier' ||
+        followingNode === enclosingNode.storageLayout)) ||
+    nextCharacter === '{'
+  ) {
     // In this scenario the comment belongs to a base contract.
     //   contract A is B, /* comment for B */ C /* comment for C */ {}
-    if (precedingNode?.type === 'InheritanceSpecifier') {
+    if (
+      precedingNode &&
+      (precedingNode.type === 'InheritanceSpecifier' ||
+        precedingNode === enclosingNode.storageLayout)
+    ) {
       addTrailingComment(precedingNode, comment);
       return true;
     }

package.json

@@ -6,17 +6,37 @@ import {
   printSeparatedList
 } from '../common/printer-helpers.js';
 
-const { group, line, hardline } = doc.builders;
+const { group, hardline, ifBreak, line, softline } = doc.builders;
 
-const inheritance = (node, path, print) =>
-  node.baseContracts.length > 0
-    ? [
-        ' is',
-        printSeparatedList(path.map(print, 'baseContracts'), {
-          firstSeparator: line
-        })
-      ]
-    : line;
+const specifiers = (node, path, print) => {
+  const document = [];
+  if (node.baseContracts.length > 0) {
+    document.push([
+      'is',
+      printSeparatedList(path.map(print, 'baseContracts'), {
+        firstSeparator: line
+      })
+    ]);
+  }
+  if (node.storageLayout) {
+    document.push([
+      'layout at',
+      printSeparatedItem(path.call(print, 'storageLayout'), {
+        firstSeparator: line
+      })
+    ]);
+  }
+  if (document.length === 0) return line;
+  if (document.length === 1) return [' ', document];
+  const groupId = Symbol('ContractSpecifiers.inheritance');
+  return printSeparatedList(
+    [group(document[0], { id: groupId }), document[1]],
+    {
+      firstSeparator: line,
+      separator: ifBreak('', softline, { groupId })
+    }
+  );
+};
 
 const body = (node, path, options, print) => {
   const comments = printComments(node, path, options);
@@ -34,7 +54,7 @@ export const ContractDefinition = {
       node.kind === 'abstract' ? 'abstract contract' : node.kind,
       ' ',
       node.name,
-      inheritance(node, path, print),
+      specifiers(node, path, print),
       '{'
     ]),
     body(node, path, options, print),

src/comments/handlers/handleContractDefinitionComments.js

@@ -38,6 +38,18 @@ contract Comments4 is Interface1, Interface2, Interface3, Interface4, Interface5
   // solhint-disable-previous-line no-empty-blocks
 }
 
+contract Comments4a is Interface1, Interface2, Interface3, Interface4, Interface5, Interface6 /*why we used Interface6*/ layout /*where should this go?*/at 123/*why we used this layout*/ {
+  // solhint-disable-previous-line no-empty-blocks
+}
+
+contract Comments4b is Interface1, Interface2, Interface3, Interface4, Interface5, Interface6 /*why we used Interface6*/ layout /*where should this go?*/at 123 + 456/*why we used this layout*/ {
+  // solhint-disable-previous-line no-empty-blocks
+}
+
+contract Comments4c is Interface1, Interface2, Interface3, Interface4, Interface5, Interface6 /*why we used Interface6*/ layout /*where should this go?*/at f(123 + 456)/*why we used this layout*/ {
+  // solhint-disable-previous-line no-empty-blocks
+}
+
 contract Comments5 /*nice name*/ {
   // solhint-disable-previous-line no-empty-blocks
 }

src/nodes/ContractDefinition.js

@@ -46,6 +46,18 @@ contract Comments4 is Interface1, Interface2, Interface3, Interface4, Interface5
   // solhint-disable-previous-line no-empty-blocks
 }
 
+contract Comments4a is Interface1, Interface2, Interface3, Interface4, Interface5, Interface6 /*why we used Interface6*/ layout /*where should this go?*/at 123/*why we used this layout*/ {
+  // solhint-disable-previous-line no-empty-blocks
+}
+
+contract Comments4b is Interface1, Interface2, Interface3, Interface4, Interface5, Interface6 /*why we used Interface6*/ layout /*where should this go?*/at 123 + 456/*why we used this layout*/ {
+  // solhint-disable-previous-line no-empty-blocks
+}
+
+contract Comments4c is Interface1, Interface2, Interface3, Interface4, Interface5, Interface6 /*why we used Interface6*/ layout /*where should this go?*/at f(123 + 456)/*why we used this layout*/ {
+  // solhint-disable-previous-line no-empty-blocks
+}
+
 contract Comments5 /*nice name*/ {
   // solhint-disable-previous-line no-empty-blocks
 }
@@ -221,7 +233,46 @@ contract Comments4 is
     // solhint-disable-previous-line no-empty-blocks
 }
 
-contract Comments5 /*nice name*/ {
+contract Comments4a
+    is
+        Interface1,
+        Interface2,
+        Interface3,
+        Interface4,
+        Interface5,
+        Interface6 /*why we used Interface6*/ /*where should this go?*/
+    layout at 123 /*why we used this layout*/
+{
+    // solhint-disable-previous-line no-empty-blocks
+}
+
+contract Comments4b
+    is
+        Interface1,
+        Interface2,
+        Interface3,
+        Interface4,
+        Interface5,
+        Interface6 /*why we used Interface6*/ /*where should this go?*/
+    layout at 123 + 456 /*why we used this layout*/
+{
+    // solhint-disable-previous-line no-empty-blocks
+}
+
+contract Comments4c
+    is
+        Interface1,
+        Interface2,
+        Interface3,
+        Interface4,
+        Interface5,
+        Interface6 /*why we used Interface6*/ /*where should this go?*/
+    layout at f(123 + 456) /*why we used this layout*/
+{
+    // solhint-disable-previous-line no-empty-blocks
+}
+
+/*nice name*/ contract Comments5 {
     // solhint-disable-previous-line no-empty-blocks
 }
 

tests/format/Comments/Comments.sol

@@ -1,2 +1,48 @@
 contract ContractDefinition is Contract1, Contract2, Contract3, Contract4, Contract5 {
 }
+
+contract StorageLayoutSpecifier layout   at 123 {
+}
+
+contract StorageLayoutSpecifier1 layout   at 1234567890 * 1234567890 - 1234567890 / 1234567890 {
+}
+
+contract StorageLayoutSpecifier2 layout  at veryVeryLongFunction(12345678901234567890 * 12345678901234567890 - 12345678901234567890 / 12345678901234567890 + 12345678901234567890 - 12345678901234567890) {
+}
+
+contract StorageLayoutSpecifier3 is Contract1   layout   at 123 {
+}
+
+contract StorageLayoutSpecifier4 is Contract1, Contract2, Contract3, Contract4, Contract5 layout   at 123{
+}
+
+contract StorageLayoutSpecifier5 is Contract1, Contract2, Contract3, Contract4, Contract5 layout   at 1234567890 * 1234567890 - 1234567890 / 1234567890{
+}
+
+contract StorageLayoutSpecifier6 is Contract1, Contract2, Contract3, Contract4, Contract5 layout   at veryVeryLongFunction(12345678901234567890 * 12345678901234567890 - 12345678901234567890 / 12345678901234567890 + 12345678901234567890 - 12345678901234567890){
+}
+
+contract StorageLayoutSpecifier7 is Contract1, Contract2, Contract3, Contract4, Contract5, Contract6, Contract7 layout   at 123{
+}
+
+contract StorageLayoutSpecifier8 is Contract1, Contract2, Contract3, Contract4, Contract5, Contract6, Contract7 layout   at 1234567890 * 1234567890 - 1234567890 / 1234567890{
+}
+
+contract StorageLayoutSpecifier9 is Contract1, Contract2, Contract3, Contract4, Contract5, Contract6, Contract7 layout   at veryVeryLongFunction(12345678901234567890 * 12345678901234567890 - 12345678901234567890 / 12345678901234567890 + 12345678901234567890 - 12345678901234567890){
+}
+
+contract InheritanceSpecifier1 is SomeOtherContract(1234,false) {}
+
+contract InheritanceSpecifier2 is SomeOtherContract(1234,false)  layout   at 123 {}
+
+contract InheritanceSpecifier3 is SomeOtherContract(1234,false) layout   at 1234567890 * 1234567890 - 1234567890 / 1234567890 {}
+
+contract InheritanceSpecifier4 is SomeOtherContract(1234,false) layout   at veryVeryLongFunction(12345678901234567890 * 12345678901234567890 - 12345678901234567890 / 12345678901234567890 + 12345678901234567890 - 12345678901234567890) {}
+
+contract LongInheritanceSpecifier1 is SomeOtherContract(123467890,false,0xCA35b7d915458EF540aDe6068dFe2F44E8fa733c) {}
+
+contract LongInheritanceSpecifier2 is SomeOtherContract(123467890,false,0xCA35b7d915458EF540aDe6068dFe2F44E8fa733c) layout   at 123 {}
+
+contract LongInheritanceSpecifier3 is SomeOtherContract(123467890,false,0xCA35b7d915458EF540aDe6068dFe2F44E8fa733c) layout   at 1234567890 * 1234567890 - 1234567890 / 1234567890 {}
+
+contract LongInheritanceSpecifier4 is SomeOtherContract(123467890,false,0xCA35b7d915458EF540aDe6068dFe2F44E8fa733c) layout   at veryVeryLongFunction(12345678901234567890 * 12345678901234567890 - 12345678901234567890 / 12345678901234567890 + 12345678901234567890 - 12345678901234567890){}