mikhus / gulp-help-doc Goto Github PK

Sadly, this does not work with gulp v4. Given the following gulpfile, it shows an empty output from gulp help.

var gulp = require('gulp');

/**
 * Something
 * @task {sth}
 */
gulp.task(function sth(done) {
    done();
});

gulp.task(function help(done) {
    require('gulp-help-doc')(gulp);
    done();
});

Do you suspect why it does not work? Would it be hard to fix?

Thank you!

As mentioned here splitting-a-gulpfile you could also supply gulpfile.ts as a directory. Therefore it would be nice to make it work.

Given two gulpfiles:

gulpfile.js

var gulp = require('gulp');

require('./build/gulpfile-something');

gulp.task('help', function() {
    return require('gulp-help-doc')(gulp);
});

build/gulpfile-something.js

var gulp = require('gulp');
/**
 * Something
 * @task {sth}
 */
gulp.task('sth', function() {
});

The gulp help displays nothing.

Would be nice to have a feature which groups similar tasks.

@group {subTaskGroupName}

Seems a bit redundant to include the @group in the description as well.
Could this be removed from the output description?