NomicFoundation / hardhat

Hardhat is a development environment to compile, deploy, test, and debug your Ethereum software.
https://hardhat.org
Other
7.22k stars 1.38k forks source link

Implement and test a module that prints the different help messages (global, per task, subtasks) #5348

Closed kanej closed 3 months ago

kanej commented 4 months ago

This is a v-next task to implement the help feature of Hardhat cli tasks.

For the moment we are only supporting --help and not help as its own task, so:

Global

> hardhat --help
Hardhat version 2.22.5

Usage: hardhat [GLOBAL PARAMETERS] <TASK> [TASK PARAMETERS]

GLOBAL PARAMETERS:

  --config              A Hardhat config file.
  --version             Shows hardhat's version.

AVAILABLE TASKS:

  console               Opens a hardhat console
  run                   Runs a user-defined script after compiling the project
  help                  Prints this message

Per Task

> hardhat run --help
Hardhat version 2.22.5

Usage: hardhat [GLOBAL PARAMETERS] run script

POSITIONAL ARGUMENTS:

  script        A js file to be run within hardhat's environment 

run: Runs a user-defined script after compiling the project

For global options help run: hardhat help

Per subtask

hardhat ignition deploy --help

Not supported

hardhat help

TODO

00676 commented 3 months ago
00676 commented 3 months ago

Nothing