diff options
| author | Dave Geddes | 2012-10-21 00:37:59 -0600 |
|---|---|---|
| committer | Igor Minar | 2013-03-05 23:00:33 -0800 |
| commit | 79b51d5b578927bd510123c81953e7cc8c72f211 (patch) | |
| tree | 1499ce8bdb464671b711744974e883583d22b083 /lib/grunt/utils.js | |
| parent | fe8d893b839e9b14e3e55a3a0523cc1e6355bdd5 (diff) | |
| download | angular.js-79b51d5b578927bd510123c81953e7cc8c72f211.tar.bz2 | |
chore(Grunt): switch from Rake to Grunt
Migrates the Angular project from Rake to Grunt.
Benefits:
- Drops Ruby dependency
- Lowers barrier to entry for contributions from JavaScript ninjas
- Simplifies the Angular project setup and build process
- Adopts industry-standard tools specific to JavaScript projects
- Support building angular.js on Windows platform (really?!? why?!?)
BREAKING CHANGE: Rake is completely replaced by Grunt. Below are the deprecated Rake tasks and their Grunt equivalents:
rake --> grunt
rake package --> grunt package
rake init --> N/A
rake clean --> grunt clean
rake concat_scenario --> grunt build:scenario
rake concat --> grunt build
rake concat_scenario --> grunt build:scenario
rake minify --> grunt minify
rake version --> grunt write:version
rake docs --> grunt docs
rake webserver --> grunt webserver
rake test --> grunt test
rake test:unit --> grunt test:unit
rake test:<jqlite|jquery|modules|e2e> --> grunt test:<jqlite|jquery|modules|end2end|e2e>
rake test[Firefox+Safari] --> grunt test --browsers Firefox,Safari
rake test[Safari] --> grunt test --browsers Safari
rake autotest --> grunt autotest
NOTES:
* For convenience grunt test:e2e starts a webserver for you, while grunt test:end2end doesn't.
Use grunt test:end2end if you already have the webserver running.
* Removes duplicate entry for Describe.js in the angularScenario section of angularFiles.js
* Updates docs/src/gen-docs.js to use #done intead of the deprecated #end
* Uses grunt-contrib-connect instead of lib/nodeserver (removed)
* Removes nodeserver.sh, travis now uses grunt webserver
* Built and minified files are identical to Rake's output, with the exception of one less
character for git revisions (using --short) and a couple minor whitespace differences
Closes #199
Diffstat (limited to 'lib/grunt/utils.js')
| -rw-r--r-- | lib/grunt/utils.js | 175 |
1 files changed, 175 insertions, 0 deletions
diff --git a/lib/grunt/utils.js b/lib/grunt/utils.js new file mode 100644 index 00000000..80a41f30 --- /dev/null +++ b/lib/grunt/utils.js @@ -0,0 +1,175 @@ +var fs = require('fs'); +var shell = require('shelljs'); +var yaml = require('yaml-js'); +var grunt = require('grunt'); +var spawn = require('child_process').spawn; + +module.exports = { + + init: function() { + shell.exec('npm install'); + }, + + + getVersion: function(){ + var versionYaml = yaml.load(fs.readFileSync('version.yaml', 'UTF-8')); + var match = versionYaml.version.match(/^([^\-]*)(-snapshot)?$/); + var semver = match[1].split('.'); + var hash = shell.exec('git rev-parse --short HEAD', {silent: true}).output.replace('\n', ''); + + var version = { + full: (match[1] + (match[2] ? '-' + hash : '')), + major: semver[0], + minor: semver[1], + dot: semver[2], + codename: versionYaml.codename, + stable: versionYaml.stable + }; + + return version; + }, + + + startTestacular: function(config, singleRun, done){ + var browsers = grunt.option('browsers'); + var reporters = grunt.option('reporters'); + var noColor = grunt.option('no-colors'); + var p = spawn('node', ['node_modules/testacular/bin/testacular', 'start', config, + singleRun ? '--single-run=true' : '', + reporters ? '--reporters=' + reporters : '', + browsers ? '--browsers=' + browsers : '', + noColor ? '--no-colors' : '' + ]); + p.stdout.pipe(process.stdout); + p.stderr.pipe(process.stderr); + p.on('exit', function(code){ + if(code !== 0) grunt.fail.warn("Test(s) failed"); + done(); + }); + }, + + + wrap: function(src, name){ + src.unshift('src/' + name + '.prefix'); + src.push('src/' + name + '.suffix'); + return src; + }, + + + addStyle: function(src, styles, minify){ + styles = styles.map(processCSS.bind(this)).join('\n'); + src += styles; + return src; + + function processCSS(file){ + var css = fs.readFileSync(file).toString(); + if(minify){ + css = css + .replace(/\n/g, '') + .replace(/\/\*.*?\*\//g, '') + .replace(/:\s+/g, ':') + .replace(/\s*\{\s*/g, '{') + .replace(/\s*\}\s*/g, '}') + .replace(/\s*\,\s*/g, ',') + .replace(/\s*\;\s*/g, ';'); + } + //espace for js + css = css + .replace(/\\/g, '\\\\') + .replace(/'/g, "\\'") + .replace(/\n/g, '\\n'); + return "angular.element(document).find('head').append('<style type=\"text/css\">" + css + "</style>');"; + } + }, + + + process: function(src, NG_VERSION, strict){ + var processed = src + .replace(/"NG_VERSION_FULL"/g, NG_VERSION.full) + .replace(/"NG_VERSION_MAJOR"/, NG_VERSION.major) + .replace(/"NG_VERSION_MINOR"/, NG_VERSION.minor) + .replace(/"NG_VERSION_DOT"/, NG_VERSION.dot) + .replace(/"NG_VERSION_STABLE"/, NG_VERSION.stable) + .replace(/"NG_VERSION_CODENAME"/, NG_VERSION.codename); + if (strict !== false) processed = this.singleStrict(processed, '\n\n', true); + return processed; + }, + + + build: function(config, fn){ + var files = grunt.file.expand(config.src); + var styles = config.styles; + //concat + var src = files.map(function(filepath){ + return grunt.file.read(filepath); + }).join(grunt.util.normalizelf('\n')); + //process + var processed = this.process(src, grunt.config('NG_VERSION'), config.strict); + if (styles) processed = this.addStyle(processed, styles.css, styles.minify); + //write + grunt.file.write(config.dest, processed); + grunt.log.ok('File ' + config.dest + ' created.'); + fn(); + }, + + + singleStrict: function(src, insert, newline){ + var useStrict = newline ? "$1\n'use strict';" : "$1'use strict';"; + return src + .replace(/\s*("|')use strict("|');\s*/g, insert) // remove all file-specific strict mode flags + .replace(/(\(function\([^)]*\)\s*\{)/, useStrict); // add single strict mode flag + }, + + + min: function(file, done) { + var minFile = file.replace(/\.js$/, '.min.js'); + shell.exec( + 'java ' + + this.java32flags() + ' ' + + '-jar lib/closure-compiler/compiler.jar ' + + '--compilation_level SIMPLE_OPTIMIZATIONS ' + + '--language_in ECMASCRIPT5_STRICT ' + + '--js ' + file + ' ' + + '--js_output_file ' + minFile, + function(code) { + if (code !== 0) grunt.fail.warn('Error minifying ' + file); + grunt.file.write(minFile, this.singleStrict(grunt.file.read(minFile), '\n')); + grunt.log.ok(file + ' minified into ' + minFile); + done(); + }.bind(this)); + }, + + + //returns the 32-bit mode force flags for java compiler if supported, this makes the build much faster + java32flags: function(){ + if (process.platform === "win32") return ''; + if (shell.exec('java -version -d32 2>&1', {silent: true}).code !== 0) return ''; + return ' -d32 -client'; + }, + + + //csp connect middleware + csp: function(){ + return function(req, res, next){ + res.setHeader("X-WebKit-CSP", "default-src 'self';"); + res.setHeader("X-Content-Security-Policy", "default-src 'self'"); + next(); + }; + }, + + + //rewrite connect middleware + rewrite: function(){ + return function(req, res, next){ + var REWRITE = /\/(guide|api|cookbook|misc|tutorial).*$/, + IGNORED = /(\.(css|js|png|jpg)$|partials\/.*\.html$)/, + match; + + if (!IGNORED.test(req.url) && (match = req.url.match(REWRITE))) { + console.log('rewriting', req.url); + req.url = req.url.replace(match[0], '/index.html'); + } + next(); + }; + } +}; |
