Docs: Getting commands from external script to show up in `help`

We’ve developed a Hubot script for integration with a time-tracking service.

It worked great, but for one thing: the commands doesn’t show up.

After digging around in the Hubot source, I realized that my project structure was to blame:

// `tsheets.coffee` loaded files from `lib`
| lib
| package.son
| tsheets.coffee

Appearantly, the structure has to be something along the lines of:

// `tsheets.coffee` loaded from `index.coffee`
| src (maybe works with other name as long as index.coffee loads file)
  |_ tsheets.coffee
| index.coffee

If this is a requirement for things to work, you might want to clarify it in the docs. 😃

Thanks for a great product.

[optical]

For what its worth, I just had this problem myself - trying to get my external script package to register its documentation. To be clear I had no problem getting the package working, just had no idea how hubot might search for documentation in packages (it doesn’t).

The simplest solution for me seems to be to make my main file export nothing more then a simple function which will call robot.loadFile on the actual entrypoint to the package, so that the documentation gets parsed.

It’d be nice if this were a little clearer in the documentation. Additionally perhaps hubot should parse the modules main file, or have some way of locating a packages documentation through properties on project.json or similar?

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.