run plugin example and documentation

[rocky]

The section in "truffle run " is sparse in useful documentation. First, most plugins are going to want to use the config parameter that passed in. hello.js omits this parameter, and probably some mention should be made that it exists.

There there should probably be mention as to how flags/switches get passed to the plugin and how command arguments are passed. Here is a more complete hello.js example, that might be reworked into more expanded documentation:

/**
 * A sample truffle run plugin.
 *
 * @param config a truffle configuration object. It has attributes
 *               like `truffle_directory`, `working_directory`, etc.
 *
 */
module.exports = (config) => {
  // If --help is given `config.help` will be set.
  if (config.help) {
    console.log("usage: truffle run hello [name]")
  } else {
    // config._ has the command arguments. config_[0] is
    // the command name, e.g. "hello" here. config_[1]...
    // starts remaining parameters.
    let name = config._.len > 1 ? config._[1] : 'World!'
    console.log(`Hello, ${name}`)
  }
}

[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.

[stale]

There has been no new activity on this issue since it was marked as stale 7 days ago, so it is being automatically closed. If you'd like help with this or a different problem, please open a new issue. Thanks!

[gnidan]

stop it stalebot

[stale]

There has been no new activity on this issue since it was marked as stale 7 days ago, so it is being automatically closed. If you'd like help with this or a different problem, please open a new issue. Thanks!

[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]

Seems like the only thing left here is expanding the Third Party Command Plugin docs to include the above re: flags

[rkalis]

I added a reference of the config object and a walkthrough plugin development in my blog post https://kalis.me/creating-truffle-plugins/. If you want, I can contribute some of that content to the Truffle docs if you know what you want to include on the page.