comments for storage layout

Author: Janther

src/comments/handlers/handleContractDefinitionComments.js

@@ -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;
     }

tests/format/Comments/Comments.sol

@@ -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
 }

tests/format/Comments/__snapshots__/jsfmt.spec.js.snap

@@ -47,6 +47,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
 }
@@ -223,6 +235,45 @@ contract Comments4 is
     // solhint-disable-previous-line no-empty-blocks
 }
 
+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
 }