-
Notifications
You must be signed in to change notification settings - Fork 131
/
gulpfile.js
546 lines (489 loc) · 18.6 KB
/
gulpfile.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
'use strict';
var child_process = require('child_process');
var readline = require('readline');
var path = require('path');
var Promise = require('bluebird');
var dateFormat = require('dateformat');
var minimist = require('minimist');
var gulp = require('gulp');
var replace = require('gulp-replace');
var rename = require('gulp-rename');
var zip = require('gulp-zip');
var fs = require('fs');
Promise.promisifyAll(fs);
var glob = Promise.promisify(require('glob'));
var rimraf = Promise.promisify(require('rimraf'));
var tmpFile = Promise.promisify(require('tmp').file, {multiArgs: true});
var sass = require('gulp-sass')(require('sass'));
var postcss = require('gulp-postcss');
var autoprefixer = require('autoprefixer');
var composerDir = __dirname + '/vendor/bin';
var buildDir = __dirname + '/build';
var dataDir = __dirname + '/application/data';
var scriptsDir = dataDir + '/scripts';
var langDir = __dirname + '/application/language';
var pot = langDir + '/template.pot';
var cliOptions = minimist(process.argv.slice(2), {
string: ['php-path', 'module-name'],
boolean: 'dev',
alias: {'module-name': 'module'},
default: {'php-path': 'php', 'dev': true, 'module-name': null}
});
function ensureBuildDir() {
return fs.statAsync(buildDir).catch(function (e) {
return fs.mkdirAsync(buildDir);
}).then(function () {
return fs.statAsync(buildDir + '/cache');
}).catch(function (e) {
fs.mkdirAsync(buildDir + '/cache');
});
}
function download(url, path) {
return ensureBuildDir().then(function () {
return new Promise(function (resolve, reject) {
var https = require('https');
var file = fs.createWriteStream(path);
file.on('finish', function () {
resolve();
});
https.get(url, function (response) {
response.pipe(file);
}).on('error', function(err) {
reject(err);
});
});
});
}
function runCommand(cmd, args, options, resolveWith) {
return new Promise(function (resolve, reject) {
if (!options) {
options = {};
}
if (!options.stdio) {
options.stdio = 'inherit';
}
child_process.spawn(cmd, args, options)
.on('exit', function (code) {
if (code !== 0) {
reject(new Error('Command "' + cmd + '" exited with code ' + code));
} else {
resolve(resolveWith);
}
});
});
}
function runPhpCommand(cmd, args, options, resolveWith) {
return runCommand(cliOptions['php-path'], [cmd].concat(args), options, resolveWith);
}
function composer(args, options) {
var composerPath = buildDir + '/composer.phar';
var installerPath = buildDir + '/composer-installer';
var installerUrl = 'https://getcomposer.org/installer';
var stat = Promise.promisify(fs.stat);
return stat(composerPath).catch(function (e) {
return download(installerUrl, installerPath).then(function () {
return runPhpCommand(installerPath, ['--2'], {cwd: buildDir});
});
}).then(function () {
return runPhpCommand(composerPath, ['self-update', '--2']);
}).then(function () {
if (!cliOptions['dev']) {
args.push('--no-dev');
}
return runPhpCommand(composerPath, args, options);
});
}
function ensureModuleUsesComposer(modulePath) {
var composerPath = path.join(modulePath, 'composer.json');
return fs.statAsync(composerPath).then(
function () { return modulePath; },
function () { throw new Error('No composer.json found in this module.'); }
);
}
function cssToSass(dir) {
return gulp.src(dir + '/asset/sass/**/*.scss')
.pipe(sass({
outputStyle: 'compressed',
includePaths: ['node_modules/susy/sass']
}).on('error', sass.logError))
.pipe(postcss([autoprefixer()]))
.pipe(gulp.dest(dir + '/asset/css'));
}
function i18nXgettext(dir, ignore) {
return glob('**/*.{php,phtml}', {ignore: ignore, cwd: dir}).then(function (files) {
return tmpFile({postfix: 'xgettext.pot'}).spread(function (path, fd) {
var args = ['--language=php', '--from-code=utf-8', '--keyword=translate', '-o', path];
return runCommand('xgettext', args.concat(files), {cwd: dir}, path);
});
});
}
function i18nTaggedStrings(dir) {
return tmpFile({postfix: 'tagged.pot'}).spread(function (path, fd) {
return runPhpCommand(composerDir + '/extract-tagged-strings.php', [],
{stdio: ['pipe', fd, process.stderr], cwd: dir}, path);
});
}
function i18nVocabStrings() {
return tmpFile({postfix: 'vocab.pot'}).spread(function (path, fd) {
return runPhpCommand(scriptsDir + '/extract-vocab-strings.php', [],
{stdio: ['pipe', fd, process.stderr]}, path);
});
}
function i18nStaticStrings(dir) {
var staticPath = path.join(dir, 'language', 'template.static.pot');
return fs.statAsync(staticPath).then(function () {
return staticPath;
}).catch(function (e) {
return null;
});
}
function getModulePath() {
var modulePath;
var moduleName = cliOptions['module-name'];
if (moduleName) {
modulePath = path.join(__dirname, 'modules', moduleName);
} else {
modulePath = getCurrentModulePath();
}
if (!modulePath) {
return Promise.reject(new Error('No module given! Run gulp from within the module, or use --module-name to specify the module to work on.'));
}
return fs.statAsync(modulePath).then(function (stats) {
if (!stats.isDirectory()) {
return Promise.reject(new Error('Invalid module given! (not a directory)'))
}
return modulePath;
});
}
function getCurrentModulePath() {
var relativePathSegs = path.relative(process.cwd(), process.env.INIT_CWD).split(path.sep);
if (relativePathSegs.length < 2 || relativePathSegs[0] !== 'modules') {
return false;
}
return path.resolve(relativePathSegs[0], relativePathSegs[1]);
}
function compileToMo(file) {
var outFile = path.join(path.dirname(file), path.basename(file, '.po') + '.mo');
return runCommand('msgfmt', [file, '-o', outFile]);
}
function phpCsFixer(fix, modulePath) {
let args = ['fix', '--verbose'];
if (!fix) {
args = args.concat(['--dry-run', '--diff']);
}
if (modulePath) {
const [moduleName] = modulePath.split(path.sep).slice(-1);
args = args.concat([
'--cache-file=build/cache/.php_cs.cache_' + moduleName,
'--config=.php_cs_module', modulePath
]);
} else {
args.push('--cache-file=build/cache/.php_cs.cache');
}
return ensureBuildDir().then(function () {
return runCommand('vendor/bin/php-cs-fixer', args);
});
}
function taskCss() {
return cssToSass('./application');
}
taskCss.description = 'Build css for the core';
gulp.task('css', taskCss);
function taskCssWatch() {
gulp.watch('./application/asset/sass/**/*.scss', gulp.parallel('css'));
}
taskCssWatch.description = 'Watch for core sass changes and auto-build css';
gulp.task('css:watch', taskCssWatch);
function taskCssModule() {
var modulePathPromise = getModulePath();
return modulePathPromise.then(function(modulePath) {
return cssToSass(modulePath);
});
}
taskCssModule.description = 'Build css for a module';
taskCssModule.flags = {'--module-name': 'Folder name of the module to build for (required)'};
gulp.task('css:module', taskCssModule);
function taskCssModuleWatch() {
var modulePathPromise = getModulePath();
modulePathPromise.then(function(modulePath) {
gulp.watch(modulePath + '/asset/sass/**/*.scss', gulp.parallel('css:module'));
});
}
taskCssModuleWatch.description = 'Watch for module sass changes and auto-build css';
taskCssModuleWatch.flags = {'--module-name': 'Folder name of the module to watch for (required)'};
gulp.task('css:module:watch', taskCssModuleWatch);
function taskTestCs() {
return phpCsFixer(false);
}
taskTestCs.description = 'Check code standards';
gulp.task('test:cs', taskTestCs);
function taskTestModuleCs() {
return ensureBuildDir()
.then(getModulePath)
.then(function (modulePath) {
return phpCsFixer(false, modulePath);
}
);
}
taskTestModuleCs.description = 'Check code standards for a module';
taskTestModuleCs.flags = {'--module-name': 'Folder name of the module to check'};
gulp.task('test:module:cs', taskTestModuleCs);
function taskTestPhp() {
return ensureBuildDir().then(function () {
return runCommand(composerDir + '/phpunit', [
'-d',
'date.timezone=America/New_York',
'--log-junit',
buildDir + '/test-results.xml'
], {cwd: 'application/test'});
});
}
taskTestPhp.description = 'Run PHPUnit automated tests';
gulp.task('test:php', taskTestPhp);
var taskTest = gulp.series('test:cs', 'test:php');
taskTest.description = 'Run all tests';
gulp.task('test', taskTest);
function taskFixCs() {
return phpCsFixer(true);
}
taskFixCs.description = 'Fix code standards';
gulp.task('fix:cs', taskFixCs);
function taskFixModuleCs() {
return ensureBuildDir()
.then(getModulePath)
.then(function (modulePath) {
return phpCsFixer(true, modulePath);
}
);
}
taskFixModuleCs.description = 'Fix code standards for a module';
taskFixModuleCs.flags = {'--module-name': 'Folder name of the module to fix'};
gulp.task('fix:module:cs', taskFixModuleCs);
function taskDeps() {
return composer(['install']);
}
taskDeps.description = 'Install Composer dependencies';
gulp.task('deps', taskDeps);
function taskDepsModule() {
return getModulePath()
.then(ensureModuleUsesComposer)
.then(function (modulePath) {
return composer(['install'], {cwd: modulePath})
}
);
}
taskDepsModule.description = 'Install Composer dependencies for a module';
taskDepsModule.flags = {'--module-name': 'Folder name of the module'};
gulp.task('deps:module', taskDepsModule);
function taskDepsUpdate() {
return composer(['update']);
}
taskDepsUpdate.description = 'Update locked Composer dependencies';
gulp.task('deps:update', taskDepsUpdate);
function taskDepsModuleUpdate() {
return getModulePath()
.then(ensureModuleUsesComposer)
.then(function (modulePath) {
return composer(['update'], {cwd: modulePath});
}
);
}
taskDepsModuleUpdate.description = 'Update locked Composer dependencies for a module';
taskDepsModuleUpdate.flags = {'--module-name': 'Folder name of the module'};
gulp.task('deps:module:update', taskDepsModuleUpdate);
function taskDepsJs(cb) {
var deps = {
'chosen-js': ['**', '!*.proto.*'],
'ckeditor4': ['**', '!samples/**'],
'compare-versions': 'lib/umd/index.js',
'jquery': 'dist/jquery.min.js',
'jstree': 'dist/jstree.min.js',
'lightgallery': ['lightgallery.min.js', '[c]ss/lightgallery-bundle.min.css', '[f]onts/**', '[i]mages/**',
'[p]lugins/@(hash|rotate|thumbnail|video|zoom)/*.min.js'],
'mirador': ['dist/**', '!dist/cjs/**', '!dist/es/**'],
'openseadragon': 'build/openseadragon/**',
'sortablejs': 'Sortable.min.js',
'tablesaw': 'dist/stackonly/**'
};
var depRenames = {
'ckeditor4': 'ckeditor'
};
Object.keys(deps).forEach(function (module) {
var moduleDeps = deps[module];
var dest = depRenames.hasOwnProperty(module) ? depRenames[module] : module;
if (!(moduleDeps instanceof Array)) {
moduleDeps = [moduleDeps];
}
moduleDeps = moduleDeps.map(function (value) {
if (value[0] === '!') {
return '!' + './node_modules/' + module + '/' + value.substr(1);
}
return './node_modules/' + module + '/' + value;
});
gulp.src(moduleDeps, {nodir: true})
.pipe(gulp.dest('./application/asset/vendor/' + dest));
});
cb();
}
taskDepsJs.description = 'Update in-browser javascript dependencies';
gulp.task('deps:js', taskDepsJs);
function taskDedist() {
return gulp.src(['./.htaccess.dist', './config/*.dist', './logs/*.dist', './application/test/config/*.dist'], {base: '.'})
.pipe(rename(function (path) {
path.extname = '';
}))
.pipe(gulp.dest('.', {overwrite: false}))
}
taskDedist.description = 'Copy .dist files to their real runtime paths';
gulp.task('dedist', taskDedist);
function taskDbSchema() {
return runPhpCommand(scriptsDir + '/create-schema.php');
}
taskDbSchema.description = 'Update database schema installer files';
gulp.task('db:schema', taskDbSchema);
function taskDbProxies() {
return runCommand(composerDir + '/doctrine', ['orm:generate-proxies']);
}
taskDbProxies.description = 'Update Doctrine proxies';
gulp.task('db:proxies', taskDbProxies);
function taskDbCreateMigration() {
return new Promise(function(resolve, reject) {
var now = new Date();
var timestamp = dateFormat(now, 'UTC:yyyymmddhhMMss');
var rl = readline.createInterface({input: process.stdin, output: process.stdout});
rl.question('Migration name (UpperCamelCased): ', function (migrationName) {
rl.close();
gulp.src(dataDir + '/build/migration.php.tpl')
.pipe(replace(/@ClassName@/g, migrationName))
.pipe(rename(timestamp + '_' + migrationName + '.php'))
.pipe(gulp.dest(dataDir + '/migrations/'))
.on('end', resolve);
});
});
}
taskDbCreateMigration.description = 'Create new blank DB migration';
gulp.task('db:create-migration', taskDbCreateMigration);
var taskDb = gulp.series('db:schema', 'db:proxies');
taskDb.description = 'Update database files following entity changes';
gulp.task('db', taskDb);
function taskI18nTemplate() {
return Promise.all([
i18nXgettext('.', ['themes/**', 'modules/**']),
i18nTaggedStrings('.'),
i18nVocabStrings()
]).then(function (tempFiles) {
return runCommand('msgcat', tempFiles.concat(['--use-first', '-o', pot]));
});
}
taskI18nTemplate.description = 'Update translation template';
gulp.task('i18n:template', taskI18nTemplate);
function taskI18nCompile() {
return glob('application/language/*.po').then(function (files) {
return Promise.all(files.map(compileToMo));
});
}
taskI18nCompile.description = 'Build translation files';
gulp.task('i18n:compile', taskI18nCompile);
function taskI18nDebug() {
var debugPo = path.join(langDir, 'debug.po');
return runCommand('podebug', ['-i', pot, '-o', debugPo, '--rewrite=unicode']).then(function () {
return compileToMo(debugPo);
});
}
taskI18nDebug.description = 'Create debugging dummy translation file (debug.po)';
gulp.task('i18n:debug', taskI18nDebug);
function taskI18nModuleTemplate() {
var modulePathPromise = getModulePath();
var preDedupePromise = modulePathPromise.then(function (modulePath) {
return Promise.all([
i18nXgettext(modulePath),
i18nTaggedStrings(modulePath),
i18nStaticStrings(modulePath)
]);
}).then(function (tempFiles) {
return tmpFile({postfix: 'module-prededupe.pot'}).spread(function (path, fd) {
tempFiles = tempFiles.filter(function (path) {
// Remove null paths.
return path;
});
return runCommand('msgcat', tempFiles.concat(['--use-first', '-o', path]), {}, path);
});
});
var dupesPromise = preDedupePromise.then(function (preDedupePot) {
return tmpFile({postfix: 'module-dupes.pot'}).spread(function (path, fd) {
return runCommand('msgcomm', ['-o', path, preDedupePot, pot], {}, path);
});
});
var languageDirPromise = modulePathPromise.then(function (modulePath) {
var languageDir = path.join(modulePath, 'language');
return fs.statAsync(languageDir).then(function (stats) {
if (!stats.isDirectory()) {
throw new Error('Language dir path exists, but is not a directory!');
}
}, function () {
return fs.mkdirAsync(languageDir);
}).then(function () {
return languageDir;
});
})
return Promise.join(languageDirPromise, preDedupePromise, dupesPromise, function (languageDir, preDedupePot, dupesPot) {
var modulePot = path.join(languageDir, 'template.pot');
return runCommand('msgcomm', ['--unique', '--to-code=utf-8', '-o', modulePot, preDedupePot, dupesPot]);
});
}
taskI18nModuleTemplate.description = 'Update translation template for a module';
taskI18nModuleTemplate.flags = {'--module-name': 'Name of module (required)'};
gulp.task('i18n:module:template', taskI18nModuleTemplate);
function taskI18nModuleCompile() {
return getModulePath().then(function (modulePath) {
return glob('language/*.po', {cwd: modulePath, absolute: true}).then(function (files) {
return Promise.all(files.map(compileToMo));
});
});
}
taskI18nModuleCompile.description = 'Build translation files for a module';
taskI18nModuleCompile.flags = {'--module-name': 'Name of module (required)'};
gulp.task('i18n:module:compile', taskI18nModuleCompile);
function taskCreateMediaTypeMap() {
return runPhpCommand(scriptsDir + '/create-media-type-map.php');
}
taskCreateMediaTypeMap.description = 'Update media type to file extension mappings';
gulp.task('create-media-type-map', taskCreateMediaTypeMap);
var taskInit = gulp.series('dedist', 'deps');
taskInit.description = 'Run first-time setup for a source checkout';
gulp.task('init', taskInit);
function taskClean() {
return rimraf(buildDir).then(function () {
rimraf(__dirname + '/vendor');
});
}
taskClean.description = 'Clean build files and installed dependencies';
gulp.task('clean', taskClean);
var taskZip = gulp.series('clean', 'init', function () {
return gulp.src(
[
'./**',
'!./**/*.dist',
'!./build/**',
'!./**/node_modules/**',
'!./package.json',
'!./package-lock.json',
'!./**/.tx/**',
'!./.php-cs-fixer.dist.php',
'!./.php_cs_module',
'!./.php_cs.cache',
'!./.github/**',
'!./gulpfile.js',
'!./**/.git/**',
'!./**/.gitattributes',
'!./**/.gitignore'
],
{base: '.', nodir: true, dot: true})
.pipe(rename(function (path) {
path.dirname = 'omeka-s/' + path.dirname;
}))
.pipe(zip('omeka-s.zip'))
.pipe(gulp.dest(buildDir))
});
taskZip.description = 'Create zip archive';
gulp.task('zip', taskZip);