positioning the comments properly

Author: Janther

src/slang-comments/handlers/handle-contract-definition-comments.ts

@@ -52,16 +52,15 @@ export default function handleContractDefinitionComments({
       // If the last ContractSpecifier's an InheritanceSpecifier, the comment
       // is appended to the last InheritanceType.
       if (lastContractSpecifier.kind === NonterminalKind.InheritanceSpecifier) {
-        addTrailingComment(
-          lastContractSpecifier.types.items[
-            lastContractSpecifier.types.items.length - 1
-          ],
-          comment
-        );
+        addCollectionNodeLastComment(lastContractSpecifier.types, comment);
+        return true;
+      }
+      if (
+        lastContractSpecifier.kind === NonterminalKind.StorageLayoutSpecifier
+      ) {
+        addTrailingComment(lastContractSpecifier.expression, comment);
         return true;
       }
-      addTrailingComment(lastContractSpecifier, comment);
-      return true;
     }
   }
 

src/slang-comments/handlers/handle-contract-specifiers-comments.ts

@@ -0,0 +1,33 @@
+import { NonterminalKind } from '@nomicfoundation/slang/cst';
+import { util } from 'prettier';
+import addCollectionNodeLastComment from './add-collection-node-last-comment.js';
+
+import type { HandlerParams } from './types.d.ts';
+
+const { addTrailingComment } = util;
+
+export default function handleContractSpecifiersComments({
+  precedingNode,
+  enclosingNode,
+  comment
+}: HandlerParams): boolean {
+  if (enclosingNode?.kind !== NonterminalKind.ContractSpecifiers) {
+    return false;
+  }
+
+  if (
+    precedingNode &&
+    precedingNode.kind === NonterminalKind.ContractSpecifier
+  ) {
+    if (precedingNode.variant.kind === NonterminalKind.InheritanceSpecifier) {
+      addCollectionNodeLastComment(precedingNode.variant.types, comment);
+      return true;
+    }
+    if (precedingNode.variant.kind === NonterminalKind.StorageLayoutSpecifier) {
+      addTrailingComment(precedingNode.variant.expression, comment);
+      return true;
+    }
+  }
+
+  return false;
+}

src/slang-comments/handlers/handle-storage-layout-specifier-comments.ts

@@ -0,0 +1,23 @@
+import { NonterminalKind } from '@nomicfoundation/slang/cst';
+import { util } from 'prettier';
+
+import type { HandlerParams } from './types.d.ts';
+
+const { addLeadingComment } = util;
+
+export default function handleStorageLayoutSpecifierComments({
+  enclosingNode,
+  followingNode,
+  comment
+}: HandlerParams): boolean {
+  if (enclosingNode?.kind !== NonterminalKind.StorageLayoutSpecifier) {
+    return false;
+  }
+
+  if (followingNode?.kind === NonterminalKind.Expression) {
+    addLeadingComment(followingNode, comment);
+    return true;
+  }
+
+  return false;
+}

src/slang-comments/handlers/index.ts

@@ -1,25 +1,29 @@
 import handleBlockComments from './handle-block-comments.js';
 import handleContractDefinitionComments from './handle-contract-definition-comments.js';
+import handleContractSpecifiersComments from './handle-contract-specifiers-comments.js';
 import handleElseBranchComments from './handle-else-branch-comments.js';
 import handleIfStatementComments from './handle-if-statement-comments.js';
 import handleInterfaceDefinitionComments from './handle-interface-definition-comments.js';
 import handleLibraryDefinitionComments from './handle-library-definition-comments.js';
 import handleModifierInvocationComments from './handle-modifier-invocation-comments.js';
 import handleParametersDeclarationComments from './handle-parameters-declaration-comments.js';
 import handlePositionalArgumentsDeclarationComments from './handle-positional-arguments-declaration-comments.js';
+import handleStorageLayoutSpecifierComments from './handle-storage-layout-specifier-comments.js';
 import handleWhileStatementComments from './handle-while-statement-comments.js';
 import handleYulBlockComments from './handle-yul-block-comments.js';
 
 export default [
   handleBlockComments,
   handleContractDefinitionComments,
+  handleContractSpecifiersComments,
   handleElseBranchComments,
   handleIfStatementComments,
   handleInterfaceDefinitionComments,
   handleLibraryDefinitionComments,
   handleModifierInvocationComments,
   handleParametersDeclarationComments,
   handlePositionalArgumentsDeclarationComments,
+  handleStorageLayoutSpecifierComments,
   handleWhileStatementComments,
   handleYulBlockComments
 ];

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

@@ -240,8 +240,8 @@ contract Comments4a
         Interface3,
         Interface4,
         Interface5,
-        Interface6 /*why we used Interface6*/ /*where should this go?*/
-    layout at 123 /*why we used this layout*/
+        Interface6 /*why we used Interface6*/
+    layout at /*where should this go?*/ 123 /*why we used this layout*/
 {
     // solhint-disable-previous-line no-empty-blocks
 }
@@ -253,8 +253,8 @@ contract Comments4b
         Interface3,
         Interface4,
         Interface5,
-        Interface6 /*why we used Interface6*/ /*where should this go?*/
-    layout at 123 + 456 /*why we used this layout*/
+        Interface6 /*why we used Interface6*/
+    layout at /*where should this go?*/ 123 + 456 /*why we used this layout*/
 {
     // solhint-disable-previous-line no-empty-blocks
 }
@@ -266,13 +266,15 @@ contract Comments4c
         Interface3,
         Interface4,
         Interface5,
-        Interface6 /*why we used Interface6*/ /*where should this go?*/
-    layout at f(123 + 456) /*why we used this layout*/
+        Interface6 /*why we used Interface6*/
+    layout at
+        /*where should this go?*/ f(123 + 456) /*why we used this layout*/
+
 {
     // solhint-disable-previous-line no-empty-blocks
 }
 
-/*nice name*/ contract Comments5 {
+contract Comments5 /*nice name*/ {
     // solhint-disable-previous-line no-empty-blocks
 }