Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Upgrade to Gulp 4

Browse Source 
This required the following changes in the Gulpfile:

- Defining a series of tasks is no longer done with arrays, but with the
  `gulp.series` function. The `web` target is refactored to use a
  smaller number of tasks to prevent tasks from running multiple times.
- Getting all tasks must now be done through the task registry.
- Tasks that don't return anything must call `done` upon completion.

Moreover, this upgrade allows us to use the latest Node.js on Travis CI
again.
This commit is contained in:
Tim van der Meij 2018-11-18 18:33:23 +01:00
parent 74934db910
commit fa85f86298
No known key found for this signature in database
GPG Key ID: 8C3FD2925A5F2762
5 changed files with 563 additions and 442 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.travis.yml
View File

@ -1,6 +1,6 @@
language: node_js language: node_js
node_js: node_js:
- "10" - node
cache: cache:
directories: directories:
- node_modules - node_modules

2
examples/browserify/gulpfile.js
View File

@ -33,4 +33,4 @@ gulp.task('build-worker', function() {
.pipe(gulp.dest(OUTPUT_PATH)); .pipe(gulp.dest(OUTPUT_PATH));
}); });
gulp.task('build', ['build-bundle', 'build-worker']); gulp.task('build', gulp.series('build-bundle', 'build-worker'));

142
gulpfile.js
View File

@ -439,13 +439,14 @@ function makeRef(done, bot) {
}); });
} }
gulp.task('default', function() { gulp.task('default', function(done) {
console.log('Available tasks:'); console.log('Available tasks:');
var tasks = Object.keys(gulp.tasks); var tasks = Object.keys(gulp.registry().tasks());
tasks.sort(); tasks.sort();
tasks.forEach(function (taskName) { tasks.forEach(function (taskName) {
console.log(' ' + taskName); console.log(' ' + taskName);
}); });
done();
}); });
gulp.task('buildnumber', function (done) { gulp.task('buildnumber', function (done) {
@ -549,7 +550,7 @@ gulp.task('locale', function () {
]); ]);
}); });
gulp.task('cmaps', function () { gulp.task('cmaps', function (done) {
var CMAP_INPUT = 'external/cmaps'; var CMAP_INPUT = 'external/cmaps';
var VIEWER_CMAP_OUTPUT = 'external/bcmaps'; var VIEWER_CMAP_OUTPUT = 'external/bcmaps';
@ -573,11 +574,12 @@ gulp.task('cmaps', function () {
var compressCmaps = var compressCmaps =
require('./external/cmapscompress/compress.js').compressCmaps; require('./external/cmapscompress/compress.js').compressCmaps;
compressCmaps(CMAP_INPUT, VIEWER_CMAP_OUTPUT, true); compressCmaps(CMAP_INPUT, VIEWER_CMAP_OUTPUT, true);
done();
}); });
gulp.task('bundle', ['buildnumber'], function () { gulp.task('bundle', gulp.series('buildnumber', function () {
return createBundle(DEFINES).pipe(gulp.dest(BUILD_DIR)); return createBundle(DEFINES).pipe(gulp.dest(BUILD_DIR));
}); }));
function preprocessCSS(source, mode, defines, cleanup) { function preprocessCSS(source, mode, defines, cleanup) {
var outName = getTempFile('~preprocess', '.css'); var outName = getTempFile('~preprocess', '.css');
@ -606,7 +608,7 @@ function preprocessHTML(source, defines) {
// Builds the generic production viewer that should be compatible with most // Builds the generic production viewer that should be compatible with most
// modern HTML5 browsers. // modern HTML5 browsers.
gulp.task('generic', ['buildnumber', 'locale'], function () { gulp.task('generic', gulp.series('buildnumber', 'locale', function () {
console.log(); console.log();
console.log('### Creating generic viewer'); console.log('### Creating generic viewer');
var defines = builder.merge(DEFINES, { GENERIC: true, }); var defines = builder.merge(DEFINES, { GENERIC: true, });
@ -635,9 +637,9 @@ gulp.task('generic', ['buildnumber', 'locale'], function () {
gulp.src('web/compressed.tracemonkey-pldi-09.pdf') gulp.src('web/compressed.tracemonkey-pldi-09.pdf')
.pipe(gulp.dest(GENERIC_DIR + 'web')), .pipe(gulp.dest(GENERIC_DIR + 'web')),
]); ]);
}); }));
gulp.task('components', ['buildnumber'], function () { gulp.task('components', gulp.series('buildnumber', function () {
console.log(); console.log();
console.log('### Creating generic components'); console.log('### Creating generic components');
var defines = builder.merge(DEFINES, { COMPONENTS: true, GENERIC: true, }); var defines = builder.merge(DEFINES, { COMPONENTS: true, GENERIC: true, });
@ -658,18 +660,18 @@ gulp.task('components', ['buildnumber'], function () {
.pipe(postcss([autoprefixer(AUTOPREFIXER_CONFIG)])) .pipe(postcss([autoprefixer(AUTOPREFIXER_CONFIG)]))
.pipe(gulp.dest(COMPONENTS_DIR)), .pipe(gulp.dest(COMPONENTS_DIR)),
]); ]);
}); }));
gulp.task('image_decoders', ['buildnumber'], function() { gulp.task('image_decoders', gulp.series('buildnumber', function() {
console.log(); console.log();
console.log('### Creating image decoders'); console.log('### Creating image decoders');
var defines = builder.merge(DEFINES, { GENERIC: true, var defines = builder.merge(DEFINES, { GENERIC: true,
IMAGE_DECODERS: true, }); IMAGE_DECODERS: true, });
return createImageDecodersBundle(defines).pipe(gulp.dest(IMAGE_DECODERS_DIR)); return createImageDecodersBundle(defines).pipe(gulp.dest(IMAGE_DECODERS_DIR));
}); }));
gulp.task('minified-pre', ['buildnumber', 'locale'], function () { gulp.task('minified-pre', gulp.series('buildnumber', 'locale', function () {
console.log(); console.log();
console.log('### Creating minified viewer'); console.log('### Creating minified viewer');
var defines = builder.merge(DEFINES, { MINIFIED: true, GENERIC: true, }); var defines = builder.merge(DEFINES, { MINIFIED: true, GENERIC: true, });
@ -700,9 +702,9 @@ gulp.task('minified-pre', ['buildnumber', 'locale'], function () {
gulp.src('web/compressed.tracemonkey-pldi-09.pdf') gulp.src('web/compressed.tracemonkey-pldi-09.pdf')
.pipe(gulp.dest(MINIFIED_DIR + 'web')), .pipe(gulp.dest(MINIFIED_DIR + 'web')),
]); ]);
}); }));
gulp.task('minified-post', ['minified-pre'], function () { gulp.task('minified-post', gulp.series('minified-pre', function (done) {
var pdfFile = fs.readFileSync(MINIFIED_DIR + '/build/pdf.js').toString(); var pdfFile = fs.readFileSync(MINIFIED_DIR + '/build/pdf.js').toString();
var pdfWorkerFile = var pdfWorkerFile =
fs.readFileSync(MINIFIED_DIR + '/build/pdf.worker.js').toString(); fs.readFileSync(MINIFIED_DIR + '/build/pdf.worker.js').toString();
@ -742,9 +744,10 @@ gulp.task('minified-post', ['minified-pre'], function () {
MINIFIED_DIR + '/build/pdf.worker.js'); MINIFIED_DIR + '/build/pdf.worker.js');
fs.renameSync(MINIFIED_DIR + '/image_decoders/pdf.image_decoders.min.js', fs.renameSync(MINIFIED_DIR + '/image_decoders/pdf.image_decoders.min.js',
MINIFIED_DIR + '/image_decoders/pdf.image_decoders.js'); MINIFIED_DIR + '/image_decoders/pdf.image_decoders.js');
}); done();
}));
gulp.task('minified', ['minified-post']); gulp.task('minified', gulp.series('minified-post'));
function preprocessDefaultPreferences(content) { function preprocessDefaultPreferences(content) {
var preprocessor2 = require('./external/builder/preprocessor2.js'); var preprocessor2 = require('./external/builder/preprocessor2.js');
@ -763,7 +766,7 @@ function preprocessDefaultPreferences(content) {
content + '\n'); content + '\n');
} }
gulp.task('mozcentral-pre', ['buildnumber', 'locale'], function () { gulp.task('mozcentral-pre', gulp.series('buildnumber', 'locale', function () {
console.log(); console.log();
console.log('### Building mozilla-central extension'); console.log('### Building mozilla-central extension');
var defines = builder.merge(DEFINES, { MOZCENTRAL: true, SKIP_BABEL: true, }); var defines = builder.merge(DEFINES, { MOZCENTRAL: true, SKIP_BABEL: true, });
@ -809,11 +812,11 @@ gulp.task('mozcentral-pre', ['buildnumber', 'locale'], function () {
.pipe(transform('utf8', preprocessDefaultPreferences)) .pipe(transform('utf8', preprocessDefaultPreferences))
.pipe(gulp.dest(MOZCENTRAL_CONTENT_DIR)), .pipe(gulp.dest(MOZCENTRAL_CONTENT_DIR)),
]); ]);
}); }));
gulp.task('mozcentral', ['mozcentral-pre']); gulp.task('mozcentral', gulp.series('mozcentral-pre'));
gulp.task('chromium-pre', ['buildnumber', 'locale'], function () { gulp.task('chromium-pre', gulp.series('buildnumber', 'locale', function () {
console.log(); console.log();
console.log('### Building Chromium extension'); console.log('### Building Chromium extension');
var defines = builder.merge(DEFINES, { CHROME: true, }); var defines = builder.merge(DEFINES, { CHROME: true, });
@ -856,9 +859,9 @@ gulp.task('chromium-pre', ['buildnumber', 'locale'], function () {
], { base: 'extensions/chromium/', }) ], { base: 'extensions/chromium/', })
.pipe(gulp.dest(CHROME_BUILD_DIR)), .pipe(gulp.dest(CHROME_BUILD_DIR)),
]); ]);
}); }));
gulp.task('chromium', ['chromium-pre']); gulp.task('chromium', gulp.series('chromium-pre'));
gulp.task('jsdoc', function (done) { gulp.task('jsdoc', function (done) {
console.log(); console.log();
@ -880,7 +883,7 @@ gulp.task('jsdoc', function (done) {
}); });
}); });
gulp.task('lib', ['buildnumber'], function () { gulp.task('lib', gulp.series('buildnumber', function () {
// When we create a bundle, webpack is run on the source and it will replace // When we create a bundle, webpack is run on the source and it will replace
// require with __webpack_require__. When we want to use the real require, // require with __webpack_require__. When we want to use the real require,
// __non_webpack_require__ has to be used. // __non_webpack_require__ has to be used.
@ -960,11 +963,9 @@ gulp.task('lib', ['buildnumber'], function () {
gulp.src('external/url/url-lib.js', { base: '.', }) gulp.src('external/url/url-lib.js', { base: '.', })
.pipe(gulp.dest('build/')), .pipe(gulp.dest('build/')),
]); ]);
}); }));
gulp.task('web-pre', ['generic', 'jsdoc']); gulp.task('publish', gulp.series('generic', function (done) {
gulp.task('publish', ['generic'], function (done) {
var version = JSON.parse( var version = JSON.parse(
fs.readFileSync(BUILD_DIR + 'version.json').toString()).version; fs.readFileSync(BUILD_DIR + 'version.json').toString()).version;
@ -983,43 +984,49 @@ gulp.task('publish', ['generic'], function (done) {
done(); done();
}); });
}); });
}); }));
gulp.task('testing-pre', function() { gulp.task('testing-pre', function(done) {
process.env['TESTING'] = 'true'; process.env['TESTING'] = 'true';
done();
}); });
gulp.task('test', ['testing-pre', 'generic', 'components'], function() { gulp.task('test', gulp.series('testing-pre', 'generic', 'components',
function() {
return streamqueue({ objectMode: true, }, return streamqueue({ objectMode: true, },
createTestSource('unit'), createTestSource('browser')); createTestSource('unit'), createTestSource('browser'));
}); }));
gulp.task('bottest', ['testing-pre', 'generic', 'components'], function() { gulp.task('bottest', gulp.series('testing-pre', 'generic', 'components',
function() {
return streamqueue({ objectMode: true, }, return streamqueue({ objectMode: true, },
createTestSource('unit', true), createTestSource('font', true), createTestSource('unit', true), createTestSource('font', true),
createTestSource('browser (no reftest)', true)); createTestSource('browser (no reftest)', true));
}); }));
gulp.task('browsertest', ['testing-pre', 'generic', 'components'], function() { gulp.task('browsertest', gulp.series('testing-pre', 'generic', 'components',
function() {
return createTestSource('browser'); return createTestSource('browser');
}); }));
gulp.task('unittest', ['testing-pre', 'generic', 'components'], function() { gulp.task('unittest', gulp.series('testing-pre', 'generic', 'components',
function() {
return createTestSource('unit'); return createTestSource('unit');
}); }));
gulp.task('fonttest', ['testing-pre'], function() { gulp.task('fonttest', gulp.series('testing-pre', function() {
return createTestSource('font'); return createTestSource('font');
}); }));
gulp.task('makeref', ['testing-pre', 'generic', 'components'], function(done) { gulp.task('makeref', gulp.series('testing-pre', 'generic', 'components',
function(done) {
makeRef(done); makeRef(done);
}); }));
gulp.task('botmakeref', ['testing-pre', 'generic', 'components'], gulp.task('botmakeref', gulp.series('testing-pre', 'generic', 'components',
function(done) { function(done) {
makeRef(done, true); makeRef(done, true);
}); }));
gulp.task('baseline', function (done) { gulp.task('baseline', function (done) {
console.log(); console.log();
@ -1057,7 +1064,7 @@ gulp.task('baseline', function (done) {
}); });
}); });
gulp.task('unittestcli', ['testing-pre', 'lib'], function(done) { gulp.task('unittestcli', gulp.series('testing-pre', 'lib', function(done) {
var options = ['node_modules/jasmine/bin/jasmine', var options = ['node_modules/jasmine/bin/jasmine',
'JASMINE_CONFIG_PATH=test/unit/clitests.json']; 'JASMINE_CONFIG_PATH=test/unit/clitests.json'];
var jasmineProcess = spawn('node', options, { stdio: 'inherit', }); var jasmineProcess = spawn('node', options, { stdio: 'inherit', });
@ -1068,7 +1075,7 @@ gulp.task('unittestcli', ['testing-pre', 'lib'], function(done) {
} }
done(); done();
}); });
}); }));
gulp.task('lint', function (done) { gulp.task('lint', function (done) {
console.log(); console.log();
@ -1099,7 +1106,7 @@ gulp.task('lint', function (done) {
}); });
}); });
gulp.task('server', function (done) { gulp.task('server', function () {
console.log(); console.log();
console.log('### Starting local server'); console.log('### Starting local server');
@ -1109,11 +1116,11 @@ gulp.task('server', function (done) {
server.start(); server.start();
}); });
gulp.task('clean', function(callback) { gulp.task('clean', function(done) {
console.log(); console.log();
console.log('### Cleaning up project builds'); console.log('### Cleaning up project builds');
rimraf(BUILD_DIR, callback); rimraf(BUILD_DIR, done);
}); });
gulp.task('makefile', function () { gulp.task('makefile', function () {
@ -1140,7 +1147,7 @@ gulp.task('importl10n', function(done) {
locales.downloadL10n(L10N_DIR, done); locales.downloadL10n(L10N_DIR, done);
}); });
gulp.task('gh-pages-prepare', ['web-pre'], function () { gulp.task('gh-pages-prepare', function () {
console.log(); console.log();
console.log('### Creating web site'); console.log('### Creating web site');
@ -1157,7 +1164,7 @@ gulp.task('gh-pages-prepare', ['web-pre'], function () {
]); ]);
}); });
gulp.task('wintersmith', ['gh-pages-prepare'], function (done) { gulp.task('wintersmith', function (done) {
var wintersmith = require('wintersmith'); var wintersmith = require('wintersmith');
var env = wintersmith('docs/config.json'); var env = wintersmith('docs/config.json');
env.build(GH_PAGES_DIR, function (error) { env.build(GH_PAGES_DIR, function (error) {
@ -1182,7 +1189,7 @@ gulp.task('wintersmith', ['gh-pages-prepare'], function (done) {
}); });
}); });
gulp.task('gh-pages-git', ['gh-pages-prepare', 'wintersmith'], function () { gulp.task('gh-pages-git', function (done) {
var VERSION = getVersionJSON().version; var VERSION = getVersionJSON().version;
var reason = process.env['PDFJS_UPDATE_REASON']; var reason = process.env['PDFJS_UPDATE_REASON'];
@ -1198,12 +1205,14 @@ gulp.task('gh-pages-git', ['gh-pages-prepare', 'wintersmith'], function () {
console.log(); console.log();
console.log('Website built in ' + GH_PAGES_DIR); console.log('Website built in ' + GH_PAGES_DIR);
done();
}); });
gulp.task('web', ['gh-pages-prepare', 'wintersmith', 'gh-pages-git']); gulp.task('web', gulp.series('generic', 'jsdoc', 'gh-pages-prepare',
'wintersmith', 'gh-pages-git'));
gulp.task('dist-pre', gulp.task('dist-pre', gulp.series('generic', 'components', 'image_decoders',
['generic', 'components', 'image_decoders', 'lib', 'minified'], function() { 'lib', 'minified', function() {
var VERSION = getVersionJSON().version; var VERSION = getVersionJSON().version;
console.log(); console.log();
@ -1306,9 +1315,9 @@ gulp.task('dist-pre',
gulp.src(LIB_DIR + '**/*', { base: LIB_DIR, }) gulp.src(LIB_DIR + '**/*', { base: LIB_DIR, })
.pipe(gulp.dest(DIST_DIR + 'lib/')), .pipe(gulp.dest(DIST_DIR + 'lib/')),
]); ]);
}); }));
gulp.task('dist-install', ['dist-pre'], function () { gulp.task('dist-install', gulp.series('dist-pre', function (done) {
var distPath = DIST_DIR; var distPath = DIST_DIR;
var opts = {}; var opts = {};
var installPath = process.env['PDFJS_INSTALL_PATH']; var installPath = process.env['PDFJS_INSTALL_PATH'];
@ -1317,9 +1326,10 @@ gulp.task('dist-install', ['dist-pre'], function () {
distPath = path.relative(installPath, distPath); distPath = path.relative(installPath, distPath);
} }
safeSpawnSync('npm', ['install', distPath], opts); safeSpawnSync('npm', ['install', distPath], opts);
}); done();
}));
gulp.task('dist-repo-git', ['dist-pre'], function () { gulp.task('dist-repo-git', gulp.series('dist-pre', function (done) {
var VERSION = getVersionJSON().version; var VERSION = getVersionJSON().version;
console.log(); console.log();
@ -1337,11 +1347,12 @@ gulp.task('dist-repo-git', ['dist-pre'], function () {
console.log(' cd ' + DIST_DIR + '; ' + console.log(' cd ' + DIST_DIR + '; ' +
'git push --tags ' + DIST_REPO_URL + ' master'); 'git push --tags ' + DIST_REPO_URL + ' master');
console.log(); console.log();
}); done();
}));
gulp.task('dist', ['dist-repo-git']); gulp.task('dist', gulp.series('dist-repo-git'));
gulp.task('mozcentralbaseline', ['baseline'], function (done) { gulp.task('mozcentralbaseline', gulp.series('baseline', function (done) {
console.log(); console.log();
console.log('### Creating mozcentral baseline environment'); console.log('### Creating mozcentral baseline environment');
@ -1366,9 +1377,9 @@ gulp.task('mozcentralbaseline', ['baseline'], function (done) {
{ cwd: MOZCENTRAL_BASELINE_DIR, }); { cwd: MOZCENTRAL_BASELINE_DIR, });
done(); done();
}); });
}); }));
gulp.task('mozcentraldiff', ['mozcentral', 'mozcentralbaseline'], gulp.task('mozcentraldiff', gulp.series('mozcentral', 'mozcentralbaseline',
function (done) { function (done) {
console.log(); console.log();
console.log('### Creating mozcentral diff'); console.log('### Creating mozcentral diff');
@ -1396,13 +1407,14 @@ gulp.task('mozcentraldiff', ['mozcentral', 'mozcentralbaseline'],
done(); done();
}); });
}); });
}); }));
gulp.task('externaltest', function () { gulp.task('externaltest', function (done) {
fancylog('Running test-fixtures.js'); fancylog('Running test-fixtures.js');
safeSpawnSync('node', ['external/builder/test-fixtures.js'], safeSpawnSync('node', ['external/builder/test-fixtures.js'],
{ stdio: 'inherit', }); { stdio: 'inherit', });
fancylog('Running test-fixtures_esprima.js'); fancylog('Running test-fixtures_esprima.js');
safeSpawnSync('node', ['external/builder/test-fixtures_esprima.js'], safeSpawnSync('node', ['external/builder/test-fixtures_esprima.js'],
{ stdio: 'inherit', }); { stdio: 'inherit', });
done();
}); });

857
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

2
package.json
View File

@ -19,7 +19,7 @@
"eslint-plugin-unicorn": "^4.0.3", "eslint-plugin-unicorn": "^4.0.3",
"fancy-log": "^1.3.2", "fancy-log": "^1.3.2",
"globals": "^9.18.0", "globals": "^9.18.0",
"gulp": "^3.9.1", "gulp": "^4.0.0",
"gulp-postcss": "^7.0.1", "gulp-postcss": "^7.0.1",
"gulp-rename": "^1.4.0", "gulp-rename": "^1.4.0",
"gulp-replace": "^1.0.0", "gulp-replace": "^1.0.0",