forked from mozilla/butter
/
make.js
executable file
·500 lines (420 loc) · 15 KB
/
make.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
/*global cat,cd,cp,env,exec,echo,find,ls,mkdir,mv,pwd,rm,sed,target*/
var path = require( "path" ),
spawn = require('child_process').spawn,
normalize = function( p ){ return '"' + path.normalize( p ) + '"'; },
join = path.join,
// Make Windows happy, use `node <path>`
nodeExec = function( p ){ return 'node "' + p + '"'; },
pythonExec = function( p ){ return 'python "' + p + '"'; },
SLICE = Array.prototype.slice,
JSLINT = nodeExec( normalize( "./node_modules/jshint/bin/hint" ) ),
HTML5LINT = pythonExec( normalize( "./external/html5-lint/html5check.py" ) ),
CSSLINT = nodeExec( normalize( "./node_modules/csslint/cli.js" ) ),
UGLIFY = nodeExec( normalize( "./node_modules/uglify-js/bin/uglifyjs" ) ),
RJS = nodeExec( normalize( "./node_modules/requirejs/bin/r.js" ) ),
LESS = nodeExec( normalize( "./node_modules/less/bin/lessc" ) ),
SRC_DIR = 'src',
EDITORS_DIR = 'editors',
TEMPLATES_DIR = 'templates',
DIST_DIR = 'dist',
CSS_DIR = 'css',
CORNFIELD_DIR = 'cornfield',
PUBLIC_DIR = 'public',
DEFAULT_CONFIG = './src/default-config',
BUTTER_LESS_FILE = join( CSS_DIR, "butter.ui.less" ),
BUTTER_CSS_FILE_COMMENT = "/* THIS FILE WAS GENERATED BY A TOOL, DO NOT EDIT. SEE .less FILE IN css/ */",
BUTTER_CSS_FILE = join( CSS_DIR, "/butter.ui.css" ),
BUTTER_TRANSITIONS_LESS_FILE = join( CSS_DIR, "transitions.less" ),
BUTTER_TRANSITIONS_CSS_FILE = join( CSS_DIR, "/transitions.css" ),
BUTTERED_POPCORN = join( DIST_DIR, '/buttered-popcorn.js' ),
// We store version info about Popcorn and Butter when we deploy
VERSIONS_CONFIG = join( CORNFIELD_DIR, 'config', 'versions.json' );
require('shelljs/make');
// Get the git repo version info for a given repo root dir
function gitDescribe( repoRoot ) {
var cwd = pwd();
cd( repoRoot );
var version = exec( 'git describe',
{ silent: true } ).output.replace( /\r?\n/m, '' );
cd( cwd );
return version;
}
// Write a version.json file for cornfield to use when saving data
function publishVersionInfo( versionConfig ) {
var defaultConfig = require( DEFAULT_CONFIG ),
popcornDir = defaultConfig.dirs[ 'popcorn-js' ].replace( '{{baseDir}}', './' ),
butterDir = '.';
JSON.stringify({
date: Date.now(),
version: env.VERSION || 'development',
popcorn: gitDescribe( popcornDir ),
butter: gitDescribe( butterDir )
}, null, 2 ).to( versionConfig );
}
// To supress CSS warnings/errors for a particular line, end the line
// with a comment indicating you want CSS Lint to ignore this line's
// error(s). Here are some examples:
//
// -webkit-appearance: button; /* csslint-ignore */
// -webkit-appearance: button; /*csslint-ignore*/
// -webkit-appearance: button; /* csslint-ignore: This is being done because of iOS ... */
function checkCSSFile( filename, warnings, errors ) {
var fileLines = cat( filename ).split( /\r?\n/ ),
ignoreLines = "",
// Look for: "blah blah blah /* csslint-ignore */" or
// "blah blah /*csslint-ignore: this is my reason*/"
ignoreRegex = /\/\*\s*csslint-ignore[^*]*\*\/$/,
// Errors look like: "css/butter.ui.css: line 186, col 3, Error..."
lineRegex = /\: line (\d+),/;
// Build a map of lines to ignore: "|14||27|" means ignore lines 14 and 27
for( var i=0; i < fileLines.length; i++ ){
if( ignoreRegex.test( fileLines[ i ] ) ) {
ignoreLines += "|" + i + "|";
}
}
// Run CSSLint across the file, check for errors/warnings and ignore if
// they are ones we know about from above.
exec(CSSLINT +
' --warnings=' + warnings +
' --errors=' + errors +
' --quiet --format=compact' +
' ' + filename, { silent: true } ).output.split( /\r?\n/ )
.forEach( function( line ) {
if( !line ) {
return;
}
// Some warnings don't refer to a line, e.g.
// "css/butter.ui.css: Warning - Too many floats (10)..."
var matches = line.match( lineRegex ),
lineNumber = matches ? matches[ 1 ] : null;
if( !!lineNumber ) {
if( ignoreLines.indexOf( "|" + lineNumber + "|" ) === -1 ) {
echo( line );
}
} else {
echo( line );
}
});
}
function checkCSS( dir ) {
// see cli.js --list-rules.
var warnings = [
// "important",
// "adjoining-classes",
// "duplicate-background-images",
// "qualified-headings",
// "fallback-colors",
// "empty-rules",
// "shorthand",
// "overqualified-elements",
// "import",
// "regex-selectors",
// "rules-count",
// "font-sizes",
// "universal-selector",
// "unqualified-attributes",
"zero-units"
].join(",");
var errors = [
"known-properties",
"compatible-vendor-prefixes",
"display-property-grouping",
"duplicate-properties",
"errors",
"gradients",
"font-faces",
//"floats",
"vendor-prefix"
].join(",");
var files = ls( dir );
files.forEach( function( filename ) {
filename = join( dir, filename );
if( /\.css$/.test( filename ) ) {
checkCSSFile( filename, warnings, errors );
}
});
}
function checkJS(){
// Takes a string or an array of strings referring to directories.
var dirs = SLICE.call( arguments );
// Get all js and json files in dirs
var files = "";
[ /\.js$/, /\.json$/ ].forEach( function( regexp ){
files += find( dirs ).filter( function( file ) {
return file.match( regexp );
}).join(' ') + ' ';
});
// jshint with non-errors plus linting of json files
exec(JSLINT + ' ' + files + ' --show-non-errors --extra-ext json');
}
var desc = {
check: 'Lint CSS, HTML, and JS',
css: 'Build LESS files to CSS',
deploy: 'Build Butter suitable for production',
server: 'Run the development server'
};
target.all = function() {
echo('Please specify a target. Available targets:');
Object.keys(target).sort().filter(function(t) {
return t !== "all";
}).forEach(function(t) {
echo(' ' + t + ' - ' + desc[t]);
});
};
function clean() {
rm('-fr', DIST_DIR);
mkdir('-p', DIST_DIR);
}
function checkHTMLFile( filename, ignoreList ) {
var printedHeader = false,
printFooter = false;
var out = exec( HTML5LINT + " -h " + filename, { silent: true } ).output;
if ( out ) {
out = out.replace( "There were errors. (Tried in the text/html mode.)\n", "", "m" );
// Break the set of errors apart, and inspect each for
// matches in our ignoreList. If not something we should
// ignore, print each error.
out.split( "\n\n" ).forEach( function( error ) {
if ( !error.length ) {
return;
}
var i = ignoreList.length,
ignore;
while ( i-- ) {
ignore = ignoreList[ i ];
// If the error string matches the ignore string, make sure
// there isn't also a conditional when() function. If there is
// check that too.
if ( error.indexOf( ignore.text ) > -1 ) {
if ( ignore.when ) {
if ( ignore.when( filename ) ) {
return;
}
} else {
return;
}
}
}
if ( !printedHeader ) {
echo( "HTML5 Lint Issues for file: " + filename + "\n" );
printedHeader = true;
printFooter = true;
}
echo( error + "\n" );
});
if ( printFooter ) {
echo( "\n" );
}
}
}
function checkHTML() {
// Poor-man's HTML Doc vs. Fragment check
function isHTMLFragment( filename ) {
return !( /<html[^>]*\>/m ).test( cat( filename ) );
}
// List of errors/warnings to ignore, some with a conditional
// to only ignore when some condition is true.
var ignoreList = [
{
// Don't warn on valid docs
text: "The document is valid HTML5 + ARIA + SVG 1.1 + MathML 2.0 (subject to the utter previewness of this service)."
},
{
text: "Error: Start tag seen without seeing a doctype first. Expected “<!DOCTYPE html>”.",
when: isHTMLFragment
},
{
text: "Error: Element “head” is missing a required instance of child element “title”.",
when: isHTMLFragment
},
{
text: "Error: Bad value “X-UA-Compatible” for attribute “http-equiv” on element “meta”."
},
{
text: "Warning: The character encoding of the document was not declared."
},
{
// Let <style> be in fragments.
text: "Error: Element “style” not allowed as child of element “body” in this context. (Suppressing further errors from this subtree.)",
when: isHTMLFragment
}
];
find([
EDITORS_DIR,
PUBLIC_DIR,
join( SRC_DIR, "dialog", "dialogs" ),
join( SRC_DIR, "layouts" ),
join( SRC_DIR, "editor" ),
TEMPLATES_DIR ] ).filter( function( file ) {
return file.match( /\.html$/ );
}).forEach( function( filename ) {
checkHTMLFile( filename, ignoreList );
});
}
function lessToCSS( options ){
var compress = !!options.compress,
lessFile = options.lessFile,
cssFile = options.cssFile;
var args = compress ? " --yui-compress " : " ",
result = exec(LESS + args + lessFile, {silent:true});
if( result.code === 0 ){
var css = BUTTER_CSS_FILE_COMMENT + "\n\n" + result.output;
css.to( cssFile );
} else {
echo( result.output );
}
}
function buildCSS(compress) {
lessToCSS({
lessFile: BUTTER_LESS_FILE,
cssFile: BUTTER_CSS_FILE,
compress: compress
});
lessToCSS({
lessFile: BUTTER_TRANSITIONS_LESS_FILE,
cssFile: BUTTER_TRANSITIONS_CSS_FILE,
compress: compress
});
lessToCSS({
lessFile: "templates/assets/plugins/wikipedia/popcorn.wikipedia.less",
cssFile: "templates/assets/plugins/wikipedia/popcorn.wikipedia.css",
compress: compress
});
lessToCSS({
lessFile: "css/embed.less",
cssFile: "css/embed.css",
compress: compress
});
lessToCSS({
lessFile: "css/embed-shell.less",
cssFile: "css/embed-shell.css",
compress: compress
});
}
target.check = function() {
checkJS( 'make.js', SRC_DIR, EDITORS_DIR, CORNFIELD_DIR, TEMPLATES_DIR );
buildCSS();
checkCSS( CSS_DIR, TEMPLATES_DIR );
checkHTML();
};
function stampVersion( version, filename ){
// Stamp embed.version with supplied version, or git info
version = version || gitDescribe( "." );
sed( '-i', '@VERSION@', version, filename );
}
target.css = function() {
buildCSS();
};
function buildJS( version, compress ){
var doCompress = compress ? "" : "optimize=none";
var result = "";
result = exec(RJS + ' -o tools/build.js ' + doCompress, {silent: true});
if (!!result.code) {
echo(result.output);
}
stampVersion( version, 'dist/src/butter.js' );
result = exec(RJS + ' -o tools/embed.js ' + doCompress, {silent: true});
if (!!result.code) {
echo(result.output);
}
stampVersion( version, 'dist/src/embed.js' );
}
target.server = function() {
echo('### Serving butter');
// Write-out version info regarding Butter and Popcorn so cornfield knows what it's serving.
publishVersionInfo( VERSIONS_CONFIG );
cd( CORNFIELD_DIR );
// Use child_process.spawn here for a long-running server process
// (replaces `exec('node app.js', { async: true });`).
var server = spawn( 'node', [ 'app.js' ] );
// Mostly stolen from http://nodejs.org/docs/v0.3.5/api/child_processes.html#child_process.spawn
server.stdout.on( 'data', function( data ) {
process.stdout.write( data );
});
server.stderr.on( 'data', function( data ) {
process.stderr.write( "" + data );
});
server.on( 'exit', function( code ) {
console.log( 'server process exited with code ' + code );
});
};
function butteredPopcorn() {
var defaultConfig = require( DEFAULT_CONFIG ),
popcornDir = defaultConfig.dirs['popcorn-js'].replace( '{{baseDir}}', './' ),
popcornFiles = [];
// Popcorn License Header
popcornFiles.push( popcornDir + '/LICENSE_HEADER' );
// classList shim
popcornFiles.push( './tools/classlist-shim.js' );
// popcorn IE8 shim
popcornFiles.push( popcornDir + '/ie8/popcorn.ie8.js' );
// popcorn.js
popcornFiles.push( popcornDir + '/popcorn.js' );
// plugins
if ( defaultConfig.plugin && defaultConfig.plugin.plugins ) {
defaultConfig.plugin.plugins.forEach( function( plugin ){
popcornFiles.push( plugin.path.replace( '{{baseDir}}', './' ) );
});
}
// wrapper base prototype
popcornFiles.push( popcornDir + '/wrappers/common/popcorn._MediaElementProto.js' );
// wrappers
if ( defaultConfig.wrapper && defaultConfig.wrapper.wrappers ) {
defaultConfig.wrapper.wrappers.forEach( function( wrapper ){
popcornFiles.push( wrapper.path.replace( '{{baseDir}}', './' ) );
});
}
// module for baseplayer
popcornFiles.push( popcornDir + '/modules/player/popcorn.player.js' );
// players
if ( defaultConfig.player && defaultConfig.player.players ) {
defaultConfig.player.players.forEach( function( player ){
popcornFiles.push( player.path.replace( '{{baseDir}}', './' ) );
});
}
// Stamp Popcorn.version with the git commit sha we are using
var popcornVersion = gitDescribe( popcornDir );
// Write out dist/buttered-popcorn.js
cat( popcornFiles ).to( BUTTERED_POPCORN );
sed('-i', '@VERSION', popcornVersion, BUTTERED_POPCORN);
}
target.deploy = function(){
echo('### Making deployable versions of butter, embed, popcorn, etc. in dist/ (use UNMINIFIED=1 for unminified)');
// To get unminified butter.js, use the UNMINIFIED env variable:
// $ UNMINIFIED=1 node make deploy
var compress = env.UNMINIFIED !== "1",
version = env.VERSION;
clean();
buildJS( version, compress );
buildCSS( compress );
butteredPopcorn();
// We'll mirror src/butter.js and src/embed.js to mimic exploded install
mkdir('-p', './dist/src');
// Copy other assets over
mkdir( join( DIST_DIR, 'css' ) );
cp('css/*.css', join( DIST_DIR, 'css' ) );
cp('-R', 'editors', DIST_DIR);
cp('-R', 'resources', DIST_DIR);
cp('-R', 'templates', DIST_DIR);
cp('-R', 'cornfield', DIST_DIR);
cp('-R', 'node_modules', DIST_DIR);
// Copy the popcorn test videos over
mkdir('-p', './dist/external/popcorn-js/test');
cp('external/popcorn-js/test/trailer.*', './dist/external/popcorn-js/test');
// Copy the rest of the popcorn plugins over in case templates look for them
mkdir('-p', './dist/external/popcorn-js/plugins');
cp('-R', 'external/popcorn-js/plugins/*', './dist/external/popcorn-js/plugins');
// Export will need a version of popcorn.js where the templates expect it
// at dist/external/popcorn-js/popcorn.js
if ( compress ) {
exec( UGLIFY + ' --output ' + BUTTERED_POPCORN + ' ' + BUTTERED_POPCORN );
}
mv( BUTTERED_POPCORN, './dist/external/popcorn-js/popcorn.js' );
// Move everything into the public folder
cp( '-R', 'public', DIST_DIR );
mv([ 'dist/css', 'dist/editors', 'dist/external', 'dist/resources', 'dist/src', 'dist/templates' ], 'dist/public/' );
// Write-out version info regarding Butter and Popcorn so cornfield knows what it's serving.
publishVersionInfo( join( DIST_DIR, VERSIONS_CONFIG ) );
// It's important to use the production config
echo( 'Run cornfield with `NODE_ENV=production node app.js`' );
};