]>
git.proxmox.com Git - mirror_xterm.js.git/blob - gulpfile.js
5 const browserify
= require('browserify');
6 const buffer
= require('vinyl-buffer');
7 const coveralls
= require('gulp-coveralls');
8 const fs
= require('fs-extra');
9 const gulp
= require('gulp');
10 const istanbul
= require('gulp-istanbul');
11 const merge
= require('merge-stream');
12 const mocha
= require('gulp-mocha');
13 const sorcery
= require('sorcery');
14 const source
= require('vinyl-source-stream');
15 const sourcemaps
= require('gulp-sourcemaps');
16 const ts
= require('gulp-typescript');
19 let buildDir
= process
.env
.BUILD_DIR
|| 'build';
20 let tsProject
= ts
.createProject('tsconfig.json');
21 let tsProjectSearchAddon
= ts
.createProject('./src/addons/search/tsconfig.json');
22 let srcDir
= tsProject
.config
.compilerOptions
.rootDir
;
23 let outDir
= tsProject
.config
.compilerOptions
.outDir
;
26 * Compile TypeScript sources to JavaScript files and create a source map file for each TypeScript
29 gulp
.task('tsc', function () {
30 // Remove the ${outDir}/ directory to prevent confusion if files were deleted in ${srcDir}/
31 fs
.emptyDirSync(`${outDir}`);
33 // Build all TypeScript files (including tests) to ${outDir}/, based on the configuration defined in
35 let tsResult
= tsProject
.src().pipe(sourcemaps
.init()).pipe(tsProject());
36 let tsc
= tsResult
.js
.pipe(sourcemaps
.write('.', {includeContent
: false, sourceRoot
: ''})).pipe(gulp
.dest(outDir
));
38 fs
.emptyDirSync(`${outDir}/addons/search`);
39 let tsResultSearchAddon
= tsProjectSearchAddon
.src().pipe(sourcemaps
.init()).pipe(tsProjectSearchAddon());
40 let tscSearchAddon
= tsResultSearchAddon
.js
.pipe(sourcemaps
.write('.', {includeContent
: false, sourceRoot
: ''})).pipe(gulp
.dest(`${outDir}/addons/search`));
42 // Copy all addons from ${srcDir}/ to ${outDir}/
43 let copyAddons
= gulp
.src([`${srcDir}/addons/**/*`, `!${srcDir}/addons/search`, `!${srcDir}/addons/search/**`]).pipe(gulp
.dest(`${outDir}/addons`));
45 // Copy stylesheets from ${srcDir}/ to ${outDir}/
46 let copyStylesheets
= gulp
.src(`${srcDir}/**/*.css`).pipe(gulp
.dest(outDir
));
48 return merge(tsc
, tscSearchAddon
, copyAddons
, copyStylesheets
);
52 * Bundle JavaScript files produced by the `tsc` task, into a single file named `xterm.js` with
55 gulp
.task('browserify', ['tsc'], function() {
56 // Ensure that the build directory exists
57 fs
.ensureDirSync(buildDir
);
59 let browserifyOptions
= {
62 entries
: [`${outDir}/xterm.js`],
63 standalone
: 'Terminal',
67 let bundleStream
= browserify(browserifyOptions
)
69 .pipe(source('xterm.js'))
71 .pipe(sourcemaps
.init({loadMaps
: true, sourceRoot
: '..'}))
72 .pipe(sourcemaps
.write('./'))
73 .pipe(gulp
.dest(buildDir
));
75 // Copy stylesheets from ${outDir}/ to ${buildDir}/
76 let copyStylesheets
= gulp
.src(`${outDir}/**/*.css`).pipe(gulp
.dest(buildDir
));
78 return merge(bundleStream
, copyStylesheets
);
81 gulp
.task('browserify-addons', ['tsc'], function() {
83 basedir
: `${buildDir}/addons/search`,
85 entries
: [`${outDir}/addons/search/search.js`],
89 let searchBundle
= browserify(searchOptions
)
91 .pipe(source('./addons/search/search.js'))
93 .pipe(sourcemaps
.init({loadMaps
: true, sourceRoot
: ''}))
94 .pipe(sourcemaps
.write('./'))
95 .pipe(gulp
.dest(buildDir
));
97 // Copy all add-ons from outDir to buildDir
98 let copyAddons
= gulp
.src([
100 `${outDir}/addons/**/*`,
101 // Exclude TS addons from copy as they are being built via browserify
102 `!${outDir}/addons/search`,
103 `!${outDir}/addons/search/**`
104 ]).pipe(gulp
.dest(`${buildDir}/addons`));
106 return merge(searchBundle
, copyAddons
);
109 gulp
.task('instrument-test', function () {
110 return gulp
.src([`${outDir}/**/*.js`])
113 // Force `require` to return covered files
114 .pipe(istanbul
.hookRequire());
117 gulp
.task('mocha', ['instrument-test'], function () {
118 return gulp
.src([`${outDir}/*test.js`, `${outDir}/**/*test.js`], {read
: false})
120 .once('error', () => process
.exit(1))
121 .pipe(istanbul
.writeReports());
125 * Use `sorcery` to resolve the source map chain and point back to the TypeScript files.
126 * (Without this task the source maps produced for the JavaScript bundle points into the
127 * compiled JavaScript files in ${outDir}/).
129 gulp
.task('sorcery', ['browserify'], function () {
130 var chain
= sorcery
.loadSync(`${buildDir}/xterm.js`);
135 gulp
.task('sorcery-addons', ['browserify-addons'], function () {
136 var chain
= sorcery
.loadSync(`${buildDir}/addons/search/search.js`);
142 * Submit coverage results to coveralls.io
144 gulp
.task('coveralls', function () {
145 gulp
.src('coverage/**/lcov.info')
149 gulp
.task('build', ['sorcery', 'sorcery-addons']);
150 gulp
.task('test', ['mocha']);
151 gulp
.task('default', ['build']);