-
Notifications
You must be signed in to change notification settings - Fork 1
/
gulpfile.js
453 lines (379 loc) · 18.4 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
const {_extend, promisify} = require('util')
const fs = require('fs')
const path = require('path')
const addsrc = require('gulp-add-src')
const argv = require('yargs').argv
const childExec = require('child_process').exec
const del = require('del')
const flatten = require('gulp-flatten')
const ghPages = require('gulp-gh-pages')
const gulp = require('gulp-help')(require('gulp'), {})
const gutil = require('gulp-util')
const Helpers = require('./gulp/helpers')
const livereload = require('gulp-livereload')
const ifElse = require('gulp-if-else')
const imagemin = require('gulp-imagemin')
const mkdirp = require('mkdirp')
const replace = require('gulp-replace')
const rc = require('rc')
const runSequence = require('run-sequence')
const size = require('gulp-size')
const zip = require('gulp-zip')
const writeFileAsync = promisify(fs.writeFile)
// The main settings object containing info
// from .vialer-jsrc and build flags.
let settings = {}
settings.BRAND_TARGET = argv.brand ? argv.brand : 'vialer'
settings.BUILD_DIR = process.env.BUILD_DIR || path.join(__dirname, 'build')
settings.BUILD_TARGET = argv.target ? argv.target : 'chrome'
settings.BUILD_TARGETS = ['chrome', 'electron', 'edge', 'firefox', 'webview']
// Exit when the build target is not in the allowed list.
if (!settings.BUILD_TARGETS.includes(settings.BUILD_TARGET)) {
gutil.log(`Invalid build target: ${settings.BUILD_TARGET}`)
process.exit(0)
}
settings.DEPLOY_TARGET = argv.deploy ? argv.deploy : 'beta'
// Exit when the deploy target is not in the allowed list.
if (!['production', 'beta'].includes(settings.DEPLOY_TARGET)) {
gutil.log(`Invalid deployment target: '${settings.DEPLOY_TARGET}'`)
process.exit(0)
}
settings.LIVERELOAD = false
settings.NODE_PATH = path.join(__dirname, 'node_modules') || process.env.NODE_PATH
settings.PACKAGE = require('./package')
settings.SRC_DIR = path.join(__dirname, 'src')
settings.SIZE_OPTIONS = {showFiles: true, showTotal: true}
settings.VERBOSE = argv.verbose ? true : false
// Force production mode when running certain tasks from
// the commandline or when using a deploy command.
if (argv._[0] && (['deploy', 'build-dist'].includes(argv._[0]) || argv._[0].includes('deploy'))) {
settings.PRODUCTION = true
// Force NODE_ENV to production for envify.
process.env.NODE_ENV = 'production'
} else {
// Production mode is on when NODE_ENV environmental var is set.
settings.PRODUCTION = argv.production ? argv.production : (process.env.NODE_ENV === 'production')
if (!process.env.NODE_ENV) process.env.NODE_ENV = 'development'
}
settings.NODE_ENV = process.env.NODE_ENV
// Loads the Vialer settings from ~/.vialer-jsrc into the
// existing settings object.
rc('vialer-js', settings)
// Simple brand validation checks.
if (!settings.brands[settings.BRAND_TARGET]) {
gutil.log(`(!) Brand ${settings.BRAND_TARGET} does not exist. Check vialer-jsrc.`)
process.exit(0)
}
for (let brand in settings.brands) {
try {
fs.statSync(`./src/brand/${brand}`)
} catch (err) {
gutil.log(`(!) Brand directory is missing for brand "${brand}"`)
process.exit(0)
}
}
// Initialize the helpers, which make this file less dense.
const helpers = new Helpers(settings)
const WATCHLINKED = argv.linked ? argv.linked : false
const WITHDOCS = argv.docs ? argv.docs : false
let taskOptions = {}
if (settings.VERBOSE) {
taskOptions = {
all: {
'brand=vialer': '',
'target=chrome': 'chrome|firefox|electron|webview',
},
brandOnly: {
'brand=vialer': '',
},
browser: {
'brand=vialer': '',
'target=chrome': 'chrome|firefox',
},
targetOnly: {
'target=chrome': 'chrome|firefox|electron|webview',
},
webview: {
'brand=vialer': '',
'target=chrome': 'electron|webview',
},
}
}
// Notify developer about some essential build flag values.
gutil.log('BUILD FLAGS:')
gutil.log(`- BRAND: ${settings.BRAND_TARGET}`)
gutil.log(`- DEPLOY: ${settings.DEPLOY_TARGET}`)
gutil.log(`- PRODUCTION: ${settings.PRODUCTION}`)
gutil.log(`- TARGET: ${settings.BUILD_TARGET}`)
gutil.log(`- VERBOSE: ${settings.VERBOSE}`)
gulp.task('assets', 'Copy (branded) assets to the build directory.', () => {
const robotoPath = path.join(settings.NODE_PATH, 'roboto-fontface', 'fonts', 'roboto')
return gulp.src(path.join(robotoPath, '{Roboto-Light.woff2,Roboto-Regular.woff2,Roboto-Medium.woff2}'))
.pipe(addsrc(path.join(settings.SRC_DIR, 'fonts', '*'), {base: settings.SRC_DIR}))
.pipe(flatten({newPath: './fonts'}))
.pipe(addsrc(`./src/brand/${settings.BRAND_TARGET}/img/{*.png,*.jpg}`, {base: `./src/brand/${settings.BRAND_TARGET}/`}))
.pipe(ifElse(settings.PRODUCTION, imagemin))
.pipe(addsrc('./LICENSE'))
.pipe(addsrc('./README.md'))
.pipe(addsrc('./src/_locales/**', {base: './src/'}))
.pipe(gulp.dest(`./build/${settings.BRAND_TARGET}/${settings.BUILD_TARGET}`))
.pipe(size(_extend({title: 'assets'}, settings.SIZE_OPTIONS)))
.pipe(ifElse(settings.LIVERELOAD, livereload))
}, {options: taskOptions.all})
gulp.task('build', 'Make a branded unoptimized development build.', (done) => {
// Refresh the brand content with each build.
let targetTasks
if (settings.BUILD_TARGET === 'electron') targetTasks = ['js-electron-main', 'js-webview', 'js-vendor']
else if (settings.BUILD_TARGET === 'webview') targetTasks = ['js-webview', 'js-vendor']
else targetTasks = ['js-vendor', 'js-webext']
runSequence(['assets', 'html', 'scss'].concat(targetTasks), done)
}, {options: taskOptions.all})
gulp.task('build-targets', 'Build all targets.', (done) => {
// Refresh the brand content with each build.
let electronTargetTasks = ['assets', 'html', 'scss', 'js-electron-main', 'js-webview', 'js-vendor']
let pluginTargetTasks = ['assets', 'html', 'scss', 'js-vendor', 'js-webext']
settings.BUILD_TARGET = 'chrome'
runSequence(pluginTargetTasks, () => {
settings.BUILD_TARGET = 'firefox'
runSequence(pluginTargetTasks, () => {
settings.BUILD_TARGET = 'edge'
runSequence(pluginTargetTasks, () => {
settings.BUILD_TARGET = 'electron'
runSequence(electronTargetTasks, () => {
done()
})
})
})
})
})
gulp.task('build-clean', 'Clear the build directory', async() => {
await del([path.join(settings.BUILD_DIR, settings.BRAND_TARGET, settings.BUILD_TARGET, '**')], {force: true})
mkdirp(path.join(settings.BUILD_DIR, settings.BRAND_TARGET, settings.BUILD_TARGET))
}, {options: taskOptions.all})
gulp.task('build-dist', 'Make an optimized build and generate a WebExtension zip file from it.', (done) => {
const buildDir = `./build/${settings.BRAND_TARGET}/${settings.BUILD_TARGET}`
runSequence('build', async function() {
// Use the web-ext build method here, so the result will match
// the deployable version as closely as possible.
if (settings.BUILD_TARGET === 'firefox') {
const source = `--source-dir ${buildDir}`
const artifacts = `--artifacts-dir ./dist/${settings.BRAND_TARGET}/${settings.BUILD_TARGET}/`
let execCommand = `web-ext build --overwrite-dest ${source} ${artifacts}`
let child = childExec(execCommand, undefined, (err, stdout, stderr) => {
if (stderr) gutil.log(stderr)
if (stdout) gutil.log(stdout)
done()
})
child.stdout.on('data', (data) => {
process.stdout.write(`${data.toString()}\r`)
})
} else {
gulp.src([`${buildDir}/**`], {base: buildDir})
.pipe(zip(`${helpers.distributionName(settings.BRAND_TARGET)}.zip`))
.pipe(gulp.dest(`./dist/${settings.BRAND_TARGET}/${settings.BUILD_TARGET}/`))
.on('end', done)
}
})
}, {options: taskOptions.all})
gulp.task('build-run', 'Make a development build and run it in the target environment.', () => {
let command = `gulp build --target ${settings.BUILD_TARGET} --brand ${settings.BRAND_TARGET}`
const buildDir = `./build/${settings.BRAND_TARGET}/${settings.BUILD_TARGET}`
if (settings.BUILD_TARGET === 'chrome') command = `${command};chromium --user-data-dir=/tmp/vialer-js --load-extension=${buildDir} --no-first-run`
else if (settings.BUILD_TARGET === 'firefox') command = `${command};web-ext run --no-reload --source-dir ${buildDir}`
else if (settings.BUILD_TARGET === 'electron') {
command = `${command};electron --js-flags='--harmony-async-await' ${buildDir}/main.js`
} else if (settings.BUILD_TARGET === 'webview') {
helpers.startDevServer()
const urlTarget = `http://localhost:8999/${settings.BRAND_TARGET}/webview/index.html`
command = `${command};chromium --user-data-dir=/tmp/vialer-js --disable-web-security --new-window ${urlTarget}`
}
childExec(command, undefined, (err, stdout, stderr) => {
if (err) gutil.log(err)
})
}, {options: taskOptions.all})
gulp.task('deploy', 'Deploy <BRAND_TARGET> to the <BUILD_TARGET> store.', async() => {
await helpers.deploy(settings.BRAND_TARGET, settings.BUILD_TARGET, helpers.distributionName(settings.BRAND_TARGET))
}, {options: taskOptions.browser})
gulp.task('deploy-brand', 'Deploy <BRAND_TARGET> to all supported target stores.', async() => {
const targets = ['chrome', 'firefox']
for (const target of targets) {
await helpers.deploy(settings.BRAND_TARGET, target, helpers.distributionName(settings.BRAND_TARGET))
}
}, {options: taskOptions.brandOnly})
gulp.task('deploy-brands', 'Deploy all brands to <BUILD_TARGET> store.', async() => {
// Can't do this async, since settings are modified during deploy to work
// around gulp tasks not accepting parameters.
for (const brand of Object.keys(settings.brands)) {
await helpers.deploy(brand, settings.BUILD_TARGET, helpers.distributionName(brand))
}
}, {options: taskOptions.targetOnly})
gulp.task('deploy-brands-targets', 'Deploy all brands to all supported target stores.', async() => {
const targets = ['chrome', 'firefox']
for (const target of targets) {
for (const brand of Object.keys(settings.brands)) {
await helpers.deploy(brand, target, helpers.distributionName(brand))
}
}
})
gulp.task('docs', 'Generate docs.', (done) => {
let execCommand = `node ${settings.NODE_PATH}/jsdoc/jsdoc.js ./src/js -R ./README.md -c ./.jsdoc.json -d ${settings.BUILD_DIR}/docs --package ./package.json`
childExec(execCommand, undefined, (err, stdout, stderr) => {
if (stderr) gutil.log(stderr)
if (stdout) gutil.log(stdout)
if (settings.LIVERELOAD) livereload.changed('rtd.js')
done()
})
})
gulp.task('docs-deploy', 'Publish docs on github pages.', ['docs'], () => {
return gulp.src(`${settings.BRAND_TARGET}/${settings.BUILD_DIR}/docs/**/*`).pipe(ghPages())
})
gulp.task('html', 'Preprocess and build application HTML.', () => {
let jsbottom, target
if (['electron', 'webview'].includes(settings.BUILD_TARGET)) {
target = 'electron'
jsbottom = '<script src="js/webview.js"></script>'
} else {
target = 'webext'
jsbottom = '<script src="js/webext_popup.js"></script>'
}
// The index.html file is shared with the electron build target.
// Appropriate scripts are inserted based on the build target.
return gulp.src(path.join('src', 'html', 'index.html'))
.pipe(replace('<!--JSBOTTOM-->', jsbottom))
.pipe(flatten())
.pipe(ifElse((target === 'webext'), () => addsrc(path.join('src', 'html', 'webext_{options,callstatus}.html'))))
.pipe(gulp.dest(`./build/${settings.BRAND_TARGET}/${settings.BUILD_TARGET}`))
.pipe(ifElse(settings.LIVERELOAD, livereload))
}, {options: taskOptions.all})
gulp.task('js-electron', 'Generate electron js.', (done) => {
runSequence([
'js-electron-main',
'js-webview',
'js-vendor',
], done)
})
gulp.task('js-electron-main', 'Generate electron main thread js.', ['js-webview'], () => {
return gulp.src('./src/js/main.js', {base: './src/js/'})
.pipe(gulp.dest(`./build/${settings.BRAND_TARGET}/${settings.BUILD_TARGET}`))
.pipe(size(_extend({title: 'electron-main'}, settings.SIZE_OPTIONS)))
.pipe(ifElse(settings.LIVERELOAD, livereload))
})
gulp.task('js-webview', 'Generate webview js.', (done) => {
helpers.jsEntry(settings.BRAND_TARGET, settings.BUILD_TARGET, 'webview/index', 'webview', done)
})
gulp.task('js-vendor', 'Generate third-party vendor js.', (done) => {
helpers.jsEntry(settings.BRAND_TARGET, settings.BUILD_TARGET, 'vendor', 'vendor', done)
}, {options: taskOptions.all})
gulp.task('js-webext', 'Generate WebExtension js.', [], (done) => {
runSequence([
'js-webext-bg',
'js-webext-callstatus',
'js-webext-observer',
'js-webext-options',
'js-webext-popup',
'js-webext-tab',
], 'manifest-webext', () => {
if (settings.LIVERELOAD) livereload.changed('web.js')
done()
})
}, {options: taskOptions.browser})
gulp.task('js-webext-bg', 'Generate the extension background entry js.', (done) => {
helpers.jsEntry(settings.BRAND_TARGET, settings.BUILD_TARGET, 'bg/index', 'webext_bg', done)
}, {options: taskOptions.browser})
gulp.task('js-webext-callstatus', 'Generate the callstatus entry js.', (done) => {
helpers.jsEntry(settings.BRAND_TARGET, settings.BUILD_TARGET, 'callstatus/index', 'webext_callstatus', done)
}, {options: taskOptions.browser})
gulp.task('js-webext-observer', 'Generate WebExtension observer js that runs in all tab frames.', (done) => {
helpers.jsEntry(settings.BRAND_TARGET, settings.BUILD_TARGET, 'observer/index', 'webext_observer', done)
}, {options: taskOptions.browser})
gulp.task('js-webext-options', 'Generate webextension options js.', (done) => {
helpers.jsEntry(settings.BRAND_TARGET, settings.BUILD_TARGET, 'options/index', 'webext_options', done)
}, {options: taskOptions.browser})
gulp.task('js-webext-popup', 'Generate webextension popup/popout js.', (done) => {
helpers.jsEntry(settings.BRAND_TARGET, settings.BUILD_TARGET, 'popup/index', 'webext_popup', done)
}, {options: taskOptions.browser})
gulp.task('js-webext-tab', 'Generate webextension tab js.', (done) => {
helpers.jsEntry(settings.BRAND_TARGET, settings.BUILD_TARGET, 'tab/index', 'webext_tab', done)
}, {options: taskOptions.browser})
gulp.task('manifest-webext', 'Generate a manifest for a browser WebExtension.', async() => {
let manifest = helpers.getManifest(settings.BRAND_TARGET, settings.BUILD_TARGET)
const manifestTarget = path.join(__dirname, 'build', settings.BRAND_TARGET, settings.BUILD_TARGET, 'manifest.json')
await writeFileAsync(manifestTarget, JSON.stringify(manifest, null, 4))
}, {options: taskOptions.browser})
gulp.task('scss', 'Compile all css.', [], (done) => {
runSequence([
'scss-webext',
'scss-webext-callstatus',
'scss-webext-options',
'scss-webext-print',
], () => {
// Targetting webext.css for livereload changed only works in the
// webview. In the callstatus html, it will trigger a page reload.
if (settings.LIVERELOAD) livereload.changed('webext.css')
done()
})
}, {options: taskOptions.all})
gulp.task('scss-webext', 'Generate popover webextension css.', () => {
return helpers.scssEntry(settings.BRAND_TARGET, settings.BUILD_TARGET, 'webext')
}, {options: taskOptions.all})
gulp.task('scss-webext-callstatus', 'Generate webextension callstatus dialog css.', () => {
return helpers.scssEntry(settings.BRAND_TARGET, settings.BUILD_TARGET, 'webext_callstatus')
}, {options: taskOptions.all})
gulp.task('scss-webext-options', 'Generate webextension options css.', () => {
return helpers.scssEntry(settings.BRAND_TARGET, settings.BUILD_TARGET, 'webext_options')
}, {options: taskOptions.all})
gulp.task('scss-webext-print', 'Generate webextension print css.', () => {
return helpers.scssEntry(settings.BRAND_TARGET, settings.BUILD_TARGET, 'webext_print')
}, {options: taskOptions.all})
gulp.task('watch', 'Start development server and watch for changes.', () => {
settings.LIVERELOAD = true
helpers.startDevServer()
// Watch files related to working on the documentation.
if (WITHDOCS) {
gutil.log('Watching documentation')
gulp.watch([
path.join(__dirname, '.jsdoc.json'),
path.join(__dirname, 'README.md'),
path.join(__dirname, 'docs', 'manuals', '**'),
], () => {
gulp.start('docs')
})
}
// Watch files related to working on the webextension.
gulp.watch([
path.join(__dirname, 'src', 'js', '**', '*.js'),
`!${path.join(__dirname, 'src', 'js', 'vendor.js')}`,
`!${path.join(__dirname, 'src', 'js', 'main.js')}`,
`!${path.join(__dirname, 'src', 'js', 'webview.js')}`,
], () => {
if (settings.BUILD_TARGET === 'electron') gulp.start('js-electron')
else gulp.start('js-webext')
if (WITHDOCS) gulp.start('docs')
})
gulp.watch(path.join(__dirname, 'src', 'js', 'vendor.js'), ['js-vendor'])
if (!['electron', 'webview'].includes(settings.BUILD_TARGET)) {
gulp.watch(path.join(__dirname, 'src', 'manifest.json'), ['manifest-webext'])
gulp.watch(path.join(__dirname, 'src', 'brand.json'), ['build'])
}
// Watch files related to working on linked packages.
if (WATCHLINKED) {
gutil.log('Watching linked development packages')
gulp.watch([
path.join(settings.NODE_PATH, 'jsdoc-rtd', 'static', 'styles', '*.css'),
path.join(settings.NODE_PATH, 'jsdoc-rtd', 'static', 'js', '*.js'),
path.join(settings.NODE_PATH, 'jsdoc-rtd', 'publish.js'),
path.join(settings.NODE_PATH, 'jsdoc-rtd', 'tmpl', '**', '*.tmpl'),
], ['docs'])
gulp.watch([
path.join(settings.NODE_PATH, 'webextension-polyfill', 'src', '*'),
], ['js-webext'])
}
// Watch files related to working on assets.
gulp.watch([
path.join(__dirname, 'src', '_locales', '**', '*.json'),
path.join(__dirname, 'src', 'js', 'lib', 'thirdparty', '**', '*.js'),
], ['assets'])
// Watch files related to working on the html and css.
gulp.watch(path.join(__dirname, 'src', 'html', '**', '*.html'), ['html'])
gulp.watch(path.join(__dirname, 'src', 'scss', '**', '*.scss'), ['scss'])
})