Add help for the different gulp tasks

[waldekmastykarz]

Since we're now having multiple gulp tasks, how about we added help to make it easier to use them?

[andrewconnell]

All you :)

Each one has a comment in the header within the code... if you just run gulp help it gives you a list of the available ones. Personally I think this is enough.

[waldekmastykarz]

I meant the tasks in the generated gulpfile.js rather than the generator itself. Initially it was only serve-static but now we also have validate-xml which can be called with some parameters. Unfortunately when adding the task we haven't added any documentation.

[andrewconnell]

Ah… ok go for it

[waldekmastykarz]

In the generator we're using the taskhelp package to list all available tasks. For the generated gulpfile.js this wouldn't add that much value since we only have two tasks.
What I had in mind though was to document how to use the validate-xml task since it accepts parameters. One way to do that would be to use for example https://www.npmjs.com/package/gulp-help instead which is able to list the parameters supported by a specific task. I'm not convinced though about the way you document the parameters which you do by passing an additional parameter to the gulp.task() function (see https://www.npmjs.com/package/gulp-help#taskoptions-options) which isn't documented on Gulp. Any thoughts @andrewconnell?

[andrewconnell]

Nah… if you want feel free to implement this.

[waldekmastykarz]

Let's keep it as-is then. Should the generated gulpfile.js grow in the future we can always decide to revise this issue.

[waldekmastykarz]

Got a second thought: currently the validate-xml task accepts two parameters: resultsAsJson and xmlfile. The resultsAsJson parameter has been added to support the unnecessary unit tests. When you implement #58 we won't be also needing the xmlfile parameter. Removing them will simplify the task removing the need for an extended help. A simple listing, just as the one we're having in the generator's gulpfile.js would be sufficient.

[andrewconnell]

What's the action here? I'm lost...

[waldekmastykarz]

Sorry: let's add gulp help to the generated gulpfile.js files the same way we have it for the gulpfile.js of the generator.

[andrewconnell]

ok... are you doing this?

[waldekmastykarz]

Will do!