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');
15 let buildDir
= process
.env
.BUILD_DIR
|| 'build';
16 let tsProject
= ts
.createProject('tsconfig.json');
17 let tsProjectSearchAddon
= ts
.createProject('./src/addons/search/tsconfig.json');
18 let srcDir
= tsProject
.config
.compilerOptions
.rootDir
;
19 let outDir
= tsProject
.config
.compilerOptions
.outDir
;
22 * Compile TypeScript sources to JavaScript files and create a source map file for each TypeScript
25 gulp
.task('tsc', function () {
26 // Remove the ${outDir}/ directory to prevent confusion if files were deleted in ${srcDir}/
27 fs
.emptyDirSync(`${outDir}`);
29 // Build all TypeScript files (including tests) to ${outDir}/, based on the configuration defined in
31 let tsResult
= tsProject
.src().pipe(sourcemaps
.init()).pipe(tsProject());
32 let tsc
= tsResult
.js
.pipe(sourcemaps
.write('.', {includeContent
: false, sourceRoot
: ''})).pipe(gulp
.dest(outDir
));
34 fs
.emptyDirSync(`${outDir}/addons`);
35 fs
.emptyDirSync(`${outDir}/addons/search`);
36 let tsResultSearchAddon
= tsProjectSearchAddon
.src().pipe(sourcemaps
.init()).pipe(tsProjectSearchAddon());
37 let tscSearchAddon
= tsResultSearchAddon
.js
.pipe(sourcemaps
.write('.', {includeContent
: false, sourceRoot
: ''})).pipe(gulp
.dest(`${outDir}/addons/search`));
39 // Copy all addons from ${srcDir}/ to ${outDir}/
40 let copyAddons
= gulp
.src([`${srcDir}/addons/**/*`, `!${srcDir}/addons/search`, `!${srcDir}/addons/search/**`]).pipe(gulp
.dest(`${outDir}/addons`));
42 // Copy stylesheets from ${srcDir}/ to ${outDir}/
43 let copyStylesheets
= gulp
.src(`${srcDir}/**/*.css`).pipe(gulp
.dest(outDir
));
45 return merge(tsc
, tscSearchAddon
, copyAddons
, copyStylesheets
);
49 * Bundle JavaScript files produced by the `tsc` task, into a single file named `xterm.js` with
52 gulp
.task('browserify', ['tsc'], function() {
53 // Ensure that the build directory exists
54 fs
.ensureDirSync(buildDir
);
56 let browserifyOptions
= {
59 entries
: [`../${outDir}/xterm.js`],
60 standalone
: 'Terminal',
64 let bundleStream
= browserify(browserifyOptions
)
66 .pipe(source('xterm.js'))
68 .pipe(sourcemaps
.init({loadMaps
: true, sourceRoot
: '..'}))
69 .pipe(sourcemaps
.write('./'))
70 .pipe(gulp
.dest(buildDir
));
72 let browserifyOptionsSearchAddon
= {
75 entries
: [`../${outDir}/addons/search/search.js`],
79 let bundleStreamSearchAddon
= browserify(browserifyOptionsSearchAddon
)
81 .pipe(source('./addons/search/search.js'))
83 .pipe(sourcemaps
.init({loadMaps
: true, sourceRoot
: '..'}))
84 .pipe(sourcemaps
.write('./'))
85 .pipe(gulp
.dest(buildDir
));
87 // Copy all add-ons from ${outDir}/ to buildDir
88 let copyAddons
= gulp
.src([`${outDir}/addons/**/*`, `!${outDir}/addons/search`, `!${outDir}/addons/search/**`]).pipe(gulp
.dest(`${buildDir}/addons`));
90 // Copy stylesheets from ${outDir}/ to ${buildDir}/
91 let copyStylesheets
= gulp
.src(`${outDir}/**/*.css`).pipe(gulp
.dest(buildDir
));
93 return merge(bundleStream
, bundleStreamSearchAddon
, copyAddons
, copyStylesheets
);
96 gulp
.task('instrument-test', function () {
97 return gulp
.src([`${outDir}/**/*.js`])
100 // Force `require` to return covered files
101 .pipe(istanbul
.hookRequire());
104 gulp
.task('mocha', ['instrument-test'], function () {
105 return gulp
.src([`${outDir}/*test.js`, `${outDir}/**/*test.js`], {read
: false})
107 .once('error', () => process
.exit(1))
108 .pipe(istanbul
.writeReports());
112 * Use `sorcery` to resolve the source map chain and point back to the TypeScript files.
113 * (Without this task the source maps produced for the JavaScript bundle points into the
114 * compiled JavaScript files in ${outDir}/).
116 gulp
.task('sorcery', ['browserify'], function () {
117 var chain
= sorcery
.loadSync(`${buildDir}/xterm.js`);
123 * Submit coverage results to coveralls.io
125 gulp
.task('coveralls', function () {
126 gulp
.src('coverage/**/lcov.info')
130 gulp
.task('build', ['sorcery']);
131 gulp
.task('test', ['mocha']);
132 gulp
.task('default', ['build']);