Update gulpfile to allow generating docs with demo and deploy to ghpages

Author: mattmazzola

.gitignore

@@ -1,6 +1,7 @@
 node_modules/
 bower_components/
 coverage/
+docs
 typings/
 tmp
 .publish

README.md

@@ -8,8 +8,11 @@
 ## Wiki
 See the [wiki](https://github.com/Microsoft/PowerBI-JavaScript/wiki) for more details about embedding, service configuration, setting default page, page navigation, dynamically applying filters, and more.
 
+## Code Docs
+See the [code docs](https://microsoft.github.io/PowerBI-JavaScript) for detailed information about classes, interfaces, types, etc.
+
 ## Demo
-### [https://microsoft.github.io/PowerBI-JavaScript](https://microsoft.github.io/PowerBI-JavaScript)
+See the [live demo](https://microsoft.github.io/PowerBI-JavaScript/demo) for sample application using the powerbi-client library in scenarios such as page navigation, applying filters, updating settings, and more.
 
 ## Installation
 

gulpfile.js

@@ -10,9 +10,12 @@ var ghPages = require('gulp-gh-pages'),
     tslint = require("gulp-tslint"),
     ts = require('gulp-typescript'),
     flatten = require('gulp-flatten'),
-    rimraf = require('rimraf'),
+    fs = require('fs'),
+    del = require('del'),
+    moment = require('moment'),
     merge = require('merge2'),
     karma = require('karma'),
+    typedoc = require('gulp-typedoc'),
     webpack = require('webpack');
     webpackStream = require('webpack-stream'),
     webpackConfig = require('./webpack.config'),
@@ -25,11 +28,48 @@ var package = require('./package.json');
 var webpackBanner = package.name + " v" + package.version + " | (c) 2016 Microsoft Corporation " + package.license;
 var gulpBanner = "/*! " + webpackBanner + " */\n";
 
-gulp.task('ghpages', function() {
-  return gulp.src(['./demo/**/*'])
-    .pipe(ghPages({
-        force: true
-    }));
+gulp.task('ghpages', 'Deploy documentation to gh-pages', ['nojekyll'], function () {
+    return gulp.src(['./docs/**/*'], {
+        dot: true
+    })
+        .pipe(ghPages({
+            force: true,
+            message: 'Update ' + moment().format('LLL')
+        }));
+});
+
+gulp.task("docs", 'Compile documentation from src code', function () {
+    return gulp
+        .src(["src/**/*.ts"])
+        .pipe(typedoc({
+            mode: 'modules',
+            includeDeclarations: true,
+
+            // Output options (see typedoc docs) 
+            out: "./docs",
+            json: "./docs/json/" + package.name + ".json",
+
+            // TypeDoc options (see typedoc docs) 
+            ignoreCompilerErrors: true,
+            version: true
+        }))
+        ;
+});
+
+gulp.task('copydemotodocs', 'Copy the demo to the docs', function () {
+    return gulp.src(["demo/**/*"])
+        .pipe(gulp.dest("docs/demo"))
+        ;
+});
+
+gulp.task('nojekyll', 'Add .nojekyll file to docs directory', function (done) {
+    fs.writeFile('./docs/.nojekyll', '', function (error) {
+        if (error) {
+            throw error;
+        }
+
+        done();
+    });
 });
 
 gulp.task('watch', 'Watches for changes', ['lint'], function () {
@@ -65,6 +105,16 @@ gulp.task('build', 'Runs a full build', function (done) {
     );
 });
 
+gulp.task('build:docs', 'Build docs folder', function (done) {
+    return runSequence(
+        'clean:docs',
+        'docs',
+        'nojekyll',
+        'copydemotodocs',
+        done
+    );
+});
+
 gulp.task('config', 'Update config version with package version', function () {
     return gulp.src(['./src/config.ts'], {base: "./"})
         .pipe(replace(/version: '([^']+)'/, `version: '${package.version}'`))
@@ -78,7 +128,16 @@ gulp.task('header', 'Add header to distributed files', function () {
 });
 
 gulp.task('clean', 'Cleans destination folder', function(done) {
-    rimraf('./dist/', done);
+    return del([
+        './dist/**/*'
+    ]);
+});
+
+gulp.task('clean:docs', 'Clean docs directory', function () {
+    return del([
+        'docs/**/*',
+        'docs'
+    ]);
 });
 
 gulp.task('lint:ts', 'Lints all TypeScript', function() {

package.json

@@ -30,6 +30,7 @@
   "author": "Microsoft",
   "license": "MIT",
   "devDependencies": {
+    "del": "^2.2.2",
     "es6-promise": "^3.2.1",
     "gulp": "^3.9.0",
     "gulp-concat": "^2.6.0",
@@ -42,6 +43,7 @@
     "gulp-replace": "^0.5.4",
     "gulp-sourcemaps": "^1.6.0",
     "gulp-tslint": "^4.3.4",
+    "gulp-typedoc": "^2.0.0",
     "gulp-typescript": "^2.12.1",
     "gulp-uglify": "^1.5.1",
     "ignore-loader": "^0.1.1",
@@ -58,11 +60,13 @@
     "karma-phantomjs-launcher": "^1.0.0",
     "karma-spec-reporter": "0.0.23",
     "merge2": "^1.0.1",
+    "moment": "^2.14.1",
     "phantomjs-prebuilt": "^2.1.3",
     "rimraf": "^2.5.1",
     "run-sequence": "^1.1.5",
     "ts-loader": "^0.8.1",
     "tslint": "^3.6.0",
+    "typedoc": "^0.4.4",
     "typescript": "^1.8.10",
     "typings": "^1.3.2",
     "webpack": "^1.12.14",