Comments for an empty parameter list (#452)

Author: Janther

src/nodes/FunctionDefinition.js

@@ -4,7 +4,10 @@ const {
   }
 } = require('prettier/standalone');
 
+const privateUtil = require('../prettier-comments/common/util');
 const printSeparatedList = require('./print-separated-list');
+const printSeparatedItem = require('./print-separated-item');
+const printComments = require('./print-comments');
 
 const functionName = (node, options) => {
   if (node.isConstructor && !node.name) return 'constructor';
@@ -23,18 +26,37 @@ const functionName = (node, options) => {
   return names[name];
 };
 
-const parameters = (parametersType, node, path, print) =>
-  node[parametersType] && node[parametersType].length > 0
-    ? printSeparatedList(path.map(print, parametersType), {
-        separator: concat([
-          ',',
-          // To keep consistency any list of parameters will split if it's longer than 2.
-          // For more information see:
-          // https://github.com/prettier-solidity/prettier-plugin-solidity/issues/256
-          node[parametersType].length > 2 ? hardline : line
-        ])
-      })
-    : '';
+const parameters = (parametersType, node, path, print, options) => {
+  if (node[parametersType] && node[parametersType].length > 0) {
+    return printSeparatedList(path.map(print, parametersType), {
+      separator: concat([
+        ',',
+        // To keep consistency any list of parameters will split if it's longer than 2.
+        // For more information see:
+        // https://github.com/prettier-solidity/prettier-plugin-solidity/issues/256
+        node[parametersType].length > 2 ? hardline : line
+      ])
+    });
+  }
+  if (node.comments && node.comments.length > 0) {
+    // we add a check to see if the comment is inside the parentheses
+    const paremeterComments = printComments(
+      node,
+      path,
+      options,
+      (comment) =>
+        privateUtil.getNextNonSpaceNonCommentCharacter(
+          options.originalText,
+          comment,
+          options.locEnd
+        ) === ')'
+    );
+    return paremeterComments.parts.length > 0
+      ? printSeparatedItem(paremeterComments)
+      : '';
+  }
+  return '';
+};
 
 const visibility = (node) =>
   node.visibility && node.visibility !== 'default'
@@ -64,12 +86,12 @@ const modifiers = (node, path, print) =>
     ? concat([line, join(line, path.map(print, 'modifiers'))])
     : '';
 
-const returnParameters = (node, path, print) =>
+const returnParameters = (node, path, print, options) =>
   node.returnParameters
     ? concat([
         line,
         'returns (',
-        parameters('returnParameters', node, path, print),
+        parameters('returnParameters', node, path, print, options),
         ')'
       ])
     : '';
@@ -83,17 +105,19 @@ const FunctionDefinition = {
     concat([
       functionName(node, options),
       '(',
-      parameters('parameters', node, path, print),
+      parameters('parameters', node, path, print, options),
       ')',
       indent(
         group(
           concat([
+            // TODO: sort comments for modifiers and return parameters
+            printComments(node, path, options),
             visibility(node),
             stateMutability(node),
             virtual(node),
             override(node, path, print),
             modifiers(node, path, print),
-            returnParameters(node, path, print),
+            returnParameters(node, path, print, options),
             signatureEnd(node)
           ])
         )

src/nodes/print-comments.js

@@ -4,14 +4,17 @@ const {
   }
 } = require('prettier');
 
-const printComments = (node, path, options) =>
+const printComments = (node, path, options, filter = () => true) =>
   node.comments
     ? join(
         line,
         path
           .map((commentPath) => {
             const comment = commentPath.getValue();
-            if (comment.trailing || comment.leading) {
+            if (comment.trailing || comment.leading || comment.printed) {
+              return null;
+            }
+            if (!filter(comment)) {
               return null;
             }
             comment.printed = true;

tests/Comments/Comments.sol

@@ -83,3 +83,13 @@ contract Comments9 {
     }
   }
 }
+
+interface Comments10 {
+  function someFunction(
+    // the first value
+    // the second value
+    // the lats value
+  ) /* comment outside the parameters */ external;
+
+  function someOtherFunction(/* checking for Block comment */) external;
+}

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

@@ -86,7 +86,16 @@ contract Comments9 {
     }
   }
 }
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+interface Comments10 {
+  function someFunction(
+    // the first value
+    // the second value
+    // the lats value
+  ) /* comment outside the parameters */ external;
+
+  function someOtherFunction(/* checking for Block comment */) external;
+}~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 pragma solidity ^0.4.24;
 
 contract Comments1 {
@@ -194,4 +203,16 @@ contract Comments9 {
     }
 }
 
+interface Comments10 {
+    function someFunction(
+        // the first value
+        // the second value
+        // the lats value
+    )/* comment outside the parameters */ external;
+
+    function someOtherFunction(
+        /* checking for Block comment */
+    ) external;
+}
+
 `;