feat: explicit return types check

Author: rori4

pretest.sh

@@ -5,6 +5,8 @@ source_directory=$(pwd)  # Current working directory
 package_name=$(node -pe "require('./package.json').name" | sed 's/^.*\///')  # Get the package name without the scope from package.json
 destination_directory="$source_directory/node_modules/$package_name"
 
+rm -rf "$destination_directory"
+
 # Create the destination directory if it doesn't exist
 mkdir -p "$destination_directory"
 

rules/explicitReturnTypesSafeCheck.js

@@ -22,7 +22,6 @@ class ExplicitReturnTypesSafeCheck {
     }
     // if there are no named returns, return
     if (typeNames.length === 0) {
-      // TODO: create an error that we have no named returns?
       return;
     }
 
@@ -63,7 +62,7 @@ class ExplicitReturnTypesSafeCheck {
         ctx,
         this.ruleId,
         `Return statements must be written and must explicitly return something; consider "return ${returnExprGen(
-          namedReturns || typeNames
+          namedReturns.length === 0 ? typeNames : namedReturns
         )};"?`
       );
       return;
@@ -73,7 +72,7 @@ class ExplicitReturnTypesSafeCheck {
         ctx,
         this.ruleId,
         `Return statements must explicitly return something; consider "return ${returnExprGen(
-          namedReturns || typeNames
+          namedReturns.length === 0 ? typeNames : namedReturns
         )};"?`
       );
       return;

test/contracts/ExplicitTypeMissing.sol

@@ -0,0 +1,7 @@
+pragma solidity ^0.8.13;
+
+contract TestNoReturn {
+    function test() internal pure returns (uint) {
+        uint256 result = 0;
+    }
+}

test/explicitReturnTypesSafeCheck.test.js

@@ -29,4 +29,16 @@ describe("ExplicitReturnTypesSafeCheck", () => {
       `Return statements must be written and must explicitly return something; consider "return uint256;"?`
     );
   });
+
+  it("should return an error if no return is detected", () => {
+    const explicitTypeMissingContract = fs.readFileSync(
+      "test/contracts/ExplicitTypeMissing.sol",
+      "utf8"
+    );
+    const result = linter.processStr(explicitTypeMissingContract, settings);
+    assert.equal(
+      result.reports[0].message,
+      `Return statements must explicitly return something; consider "returns (uint256)"?`
+    );
+  });
 });