forked from HenrikJoreteg/moonboots
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
477 lines (435 loc) · 16.4 KB
/
index.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
var fs = require('fs');
var crypto = require('crypto');
var async = require('async');
var EventEmitter = require('events').EventEmitter;
var browserify = require('browserify');
var UglifyJS = require('uglify-js');
var cssmin = require('cssmin');
var path = require('path');
var mdeps = require('module-deps');
var meta = require('bundle-metadata');
function Moonboots(opts) {
var item;
//'opts' has to be an object
if (typeof opts !== 'object') {
throw new Error('Invalid options');
}
//'main' is the only required parameter, throw if it's missing
if (!opts.main) {
throw new Error("You must supply at minimum a `main` file for your moonboots app: {main: 'myApp.js'}");
}
//Defaults
this.config = {
libraries: [],
stylesheets: [],
jsFileName: 'app',
cssFileName: 'styles',
browserify: {}, // overridable browserify options
uglify: {}, // overridable uglify options
beforeBuildJS: function (cb) { cb(); },
beforeBuildCSS: function (cb) { cb(); },
sourceMaps: false, //turns on browserify debug
resourcePrefix: '/',
minify: true,
cache: true,
developmentMode: false,
timingMode: false
};
// Were we'll store generated source code, etc.
this.result = {
js: {ext: 'js', source: ''},
css: {ext: 'css'},
html: {}
};
for (item in opts) {
this.config[item] = opts[item];
}
// Uglify fromString must be true
this.config.uglify.fromString = true;
// Use sourceMaps option to set browserify.debug if its not set already
if (typeof this.config.browserify.debug === 'undefined') {
this.config.browserify.debug = this.config.sourceMaps;
}
// Ensure browserify transforms is set
if (typeof this.config.browserify.transforms === 'undefined') {
this.config.browserify.transforms = [];
}
//developmentMode forces minify to false and never build no matter what
if (this.config.developmentMode) {
this.config.minify = false;
this.config.buildDirectory = undefined;
this.config.cache = false;
}
//We'll re-add extensions later
if (path.extname(this.config.jsFileName) === '.js') {
this.config.jsFileName = this.config.jsFileName.slice(0, -3);
}
if (path.extname(this.config.cssFileName) === '.css') {
this.config.cssFileName = this.config.cssFileName.slice(0, -4);
}
// inherit from event emitter and then wait for nextTick to do anything so that our parent has a chance to listen for events
EventEmitter.call(this);
process.nextTick(this.build.bind(this));
}
// Inherit from event emitter
Moonboots.prototype = Object.create(EventEmitter.prototype, {
constructor: {
value: Moonboots
}
});
//Initial build, in development mode we just set hashes and filenames, otherwise we prime the sources
//Emits 'ready' when done
Moonboots.prototype.build = function () {
var self = this;
self.timing('timing', 'build start');
async.series([
function _buildFiles(buildFilesDone) {
var parts;
if (!self.config.buildDirectory) {
return buildFilesDone();
}
fs.readdir(self.config.buildDirectory, function (err, files) {
self.timing('reading buildDirectory start');
if (err) {
self.config.buildDirectory = undefined;
return buildFilesDone();
}
async.each(files, function (fileName, next) {
if (path.extname(fileName) === '.js' && fileName.indexOf(self.config.jsFileName) === 0) {
return fs.readFile(path.join(self.config.buildDirectory, fileName), 'utf8', function (err, data) {
if (err) {
self.config.buildDirectory = undefined;
return next(true);
}
parts = fileName.split('.');
self.result.js.hash = parts[1];
self.result.js.source = data;
self.result.js.filename = fileName;
self.result.js.fromBuild = true;
next();
});
}
if (path.extname(fileName) === '.css' && fileName.indexOf(self.config.cssFileName) === 0) {
return fs.readFile(path.join(self.config.buildDirectory, fileName), 'utf8', function (err, data) {
if (err) {
self.config.buildDirectory = undefined;
return next(true);
}
parts = fileName.split('.');
self.result.css.hash = parts[1];
self.result.css.source = data;
self.result.css.filename = fileName;
self.result.css.fromBuild = true;
next();
});
}
next();
}, function () {
self.timing('reading buildDirectory finish');
buildFilesDone();
});
});
},
function _buildBundles(buildBundlesDone) {
if (self.result.js.filename && self.result.css.filename) {
//buildFiles found existing files we don't have to build bundles
return buildBundlesDone();
}
async.parallel([
function _buildCSS(buildCSSDone) {
self.timing('build css start');
//If we're rebuilding on each request we just have to set the hash
if (!self.config.cache) {
self.result.css.hash = 'nonCached';
return buildCSSDone();
}
self.bundleCSS(true, buildCSSDone);
},
function _buildJS(buildJSDone) {
//If we're rebuilding on each request we just have to set the hash
if (!self.config.cache) {
self.result.js.hash = 'nonCached';
return buildJSDone();
}
self.bundleJS(true, buildJSDone);
}
], buildBundlesDone);
},
function _setResults(setResultsDone) {
var cssFileName = self.config.cssFileName + '.' + self.result.css.hash;
var jsFileName = self.config.jsFileName + '.' + self.result.js.hash;
if (self.config.minify) {
cssFileName += '.min';
jsFileName += '.min';
}
cssFileName += '.css';
jsFileName += '.js';
self.result.css.fileName = cssFileName;
self.result.js.fileName = jsFileName;
self.result.html.source = '<!DOCTYPE html>\n';
if (self.config.stylesheets.length > 0) {
self.result.html.source += linkTag(self.config.resourcePrefix + self.cssFileName());
}
self.result.html.source += scriptTag(self.config.resourcePrefix + self.jsFileName());
self.result.html.context = {
jsFileName: self.result.js.fileName,
cssFileName: self.result.css.fileName
};
setResultsDone();
},
function _createBuildFiles(createBuildFilesDone) {
if (!self.config.buildDirectory) {
return createBuildFilesDone();
}
async.parallel([
function (next) {
if (self.result.js.fromBuild) {
return next();
}
fs.writeFile(path.join(self.config.buildDirectory, self.result.css.fileName), self.result.css.source, next);
}, function (next) {
if (self.result.css.fromBuild) {
return next();
}
fs.writeFile(path.join(self.config.buildDirectory, self.result.js.fileName), self.result.js.source, next);
}
], createBuildFilesDone);
}
], function () {
self.timing('build finish');
self.emit('ready');
});
};
// Actually generate the CSS bundle
Moonboots.prototype.bundleCSS = function (setHash, done) {
var self = this;
async.series([
function _beforeBuildCSS(next) {
self.timing('beforeBuildCSS start');
if (self.config.beforeBuildCSS.length) {
self.config.beforeBuildCSS(function (err) {
self.timing('beforeBuildCSS finish');
next(err);
});
} else {
self.config.beforeBuildCSS();
self.timing('beforeBuildCSS finish');
next();
}
},
function _buildCSS(next) {
var csssha;
self.timing('buildCSS start');
self.result.css.source = concatFiles(self.config.stylesheets);
if (setHash) {
csssha = crypto.createHash('sha1'); // we'll calculate this to know whether to change the filename
csssha.update(self.result.css.source);
self.result.css.hash = csssha.digest('hex').slice(0, 8);
}
if (self.config.minify) {
self.result.css.source = cssmin(self.result.css.source);
}
self.timing('buildCSS finish');
next();
}
], function _bundleCSSDone(err) {
if (err) {
self.emit('log', ['moonboots', 'error'], err);
}
done(null, self.result.css.source);
});
};
// Actually generate the JS bundle
Moonboots.prototype.bundleJS = function (setHash, done) {
var self = this;
var jssha = crypto.createHash('sha1'); // we'll calculate this to know whether to change the filename
async.series([
function _beforeBuildJS(next) {
self.timing('beforeBuildJS start');
if (self.config.beforeBuildJS.length) {
self.config.beforeBuildJS(function (err) {
self.timing('beforeBuildJS finish');
next(err);
});
} else {
self.config.beforeBuildJS();
self.timing('beforeBuildJS finish');
next();
}
},
function _concatLibs(next) {
//Start w/ external libraries
self.timing('build libraries start');
self.result.js.source = concatFiles(self.config.libraries);
jssha.update(self.result.js.source);
self.timing('build libraries finish');
next();
},
function (next) {
self.browserify(setHash, next);
},
function (next) {
if (setHash) {
jssha.update(self.result.js.bundleHash);
self.result.js.hash = jssha.digest('hex').slice(0, 8);
}
if (self.config.minify) {
self.timing('minify start');
self.result.js.source = UglifyJS.minify(self.result.js.source, self.config.uglify).code;
self.timing('minify finish');
}
next();
}
], function _bundleJSDone(err) {
if (err) {
self.emit('log', ['moonboots', 'error'], err);
if (self.config.developmentMode) {
self.result.js.source = errorTrace(err);
} else {
throw err;
}
}
done(null, self.result.js.source);
});
};
Moonboots.prototype.browserify = function (setHash, done) {
var modules, args, bundle, hashBundle;
var self = this;
self.timing('browserify start');
// Create two bundles:
// bundle is to get the actual js source from a browserify bundle
// hashBundle is to create a copy of our other bundle (with the same requires and transforms)
// so we can use its resolve fn to get a predictable hash from module-deps
bundle = browserify(self.config.browserify);
if (setHash) {
hashBundle = browserify(self.config.browserify);
}
// handle module folder that you want to be able to require without relative paths.
if (self.config.modulesDir) {
modules = fs.readdirSync(self.config.modulesDir);
modules.forEach(function (moduleFileName) {
if (path.extname(moduleFileName) === '.js') {
args = [
path.join(self.config.modulesDir, moduleFileName),
{expose: path.basename(moduleFileName, '.js')}
];
bundle.require.apply(bundle, args);
if (setHash) {
hashBundle.require.apply(hashBundle, args);
}
}
});
}
// handle browserify transforms if passed
self.config.browserify.transforms.forEach(function (tr) {
bundle.transform(tr);
if (setHash) {
hashBundle.transform(tr);
}
});
// add main import
bundle.add(self.config.main);
async.series([
function (next) {
// run main bundle function
bundle.bundle(self.config.browserify, function (err, js) {
if (self.result.js.source.trim().slice(-1) !== ';') {
js = ';' + js;
}
self.result.js.source = self.result.js.source + js;
next(err);
});
},
function (next) {
if (!setHash) {
return next();
}
// Get a predictable hash for the bundle
var opts = {
resolve: hashBundle._resolve.bind(hashBundle),
transform: self.config.browserify.transforms
};
mdeps(self.config.main, opts)
.pipe(meta().on('hash', function (hash) {
self.result.js.bundleHash = hash;
next();
}));
},
], function (err) {
self.timing('browserify finish');
done(err);
});
};
/*
* Main moonboots functions.
* These should be the only methods you call.
*/
//Send jsSource to callback, rebuilding every time if in development mode
Moonboots.prototype.jsSource = function (cb) {
if (this.config.cache) {
return cb(null, this.result.js.source);
}
this.bundleJS(false, cb);
};
//Send cssSource to callback, rebuilding every time if in development mode
Moonboots.prototype.cssSource = function (cb) {
if (this.config.cache) {
return cb(null, this.result.css.source);
}
this.bundleCSS(false, cb);
};
//Return jsFileName, which never changes
Moonboots.prototype.jsFileName = function () {
return this.result.js.fileName;
};
//Return jsFileName, which never changes
Moonboots.prototype.cssFileName = function () {
return this.result.css.fileName;
};
//Return htmlContext, which never changes
Moonboots.prototype.htmlContext = function () {
return this.result.html.context;
};
//Return htmlSource, which never changes
Moonboots.prototype.htmlSource = function () {
return this.result.html.source;
};
Moonboots.prototype.timing = function (message) {
if (this.config.timingMode) {
this.emit('log', ['moonboots', 'timing', 'debug'], message, Date.now());
}
};
/*
* End main moonboots functions.
*/
// Main export
module.exports = Moonboots;
// a few helpers
function concatFiles(arrayOfFiles) {
return arrayOfFiles.map(function (fileName) {
var source = fs.readFileSync(fileName, 'utf8');
if (path.extname(fileName) !== '.js') {
return source;
}
if (source.trim().slice(-1) !== ';') {
source = source + ';';
}
return source;
}).join('\n');
}
function linkTag(filename) {
return '<link href="' + filename + '" rel="stylesheet" type="text/css">\n';
}
function scriptTag(filename) {
return '<script src="' + filename + '"></script>';
}
function errorTrace(err) {
var trace;
if (err.stack) {
trace = err.stack;
} else {
trace = JSON.stringify(err);
}
trace = trace.split('\n').join('<br>').replace(/"/g, '"');
return 'document.write("<pre style=\'background:#ECFOF2; color:#444; padding: 20px\'>' + trace + '</pre>");';
}