add function to check if process is running in the CI

Author: ChristopherDedominici

v-next/hardhat-utils/package.json

@@ -10,6 +10,7 @@
   "exports": {
     "./bigint": "./dist/src/bigint.js",
     "./bytes": "./dist/src/bytes.js",
+    "./ci": "./dist/src/ci.js",
     "./common-errors": "./dist/src/common-errors.js",
     "./crypto": "./dist/src/crypto.js",
     "./date": "./dist/src/date.js",

v-next/hardhat-utils/src/ci.ts

@@ -0,0 +1,6 @@
+/**
+ * Returns 'true' if the current process is running in the GitHub CI environment.
+ */
+export function isCI() {
+  return process.env.CI === "true";
+}

v-next/hardhat-utils/test/ci.ts

@@ -0,0 +1,20 @@
+import assert from "node:assert/strict";
+import { describe, it } from "node:test";
+
+import { isCI } from "../src/ci.js";
+
+describe("ci", () => {
+  it("should be true because the ENV variable CI is true", async function () {
+    process.env.CI = "true";
+    assert.equal(isCI(), true);
+  });
+
+  it("should be false because the ENV variable CI is false", async function () {
+    process.env.CI = "false";
+    assert.equal(isCI(), false);
+  });
+
+  it("should be false because the ENV variable CI is undefined", async function () {
+    assert.equal(isCI(), false);
+  });
+});