Skip to content

seanpk/gulp-task-list

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gulp-task-list

gulp-task-list is a gulp task that lists all tasks in gulpfile.js along with their comments and dependencies.

Comments are the single line of comment text immediately before the gulp.task call. Only tasks defined by a direct call to gulp.task with the task name a litteral string, will have their documentation shown.

This is still in need of major improvement ... if you choose to use it, good luck and send me your pull requests!

gulp-showhelp is a better implementation of this kind of functionality, the only down side is that it doesn't list the dependencies.�

Usage

		var gulp = require('gulp');

		require('gulp-task-list')(gulp);

		// this is a simple task
		gulp.task('dummy', function() {
				console.log('this is dummy');
		});

		// also simple, but with a dependency
		gulp.task('smarty', ['dummy'], function() {
				console.log('smarty\'s pants?');
		});

Results

	$ gulp task-list

	Task Name    Description                               Dependencies
	dummy        this is a simple task
	smarty       now, this one is the second dummy task    some-task

About

Gulp task that lists all tasks in gulpfile with their dependencies and a comment/description

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%