mikhus / gulp-help-doc Goto Github PK
View Code? Open in Web Editor NEWSelf-documented gulp tasks with pretty printable usage information
License: MIT License
Self-documented gulp tasks with pretty printable usage information
License: MIT License
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?
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.