print comments inside modifier parameters

Author: Janther

src/slang-comments/handlers/handle-block-comments.ts

@@ -1,10 +1,8 @@
 import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
-import { util } from 'prettier';
 import addHubNodeFirstComment from './add-hub-node-first-comment.js';
+import addHubNodeLastComment from './add-hub-node-last-comment.js';
 
-import type { HandlerParams } from './types.js';
-
-const { addDanglingComment, addTrailingComment } = util;
+import type { HandlerParams } from './types';
 
 export default function handleBlockComments({
   precedingNode,
@@ -17,14 +15,7 @@ export default function handleBlockComments({
   }
 
   if (precedingNode?.kind === NonterminalKind.Statements) {
-    if (precedingNode.items.length === 0) {
-      addDanglingComment(precedingNode, comment, false);
-    } else {
-      addTrailingComment(
-        precedingNode.items[precedingNode.items.length - 1],
-        comment
-      );
-    }
+    addHubNodeLastComment(precedingNode, comment);
     return true;
   }
 

src/slang-comments/handlers/handle-positional-arguments-declaration-comments.ts

@@ -0,0 +1,31 @@
+import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
+import addHubNodeFirstComment from './add-hub-node-first-comment.js';
+import addHubNodeLastComment from './add-hub-node-last-comment.js';
+
+import type { HandlerParams } from './types';
+
+export default function handlePositionalArgumentsDeclarationComments({
+  precedingNode,
+  enclosingNode,
+  followingNode,
+  comment
+}: HandlerParams): boolean {
+  if (comment.value.startsWith('// test')) {
+    console.log(comment);
+  }
+  if (enclosingNode?.kind !== NonterminalKind.PositionalArgumentsDeclaration) {
+    return false;
+  }
+
+  if (precedingNode?.kind === NonterminalKind.PositionalArguments) {
+    addHubNodeLastComment(precedingNode, comment);
+    return true;
+  }
+
+  if (followingNode?.kind === NonterminalKind.PositionalArguments) {
+    addHubNodeFirstComment(followingNode, comment);
+    return true;
+  }
+
+  return false;
+}

src/slang-comments/handlers/index.ts

@@ -3,6 +3,7 @@ import handleContractDefinitionComments from './handle-contract-definition-comme
 import handleElseBranchComments from './handle-else-branch-comments.js';
 import handleIfStatementComments from './handle-if-statement-comments.js';
 import handleParametersDeclarationComments from './handle-parameters-declaration-comments.js';
+import handlePositionalArgumentsDeclarationComments from './handle-positional-arguments-declaration-comments.js';
 import handleWhileStatementComments from './handle-while-statement-comments.js';
 import handleYulBlockComments from './handle-yul-block-comments.js';
 
@@ -12,6 +13,7 @@ export default [
   handleElseBranchComments,
   handleIfStatementComments,
   handleParametersDeclarationComments,
+  handlePositionalArgumentsDeclarationComments,
   handleWhileStatementComments,
   handleYulBlockComments
 ];

src/slang-printers/print-comments.ts

@@ -1,12 +1,13 @@
 import { doc } from 'prettier';
 import { printComment } from '../slang-comments/printer.js';
 import { isPrettier2 } from '../slang-utils/backward-compatibility.js';
+import { isLineComment } from '../slang-utils/is-comment.js';
 
 import type { AstPath, Doc } from 'prettier';
 import type { AstNode } from '../slang-nodes';
 import type { DocV2 } from './types';
 
-const { join, line } = doc.builders;
+const { breakParent, join, line } = doc.builders;
 
 export function printComments(path: AstPath<AstNode>): Doc[] {
   const document = join(
@@ -18,7 +19,8 @@ export function printComments(path: AstPath<AstNode>): Doc[] {
           return '';
         }
         comment.printed = true;
-        return printComment(commentPath);
+        const printed = printComment(commentPath);
+        return isLineComment(comment) ? [printed, breakParent] : printed;
       }, 'comments')
       .filter(Boolean)
   );