[html coverage report] Add vendored package + generate HTML report

.changeset/gorgeous-swans-try.md

@@ -0,0 +1,6 @@
+---
+"@nomicfoundation/hardhat": minor
+"@nomicfoundation/hardhat-vendored": patch
+---
+
+Added HTML coverage reporting and a new internal `hardhat-vendored` package ([7528](https://github.com/NomicFoundation/hardhat/pull/7528)).

cspell.yaml

@@ -2,3 +2,4 @@ ignorePaths:
   - .github/config/regression-tests.yml
   - archive/**
   - pnpm-lock.yaml
+  - v-next/hardhat-vendored/src

v-next/hardhat-vendored/.gitignore

@@ -0,0 +1,14 @@
+# Node modules
+/node_modules
+
+# Compilation output
+/dist
+
+# pnpm deploy output
+/bundle
+
+# test coverage output
+coverage
+
+# all the tmp folders in the fixture projects
+/test/fixture-projects/tmp/

v-next/hardhat-vendored/.prettierignore

@@ -0,0 +1,6 @@
+/node_modules
+/dist
+/coverage
+CHANGELOG.md
+/test/fixture-projects/**/artifacts
+/test/fixture-projects/**/cache

v-next/hardhat-vendored/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025 Nomic Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

v-next/hardhat-vendored/README.md

@@ -0,0 +1,5 @@
+# hardhat-vendored
+
+> ⚠️ This package is an internal Hardhat component and it's not meant to be used directly.
+
+This package contains vendored code used by Hardhat 3 and its plugins.

v-next/hardhat-vendored/eslint.config.js

@@ -0,0 +1,3 @@
+import { createConfig } from "../config/eslint.config.js";
+
+export default createConfig(import.meta.filename, { onlyHardhatError: false });

v-next/hardhat-vendored/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@nomicfoundation/hardhat-vendored",
+  "version": "3.0.0",
+  "description": "Internal dependencies used by Hardhat that have been vendored to prevent bloating the main package",
+  "homepage": "https://github.com/nomicfoundation/hardhat/tree/v-next/v-next/hardhat-vendored",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NomicFoundation/hardhat",
+    "directory": "v-next/hardhat-vendored"
+  },
+  "author": "Nomic Foundation",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    "./coverage": "./dist/src/coverage-module/index.js",
+    "./coverage/types": "./dist/src/coverage-module/types.js"
+  },
+  "keywords": [
+    "hardhat"
+  ],
+  "scripts": {
+    "lint": "pnpm prettier --check && pnpm eslint",
+    "lint:fix": "pnpm prettier --write && pnpm eslint --fix",
+    "eslint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
+    "prettier": "prettier \"**/*.{ts,js,md,json}\"",
+    "test": "node --import tsx/esm --test --test-reporter=@nomicfoundation/hardhat-node-test-reporter \"test/*.ts\" \"test/!(fixture-projects|helpers)/**/*.ts\"",
+    "test:only": "node --import tsx/esm --test --test-only --test-reporter=@nomicfoundation/hardhat-node-test-reporter \"test/*.ts\" \"test/!(fixture-projects|helpers)/**/*.ts\"",
+    "test:coverage": "c8 --reporter html --reporter text --all --exclude test --exclude \"src/**/{types,type-extensions}.ts\" --src src node --import tsx/esm --test --test-reporter=@nomicfoundation/hardhat-node-test-reporter \"test/*.ts\" \"test/!(fixture-projects|helpers)/**/*.ts\"",
+    "pretest": "pnpm build",
+    "pretest:only": "pnpm build",
+    "build": "tsc --build .",
+    "postbuild": "node dist/src/copy-assets.js",
+    "prepublishOnly": "pnpm build",
+    "clean": "rimraf dist"
+  },
+  "files": [
+    "dist/src/",
+    "src/",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
+  ],
+  "devDependencies": {
+    "@nomicfoundation/hardhat-node-test-reporter": "workspace:^3.0.0",
+    "@types/bn.js": "^5.1.5",
+    "@types/debug": "^4.1.7",
+    "@types/node": "^20.14.9",
+    "c8": "^9.1.0",
+    "eslint": "9.25.1",
+    "expect-type": "^1.2.1",
+    "prettier": "3.2.5",
+    "rimraf": "^5.0.5",
+    "tsx": "^4.19.3",
+    "typescript": "~5.8.0"
+  },
+  "dependencies": {}
+}

v-next/hardhat-vendored/src/copy-assets.ts

@@ -0,0 +1,33 @@
+import { cp } from "node:fs/promises";
+import path from "node:path";
+
+async function copyFolder(from: string, to: string): Promise<void> {
+  const src = path.resolve(from);
+  const dest = path.resolve(to);
+
+  await cp(src, dest, { recursive: true, force: true });
+  console.log(`Copied folder from ${src} -> ${dest}`);
+}
+
+// eslint-disable-next-line no-restricted-syntax -- allow in this post build script
+await copyFolder(
+  path.resolve(
+    process.cwd(),
+    "src",
+    "coverage-module",
+    "istanbul-reports",
+    "lib",
+    "html",
+    "assets",
+  ),
+  path.resolve(
+    process.cwd(),
+    "dist",
+    "src",
+    "coverage-module",
+    "istanbul-reports",
+    "lib",
+    "html",
+    "assets",
+  ),
+);

v-next/hardhat-vendored/src/coverage-module/html-escaper/index.cjs

@@ -0,0 +1,24 @@
+const { replace } = "";
+
+// escape
+const es = /&(?:amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g;
+const ca = /[&<>'"]/g;
+
+const esca = {
+  "&": "&amp;",
+  "<": "&lt;",
+  ">": "&gt;",
+  "'": "&#39;",
+  '"': "&quot;",
+};
+const pe = (m) => esca[m];
+
+/**
+ * Safely escape HTML entities such as `&`, `<`, `>`, `"`, and `'`.
+ * @param {string} es the input to safely escape
+ * @returns {string} the escaped input, and it **throws** an error if
+ *  the input type is unexpected, except for boolean and numbers,
+ *  converted as string.
+ */
+const escape = (es) => replace.call(es, ca, pe);
+exports.escape = escape;

v-next/hardhat-vendored/src/coverage-module/index.js

@@ -0,0 +1,8 @@
+import libCoverage from "./lib-coverage/index.cjs";
+export { libCoverage };
+
+import libReport from "./lib-report/index.cjs";
+export { libReport };
+
+import reports from "./istanbul-reports/index.cjs";
+export { reports };

v-next/hardhat-vendored/src/coverage-module/istanbul-reports/index.cjs

@@ -0,0 +1,24 @@
+"use strict";
+/*
+ Copyright 2012-2015, Yahoo Inc.
+ Copyrights licensed under the New BSD License. See the accompanying LICENSE file for terms.
+ */
+const path = require("node:path");
+
+module.exports = {
+  create(name, cfg) {
+    cfg = cfg || {};
+    let Cons;
+    try {
+      Cons = require(path.join(__dirname, "lib", name, "index.cjs"));
+    } catch (e) {
+      if (e.code !== "MODULE_NOT_FOUND") {
+        throw e;
+      }
+
+      Cons = require(name);
+    }
+
+    return new Cons(cfg);
+  },
+};