feat: change node version warning rules

Change the rule from warning on all unsupported versions to a new rule.

Specifically:

1. Warn on odd version numbered node.js releases
2. Warn on versions older than the min supported version
3. Intentionally don't warn on newer version (as long as they are even)

Author: kanej

packages/hardhat-core/src/internal/cli/is-node-version-to-warn-on.ts

@@ -1,16 +1,54 @@
 import semver from "semver";
 
+import { assertHardhatInvariant } from "../core/errors";
 import { SUPPORTED_NODE_VERSIONS } from "./constants";
 
 /**
- * Determine if the node version is unsupported by Hardhat
- * and so a warning message should be shown.
+ * Determine if the node version should trigger an unsupported
+ * warning.
  *
- * The current rule is that Hardhat supports all `Current`,
- * `Active LTS`, and `Maintenance LTS` versions of Node.js
- * as defined in the Node.js release schedule and encoded
- * in the `SUPPORTED_NODE_VERSIONS` constant.
+ * The current rule is that a unsupported warning will be shown if
+ *
+ * 1. An odd numbered version of Node.js is used - as this will never go to LTS
+ * 2. The version is less than the minimum supported version
+ *
+ * We intentionally do not warn on newer **even** versions of Node.js.
  */
 export function isNodeVersionToWarnOn(nodeVersion: string): boolean {
-  return !semver.satisfies(nodeVersion, SUPPORTED_NODE_VERSIONS.join(" || "));
+  const supportedVersions = SUPPORTED_NODE_VERSIONS.join(" || ");
+
+  // If the version is supported, no need to warn and short circuit
+  if (semver.satisfies(nodeVersion, supportedVersions)) {
+    return false;
+  }
+
+  if (_onOddNumberedVersion(nodeVersion)) {
+    return true;
+  }
+
+  if (_lessThanMinimumSupportedVersion(nodeVersion, supportedVersions)) {
+    return true;
+  }
+
+  // A newer version of Node.js that will go to LTS
+  // we have opted not to warn.
+  return false;
+}
+
+function _onOddNumberedVersion(nodeVersion: string) {
+  return semver.major(nodeVersion) % 2 === 1;
+}
+
+function _lessThanMinimumSupportedVersion(
+  nodeVersion: string,
+  supportedVersions: string
+) {
+  const minSupportedVersion = semver.minVersion(supportedVersions);
+
+  assertHardhatInvariant(
+    minSupportedVersion !== null,
+    "Unexpectedly failed to parse the minimum supported version of Node.js"
+  );
+
+  return semver.lt(nodeVersion, minSupportedVersion);
 }

packages/hardhat-core/test/internal/cli/is-node-version-to-warn-on.ts

@@ -13,26 +13,32 @@ describe("isNodeVersionToWarnOn", function () {
     assert.isFalse(isNodeVersionToWarnOn("v22.3.0"));
   });
 
+  it("Should not warn on even newer versions even if they are unsupported", function () {
+    assert.isFalse(isNodeVersionToWarnOn("v24.0.0"));
+    assert.isFalse(isNodeVersionToWarnOn("v24.3.0"));
+  });
+
   it("Should warn on unsupported older node versions", function () {
     assert(isNodeVersionToWarnOn("v10.0.0"));
     assert(isNodeVersionToWarnOn("v10.24.1"));
 
+    assert(isNodeVersionToWarnOn("v11.0.0"));
+
     assert(isNodeVersionToWarnOn("v12.0.0"));
     assert(isNodeVersionToWarnOn("v12.22.12"));
 
+    assert(isNodeVersionToWarnOn("v13.0.0"));
+
     assert(isNodeVersionToWarnOn("v14.0.0"));
     assert(isNodeVersionToWarnOn("v14.21.3"));
 
+    assert(isNodeVersionToWarnOn("v15.0.0"));
+
     assert(isNodeVersionToWarnOn("v16.0.0"));
     assert(isNodeVersionToWarnOn("v16.20.20"));
   });
 
-  it("Should warn on unsupported newer versions", function () {
-    assert(isNodeVersionToWarnOn("v24.0.0"));
-    assert(isNodeVersionToWarnOn("v24.3.0"));
-  });
-
-  it("Should warn on unsupported odd number releases", function () {
+  it("Should warn on odd number releases", function () {
     assert(isNodeVersionToWarnOn("v15.14.0"));
     assert(isNodeVersionToWarnOn("v17.9.1"));
     assert(isNodeVersionToWarnOn("v19.9.0"));