Merge pull request #5556 from NomicFoundation/galargh/issue/5057

fix: exit check task with exit code 1 when solhint raises errors

Author: galargh

.changeset/breezy-chairs-relax.md

@@ -0,0 +1,5 @@
+---
+"@nomiclabs/hardhat-solhint": major
+---
+
+Ensured the check task exits with exit code 1 when solhint raises any errors; this is a breaking change since the check task would previously always exit with exit code 0

.changeset/early-laws-trade.md

@@ -0,0 +1,5 @@
+---
+"@nomiclabs/hardhat-solhint": major
+---
+
+Updated solhint dependency to [v5.0.2](https://github.com/protofire/solhint/releases/tag/v5.0.2)

CONTRIBUTING.md

@@ -119,8 +119,8 @@ Unlike linking, if you make a change in the code, you'll need to repeat the proc
 
 An even more realistic way of using your local changes in a project is to use [`pnpm pack`](https://pnpm.io/cli/pack):
 
-1. Go to `packages/hardhat-core` and run `pnpm pack`. This will create a `nomiclabs-hardhat-x.y.z.tgz` file in that directory.
-2. Go to some hardhat project and run `npm install /path/to/hardhat/packages/hardhat/nomiclabs-hardhat-x.y.z.tgz`.
+1. Go to `packages/hardhat-core` and run `pnpm pack`. This will create a `hardhat-x.y.z.tgz` file in that directory.
+2. Go to some hardhat project and run `npm install /path/to/hardhat/packages/hardhat-core/hardhat-x.y.z.tgz`.
 
 Unlike linking, if you make a change in the code, you'll need to repeat the process.
 

packages/hardhat-solhint/package.json

@@ -35,7 +35,7 @@
     "README.md"
   ],
   "dependencies": {
-    "solhint": "^3.4.0"
+    "solhint": "^5.0.2"
   },
   "devDependencies": {
     "@nomicfoundation/eslint-plugin-hardhat-internal-rules": "workspace:^",

packages/hardhat-solhint/src/index.ts

@@ -127,4 +127,16 @@ task("check", async (_, { run }, runSuper) => {
   const reports = await run("hardhat-solhint:run-solhint");
 
   printReport(reports);
+
+  const errorsCount = reports.reduce(
+    (acc: number, i: { errorCount: number }) => {
+      return acc + i.errorCount;
+    },
+    0
+  );
+
+  if (errorsCount > 0) {
+    process.exitCode = 1;
+    return;
+  }
 });

packages/hardhat-solhint/test/fixture-projects/no-errors-project/.solhint.json

@@ -0,0 +1,3 @@
+{
+  "extends": "solhint:all"
+}

packages/hardhat-solhint/test/fixture-projects/no-errors-project/contracts/Greeter.sol

@@ -0,0 +1,15 @@
+pragma solidity ^0.8.0;
+
+
+contract Greeter {
+
+    string greeting;
+    constructor(string memory _greeting) public {
+        greeting = _greeting;
+    }
+
+    function greet() public view returns (string memory) {
+        return greeting;
+    }
+
+}

packages/hardhat-solhint/test/fixture-projects/no-errors-project/hardhat.config.js

@@ -0,0 +1,5 @@
+require("../../../src/index");
+
+module.exports = {
+  solidity: "0.5.15",
+};

packages/hardhat-solhint/test/tests.ts

@@ -36,11 +36,24 @@ describe("Solhint plugin", function () {
       );
     });
 
-    it("should run the check task without throwing an error", async function () {
+    it("should run the check task and set the exit code to 1", async function () {
       const consoleLogStub = sinon.stub(console, "log");
       await this.env.run("check");
       assert.isTrue(consoleLogStub.calledOnce);
+      assert.strictEqual(process.exitCode, 1);
       consoleLogStub.restore();
+      process.exitCode = undefined;
+    });
+  });
+
+  describe("Project with no errors", function () {
+    useEnvironment("no-errors-project");
+
+    it("should run the check task and not set the exit code", async function () {
+      const consoleLogStub = sinon.stub(console, "log");
+      await this.env.run("check");
+      assert.isTrue(consoleLogStub.calledOnce);
+      assert.strictEqual(process.exitCode, undefined);
     });
   });