https://github.com/andrienko/gulp-hint

A stupid help generator based on gulpfile comments
https://github.com/andrienko/gulp-hint

Last synced: 7 days ago
JSON representation

A stupid help generator based on gulpfile comments

• Host: GitHub
• URL: https://github.com/andrienko/gulp-hint
• Owner: andrienko
• Created: 2016-01-08T15:14:26.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-01-08T15:22:41.000Z (almost 9 years ago)
• Last Synced: 2024-10-16T00:33:42.135Z (about 1 month ago)
• Language: JavaScript
• Size: 1.95 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Gulp-hint

===

Just a script that parses gulpfile.js based on pretty stupid regexes.

Usage

---

You add a gulp task:

    var gulp_hint = require('gulp-hint');

    gulp.task('help', gulp_hint.getHelp);

And then add comments (single-line ones!) before gulp.task definitions:

This uses no AST parser and may be buggy, tho fits my needs perfectly

    // Parse HTML templates

    gulp.task('html', function () {

      gulp.src("./source/*.html")

        .pipe(mustache(require('./source/variables.js'), {

          extension: '.html'

        }))

        .pipe(gulp.dest("./result"));

    });

And then, when you run `gulp help`, you will get something like this in your console:

    html    Parse HTML templates

More

---

More description to come.