Modify for gulp --tasks

[sttk]

I tried to achieve @tylersticka's second image in gulpjs/gulp#1294 and finished.

• Don't hide series/parallel tasks.
• Can change task tree depth by '--depth' option.
• Can set a task description with .description property, as follows:
  gulp.task('task-name', fn).description = 'task-description';
  or
  gulp.task('task-name', fn).description = { '': 'task-description', '--option1': 'task-option-1', ... };

[sttk]

Sorry for some errors but I fixed them all.

[phated]

Many of the changes in here aren't required fir the CLI changes, including the description changes and the task function changes. The transformer code is interesting but very complex and possibly not needed.

[phated]

To clarify, the undertaker.task() method is a setter and a getter for tasks, it should not return a task when it is being set.

How users should set description:

function clean(cb){ cb() }
clean.description = 'remove some folders';
gulp.task(clean);

[sttk]

The transformer code is interesting but very complex and possibly not needed.

I got it. I'll try to remove the transformer from undertaker#tree and not use it in gulp-cli#logTasks.

[sttk]

How users should set description:

Isn't there a case like the following?

function clean(cb) { cb() }
clean.description = 'remove some folders';
gulp.task(clean);
gulp.task('another task name', clean).description = 'another description';

Or don't you want to write like the following?

gulp.task('clean', function(cb) { cb() })
 .description = 'remove some folders';

[sttk]

How about the depth flag and the sorting of undertaker#tree. Should the sorting be optional?

[phated]

I'd prefer not to allow chaining description because that requires the setter to return the function. If you are able to reduce the transformer code, I'm good with leaving it in here. Not sure about the sorting but you can use lodash sortBy for it

[phated]

I'd put depth in the options, I think.

[sttk]

I've finished modifying the program!

I'd prefer not to allow chaining description because that requires the setter to return the function.

OK. I removed the chaining description. However it's not difficult to implement it again, so I may do so if you or anyone want it later.

Not sure about the sorting but you can use lodash sortBy for it

Yes, I used it in my code. It is easy to write as needed, so I removed the sorting from undertaker#tree not to change the original behavior preferably.

[sttk]

Thank you for detail reviews.

I want to move all changes to gulp-cli and make undertaker no change.

Because, though my first plan contains chaining description and control of depth in tree function, we removed the former and the latter can be moved to gulp-cli, so it isn't necessary to modify undertaker any more.

I'll implement what you pointed out here into gulp-cli.

About removing opts.deep I think it is better to separate from this PR.

Can I close this PR about undertaker with no change?

[phated]

Sounds good!