Implement the --help command
#5409
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
alcuadrado
added
v-next
v-next/hardhat/example.config.ts
Outdated
|
|
||
| const exampleTaskOverride = overrideTask("example") | ||
| .setAction(async (args, _hre, runSuper) => { | ||
| import type { HardhatUserConfig } from "./src/config.js"; |
There was a problem hiding this comment.
Just a note, this config to play around with v3 can now be done in example-project.
| import type { ParameterType } from "@nomicfoundation/hardhat-core/config"; | ||
| import type { Task } from "@nomicfoundation/hardhat-core/types/tasks"; | ||
|
|
||
| export const GLOBAL_OPTIONS = [ |
There was a problem hiding this comment.
Just a note: I think we can handle this and reserved words differently so that they are more unified with the rest of the global options.
For a follow up pr though
| .map((letter, idx) => { | ||
| return letter.toUpperCase() === letter | ||
| ? `${idx !== 0 ? "-" : ""}${letter.toLowerCase()}` | ||
| : letter; | ||
| }) |
There was a problem hiding this comment.
@schaable do we have a utility for this?
There was a problem hiding this comment.
we have the opposite (kebabToCamel). We should add this.
| let output = `Usage: hardhat [GLOBAL OPTIONS] ${task.id.join(" ")}`; | ||
|
|
||
| if (options.length > 0) { | ||
| output += ` ${options.map((o) => `[${o.name}${o.type === "BOOLEAN" ? "" : ` <${o.type}>`}]`).join(" ")}`; |
There was a problem hiding this comment.
Options and positional arguments can be optional if they have a default value. In that case, they need to be wrapped around "[]`, otherwise they don't.
There was a problem hiding this comment.
As discussed, these options may all be, well... optional
resolves #5348
Global:
Per task:
Per empty task:
