gulpfile.js

   1 const browserify = require('browserify');
   2 const buffer = require('vinyl-buffer');
   3 const coveralls = require('gulp-coveralls');
   4 const fs = require('fs-extra');
   5 const gulp = require('gulp');
   6 const istanbul = require('gulp-istanbul');
   7 const merge = require('merge-stream');
   8 const mocha = require('gulp-mocha');
   9 const sorcery = require('sorcery');
  10 const source = require('vinyl-source-stream');
  11 const sourcemaps = require('gulp-sourcemaps');
  12 const ts = require('gulp-typescript');
  13
  14
  15 let buildDir = process.env.BUILD_DIR || 'build';
  16 let tsProject = ts.createProject('tsconfig.json');
  17 let srcDir = tsProject.config.compilerOptions.rootDir;
  18 let outDir = tsProject.config.compilerOptions.outDir;
  19
  20 /**
  21  * Compile TypeScript sources to JavaScript files and create a source map file for each TypeScript
  22  * file compiled.
  23  */
  24 gulp.task('tsc', function () {
  25   // Remove the ${outDir}/ directory to prevent confusion if files were deleted in ${srcDir}/
  26   fs.emptyDirSync(`${outDir}`);
  27
  28   // Build all TypeScript files (including tests) to ${outDir}/, based on the configuration defined in
  29   // `tsconfig.json`.
  30   let tsResult = tsProject.src().pipe(sourcemaps.init()).pipe(tsProject());
  31   let tsc = tsResult.js.pipe(sourcemaps.write('.', {includeContent: false, sourceRoot: ''})).pipe(gulp.dest(outDir));
  32
  33   // Copy all addons from ${srcDir}/ to ${outDir}/
  34   let copyAddons = gulp.src(`${srcDir}/addons/**/*`).pipe(gulp.dest(`${outDir}/addons`));
  35
  36   // Copy stylesheets from ${srcDir}/ to ${outDir}/
  37   let copyStylesheets = gulp.src(`${srcDir}/**/*.css`).pipe(gulp.dest(outDir));
  38
  39   return merge(tsc, copyAddons, copyStylesheets);
  40 });
  41
  42 /**
  43  * Bundle JavaScript files produced by the `tsc` task, into a single file named `xterm.js` with
  44  * Browserify.
  45  */
  46 gulp.task('browserify', ['tsc'], function() {
  47   // Ensure that the build directory exists
  48   fs.ensureDirSync(buildDir);
  49
  50   let browserifyOptions = {
  51     basedir: buildDir,
  52     debug: true,
  53     entries: [`../${outDir}/xterm.js`],
  54     standalone: 'Terminal',
  55     cache: {},
  56     packageCache: {}
  57   };
  58   let bundleStream = browserify(browserifyOptions)
  59         .bundle()
  60         .pipe(source('xterm.js'))
  61         .pipe(buffer())
  62         .pipe(sourcemaps.init({loadMaps: true, sourceRoot: '..'}))
  63         .pipe(sourcemaps.write('./'))
  64         .pipe(gulp.dest(buildDir));
  65
  66   // Copy all add-ons from ${outDir}/ to buildDir
  67   let copyAddons = gulp.src(`${outDir}/addons/**/*`).pipe(gulp.dest(`${buildDir}/addons`));
  68
  69   // Copy stylesheets from ${outDir}/ to ${buildDir}/
  70   let copyStylesheets = gulp.src(`${outDir}/**/*.css`).pipe(gulp.dest(buildDir));
  71
  72   return merge(bundleStream, copyAddons, copyStylesheets);
  73 });
  74
  75 gulp.task('instrument-test', function () {
  76   return gulp.src([`${outDir}/**/*.js`])
  77     // Covering files
  78     .pipe(istanbul())
  79     // Force `require` to return covered files
  80     .pipe(istanbul.hookRequire());
  81 });
  82
  83 gulp.task('mocha', ['instrument-test'], function () {
  84   return gulp.src([`${outDir}/*test.js`, `${outDir}/**/*test.js`], {read: false})
  85       .pipe(mocha())
  86       .pipe(istanbul.writeReports());
  87 });
  88
  89 /**
  90  * Use `sorcery` to resolve the source map chain and point back to the TypeScript files.
  91  * (Without this task the source maps produced for the JavaScript bundle points into the
  92  * compiled JavaScript files in ${outDir}/).
  93  */
  94 gulp.task('sorcery', ['browserify'], function () {
  95   var chain = sorcery.loadSync(`${buildDir}/xterm.js`);
  96   chain.apply();
  97   chain.writeSync();
  98 });
  99
 100 /**
 101  * Submit coverage results to coveralls.io
 102  */
 103 gulp.task('coveralls', function () {
 104   gulp.src('coverage/**/lcov.info')
 105     .pipe(coveralls());
 106 });
 107
 108 gulp.task('build', ['sorcery']);
 109 gulp.task('test', ['mocha']);
 110 gulp.task('default', ['build']);