@nomiclabs/buidler/src/builtin-tasks/help.ts

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

import { HelpPrinter } from "../internal/cli/HelpPrinter";
import { BUIDLER_EXECUTABLE_NAME, BUIDLER_NAME } from "../internal/constants";
import { task } from "../internal/core/config/config-env";
import { BUIDLER_PARAM_DEFINITIONS } from "../internal/core/params/buidler-params";
import { getPackageJson } from "../internal/util/packageInfo";

import { TASK_HELP } from "./task-names";

export default function () {
  task(TASK_HELP, "Prints this message")
    .addOptionalPositionalParam(
      "task",
      "An optional task to print more info about"
    )
    .setAction(async ({ task: taskName }: { task?: string }, { tasks }) => {
      const packageJson = await getPackageJson();

      const helpPrinter = new HelpPrinter(
        BUIDLER_NAME,
        BUIDLER_EXECUTABLE_NAME,
        packageJson.version,
        BUIDLER_PARAM_DEFINITIONS,
        tasks
      );

      if (taskName !== undefined) {
        helpPrinter.printTaskHelp(taskName);
        return;
      }

      helpPrinter.printGlobalHelp();
    });
}