How to get the available tasks list in gulp

Javascriptnode.jsGulp

Javascript Problem Overview


Hi Previously I used the grunt in that I want to know the available tasks use grunt --help. But same as in gulp use gulp --help it doesn't show. What is the command to know the available tasks list in gulp

Javascript Solutions


Solution 1 - Javascript

Yes I got it use the gulp --tasks in command then it display the tasks list.

Solution 2 - Javascript

gulp --tasks-simple

This command print a plaintext list of tasks. My local project:

~ gulp --tasks-simple
clean
default

From gulp CLI documentation:

~ gulp --version
[03:00:05] CLI version 1.2.1
[03:00:05] Local version 4.0.0-alpha.2
~ gulp --help | grep 'tasks-simple'
  --tasks-simple   Print a plaintext list of tasks for the loaded gulpfile. [boolean]

Solution 3 - Javascript

Another possibility is to use gulp-help-doc module, which provides possibility to print usage information based on jsDoc-like comments in a gulpfile. Currently it also supports TypeScript as well. The benefit is that you simply commenting your code without changing gulp API and you have usage info in command-line as well.

Solution 4 - Javascript

you can also use this plugin gulp-task-listing. It gives the main-tasks and sub-tasks list

Solution 5 - Javascript

As an alternative you can write detailed documentation to your tasks in js comments using gulp-task-doc

Solution 6 - Javascript

If you are using Gulp 4 you can do the following:

const tasks = gulp.registry().tasks();

// Outputs a JS object: { <task name>: <function>, ...}
console.log(tasks);

const taskNames = Object.Keys(tasks);

// Outputs a JS array: ['<task name>', ...]
console.log(taskNames);

Solution 7 - Javascript

There is no native command that does that but i use this plugin with the following code:

module.exports.help = require('gulp-help')(gulp, {description : false});

I can then just run the default gulp task in the console and it'll display a list of tasks and definitions.

Solution 8 - Javascript

inspired by @matt-gaunt https://stackoverflow.com/a/65571474/1347601

// gulp task
const list = () => {
    
    const tasks = gulp.registry().tasks();

    for (const [key, value] of Object.entries(tasks)) {
        console.log(key);
    }

}
gulp.task('list', list);

// gulp process default
gulp.task('list', gulp.series(
    list
));

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionvamsikrishnamannemView Question on Stackoverflow
Solution 1 - JavascriptvamsikrishnamannemView Answer on Stackoverflow
Solution 2 - JavascriptVladimir KorshunovView Answer on Stackoverflow
Solution 3 - JavascriptMykhailo StadnykView Answer on Stackoverflow
Solution 4 - JavascriptharishrView Answer on Stackoverflow
Solution 5 - JavascriptAlexey ProkhorovView Answer on Stackoverflow
Solution 6 - JavascriptMatt GauntView Answer on Stackoverflow
Solution 7 - JavascriptmarblewraithView Answer on Stackoverflow
Solution 8 - JavascriptBGBRUNOView Answer on Stackoverflow