megahertz / gulp-task-doc Goto Github PK
View Code? Open in Web Editor NEWMake gulp task documentation (help) easy - just write javascript comments
License: MIT License
Make gulp task documentation (help) easy - just write javascript comments
License: MIT License
If you run gulp.series or parallel like this:
// Display this help
gulp.task('help', gulp.series(doc.help()));
This error is thrown:
[01:56:25] The following tasks did not complete: help, <anonymous>
[01:56:25] Did you forget to signal async completion?
As there isn't a way to invoke the done callback. Is there a way this could be achieved:
// Display this help
gulp.task('help', gulp.series(function(done) {
doc.help(); // and have this output to console using console.log(doc.help());
done();
}));
The options documentation shows this:
print({
parser: {
etc....
which confused me because there is no print function that I can find. I passed this config to doc.help
and it works so I assume the documentation just got out of sync.
After upgrading from 1.0.8 version I've started seeing the following error:
$ gulp help
... ... ... # skipped for brevity
[08:12:27] TypeError: done is not a function
at C:\cygwin64\home\dmoore\projects\sites\webcms2-core-mirror-colddata\node_modules\gulp-task-doc\index.js:73:5
at C:\cygwin64\home\dmoore\projects\sites\webcms2-core-mirror-colddata\gulpfile.js:573:13
at taskWrapper (C:\cygwin64\home\dmoore\projects\sites\webcms2-core-mirror-colddata\node_modules\undertaker\lib\set-task.js:13:15)
at bound (domain.js:280:14)
at runBound (domain.js:293:12)
at asyncRunner (C:\cygwin64\home\dmoore\projects\sites\webcms2-core-mirror-colddata\node_modules\async-done\index.js:36:18)
at _combinedTickCallback (internal/process/next_tick.js:67:7)
at process._tickCallback (internal/process/next_tick.js:98:9)
at Function.Module.runMain (module.js:577:11)
at startup (node.js:160:18)
Rolling back to 1.0.8 makes the error go away.
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.