Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
2 tasks
Tracked by #5237
kanej opened this issue Jun 7, 2024 · 2 comments · Fixed by #5409
Closed
2 tasks
Tracked by #5237
Assignees
Labels
status:ready This issue is ready to be worked on

Comments

@kanej
Copy link
Member

kanej commented Jun 7, 2024

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

  • Brief design document showing outputs
  • Implementation
@fvictorio fvictorio added this to Hardhat Jun 7, 2024
@github-actions github-actions bot added the status:ready This issue is ready to be worked on label Jun 7, 2024
@github-project-automation github-project-automation bot moved this to Backlog in Hardhat Jun 7, 2024
@kanej kanej moved this from Backlog to To-do in Hardhat Jun 7, 2024
@kanej kanej moved this from To-do to In Progress in Hardhat Jun 10, 2024
@zoeyTM zoeyTM linked a pull request Jun 19, 2024 that will close this issue
@zoeyTM zoeyTM moved this from In Progress to In Review in Hardhat Jun 19, 2024
@zoeyTM zoeyTM moved this from In Review to Done in Hardhat Jun 24, 2024
@00676
Copy link

00676 commented Jun 26, 2024

  • [ ]

@00676
Copy link

00676 commented Jun 26, 2024

Nothing

@kanej kanej closed this as completed Jun 27, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status:ready This issue is ready to be worked on
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants