hardhat/src/internal/builtin-plugins/solidity-test/index.ts

Hardhat is an extensible developer tool that helps smart contract developers increase productivity by reliably bringing together the tools they want.

import type { HardhatPlugin } from "../../../types/plugins.js";

import { ArgumentType } from "hardhat/types/arguments";

import { DEFAULT_VERBOSITY } from "../../constants.js";
import { task } from "../../core/config.js";

import "./type-extensions.js";

const hardhatPlugin: HardhatPlugin = {
  id: "builtin:solidity-tests",
  hookHandlers: {
    config: () => import("./hook-handlers/config.js"),
    test: () => import("./hook-handlers/test.js"),
  },
  tasks: [
    task(["test", "solidity"], "Run the Solidity tests")
      .addVariadicArgument({
        name: "testFiles",
        description: "An optional list of files to test",
        defaultValue: [],
      })
      .addOption({
        name: "chainType",
        description: "The chain type to use",
        defaultValue: "l1",
      })
      .addOption({
        name: "grep",
        description: "Only run tests matching the given string or regexp",
        type: ArgumentType.STRING_WITHOUT_DEFAULT,
        defaultValue: undefined,
      })
      .addFlag({
        name: "noCompile",
        description: "Don't compile the project before running the tests",
      })
      .addLevel({
        name: "verbosity",
        shortName: "v",
        description: "Verbosity level of the test output",
        defaultValue: DEFAULT_VERBOSITY,
      })
      .addOption({
        name: "testSummaryIndex",
        description:
          "Print a summary of all test runners starting from the given index",
        type: ArgumentType.INT,
        defaultValue: 0,
        hidden: true,
      })
      .setAction(async () => import("./task-action.js"))
      .build(),
  ],
  dependencies: () => [
    import("../solidity/index.js"),
    import("../test/index.js"),
    import("../coverage/index.js"),
    import("../gas-analytics/index.js"),
  ],
  npmPackage: "hardhat",
};

export default hardhatPlugin;