run plugin "help" features..

[rocky]

• I've asked for help in the Truffle Gitter

It would be nice to be able to get a list of plugins that are installed other than looking at the truffle configuration file.

Is there a preferred way for a plugin to provide help for it? In the example of trufflesuite/trufflesuite.com#1396 I used console.log after looking at config.help, but is that recommended? For the core commands, their help is formatted in a uniform way, right?

[CruzMolina]

jotting down for posterity (if I'm unable to get to this before going on leave), I think this should be handled in the "runHandler" in truffle-core/lib/run.js. completely agree that we should provide a standard/recommended way for plugin writers to specify in some manner what they would like to display (perhaps using our displayCommandHelp func from our end) when a --help flag is passed. Ideally in the truffle-plugin.json something like...

{
  "commands": {
    "hello": "hello.js"
  },
  "help": {
    usage: "truffle run hello [name]",
    description: "Greets a given user",
    options: [
      {
        option: "name",
        description: "Name of user to greet."
      }
    ]
  }
}

or also potentially allowing a file to specified (which we would parse with certain expected parameters in mind).

Also agree it would be nice to get a list of properly configured/installed plugins, perhaps a --list flag to call with truffle run (truffle run --list)

(Btw, thanks for making all these truffle run issues! 🎉 )

[rocky]

You are very welcome. Thanks for considering this and working on this.

Please keep us (me, and more generally the Mythrili team) apprised of run plugin work. We can and do want to help here. We can help test things.

I am (now) watching release tags, but that can be a little too late to get the most benefit before a release.

[stale]

Thank you for raising this issue! It has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. If you would like to keep this issue open, please respond with information about the current state of this problem.

[eggplantzzz]

I think we wanna keep this open

[stale]

Thanks for your response! This issue is no longer considered stale and someone from the Truffle team will try to respond as soon as they can.

[gnidan]

Looks like this is a duplicate of #1551. Closing for issue maintenance. Thanks!