gulpfile.js

const fs = require('fs');
const gulp = require('gulp');
const ghPages = require('gulp-gh-pages');
const header = require('gulp-header');
const help = require('gulp-help-four');
const rename = require('gulp-rename');
const replace = require('gulp-replace');
const eslint = require("gulp-eslint");
const ts = require('gulp-typescript');
const flatten = require('gulp-flatten');
const del = require('del');
const moment = require('moment');
const karma = require('karma');
const typedoc = require('gulp-typedoc');
const watch = require('gulp-watch');
const webpack = require('webpack');
const webpackStream = require('webpack-stream');
const runSequence = require('gulp4-run-sequence');
const webpackConfig = require('./webpack.config');
const webpackTestConfig = require('./webpack.test.config');
const argv = require('yargs').argv;

help(gulp, undefined);

const package = require('./package.json');
const webpackBanner = "// " + package.name + " v" + package.version + "\n"
  + "// Copyright (c) Microsoft Corporation.\n"
  + "// Licensed under the MIT License.";
const banner = webpackBanner + "\n";

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([
      "node_modules/es6-promise/es6-promise.d.ts",
      "node_modules/powerbi-models/dist/models.d.ts",
      "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 () {
  gulp.watch(['./src/**/*.ts', './test/**/*.ts'], ['lint:ts']);
  gulp.watch(['./test/**/*.ts'], ['test']);
});

gulp.task('lint', 'Lints all files', function (done) {
  runSequence(
    'lint:ts',
    done
  );
});

gulp.task('test', 'Runs all tests', function (done) {
  runSequence(
    'lint:ts',
    'config',
    'compile:spec',
    'test:js',
    done
  );
});

gulp.task('build', 'Runs a full build', function (done) {
  runSequence(
    'lint:ts',
    'clean',
    'config',
    ['compile:ts', 'compile:dts'],
    'min:js',
    'header',
    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}'`))
    .pipe(gulp.dest('.'));
});

gulp.task('header', 'Add header to distributed files', function () {
  return gulp.src(['./dist/*.d.ts'])
    .pipe(header(banner))
    .pipe(gulp.dest('./dist'));
});

gulp.task('clean', 'Cleans destination folder', function (done) {
  return del([
    './dist/**/*'
  ]);
});

gulp.task('clean:docs', 'Clean docs directory', function () {
  return del([
    'docs/**/*',
    'docs'
  ]);
});

gulp.task('lint:ts', 'Lints all TypeScript', function () {
  return gulp.src(['./src/**/*.ts', './test/**/*.ts'])
    .pipe(eslint({
      formatter: "verbose"
    }))
    .pipe(eslint.format());
});

gulp.task('min:js', 'Creates minified JavaScript file', function () {
  webpackConfig.plugins = [
    new webpack.BannerPlugin({
      banner: webpackBanner,
      raw: true
    })
  ];

  // Create minified bundle without source map
  webpackConfig.mode = 'production';
  webpackConfig.devtool = false;

  return gulp.src(['./src/powerbi-client.ts'])
    .pipe(webpackStream({
      config: webpackConfig
    }))
    .pipe(header(banner))
    .pipe(rename({
      suffix: '.min'
    }))
    .pipe(gulp.dest('dist/'));
});

gulp.task('compile:ts', 'Compile typescript for powerbi-client library', function () {
  webpackConfig.plugins = [
    new webpack.BannerPlugin({
      banner: webpackBanner,
      raw: true
    })
  ];
  webpackConfig.mode = "development";

  return gulp.src(['./src/powerbi-client.ts'])
    .pipe(webpackStream(webpackConfig))
    .pipe(gulp.dest('dist/'));
});

gulp.task('compile:dts', 'Generate one dts file from modules', function () {
  const tsProject = ts.createProject('tsconfig.json', {
    declaration: true,
    sourceMap: false
  });

  const settings = {
    out: "powerbi-client.js",
    declaration: true,
    module: "system",
    moduleResolution: "node"
  };

  const tsResult = tsProject.src()
    .pipe(ts(settings));

  return tsResult.dts
    .pipe(flatten())
    .pipe(gulp.dest('./dist'));
});

gulp.task('compile:spec', 'Compile spec tests', function () {
  return gulp.src(['./test/**/*.ts'])
    .pipe(webpackStream(webpackTestConfig))
    .pipe(gulp.dest('./tmp'));
});

gulp.task('test:js', 'Run js tests', function (done) {
  new karma.Server({
    configFile: __dirname + '/karma.conf.js',
    singleRun: argv.watch ? false : true,
    captureTimeout: argv.timeout || 60000
  }, function (exitStatus) {
    done();
    //process.exit(exitStatus); TODO: Return it back after migration from PhantomJS to chromeHeadless
  })
    .on('browser_register', (browser) => {
      if (argv.chrome) {
        browser.socket.on('disconnect', function (reason) {
          if (reason === "transport close" || reason === "transport error") {
            done(0);
            process.exit(0);
          }
        });
      }
    })
    .start();
  if (argv.chrome) {
    return watch(["src/**/*.ts", "test/**/*.ts"], function () {
      runSequence('compile:spec');
    });
  }
});