Create new gulp tasks using latest gulp APIs

2 files changed, 63 insertions, 0 deletions

diff --git a/build/gulp-tasks/jsdoc.js b/build/gulp-tasks/jsdoc.js
new file mode 100644
index 00000000..34900b07
--- /dev/null
+++ b/build/gulp-tasks/jsdoc.js
@@ -0,0 +1,17 @@
+/*
+
+   this task will generate the jsdoc based HTML documentation found in the /doc/ folder
+
+*/
+
+const { src, dest } = require('gulp');
+const mustache = require('gulp-mustache');
+const rename = require('gulp-rename');
+const jsdoc = require('gulp-jsdoc3');
+
+const config = require('../../conf.json');
+
+module.exports = function jdsoc (cb) {
+  src(['./README.md', './lib/*.js'], { read: false })
+    .pipe(jsdoc(config, cb));
+};
\ No newline at end of file
diff --git a/build/gulp-tasks/readme.js b/build/gulp-tasks/readme.js
new file mode 100644
index 00000000..199acde1
--- /dev/null
+++ b/build/gulp-tasks/readme.js
@@ -0,0 +1,46 @@
+/*
+
+   this task will generate the Readme.md file found in the project root
+
+*/
+
+const { src, dest } = require('gulp');
+const mustache = require('gulp-mustache');
+const rename = require('gulp-rename');
+
+module.exports = function readme (cb) {
+  var API = '', LOCALES = '';
+  var faker = require('../../index');
+
+  // generate locale list
+  for (var locale in faker.locales) {
+    LOCALES += ' * ' + locale + '\n';
+  }
+
+  var keys = Object.keys(faker);
+  keys = keys.sort();
+
+  // generate nice tree of api for docs
+  keys.forEach(function(module){
+    // ignore certain properties
+    var ignore = ['locale', 'localeFallback', 'definitions', 'locales'];
+    if (ignore.indexOf(module) !== -1) {
+      return;
+    }
+    API += '* ' + module + '\n';
+    for (var method in faker[module]) {
+      API += '  * ' + method + '\n';
+    }
+  });
+
+  return src('build/src/docs.md')
+    .pipe(mustache({
+       'API': API,
+       'LOCALES': LOCALES,
+       'startYear': 2010,
+       'currentYear': new Date().getFullYear()
+     }))
+    .pipe(rename("../Readme.md"))
+    .pipe(dest('build/'));
+
+};
\ No newline at end of file