1 var lrSnippet = require('connect-livereload')();
\r
2 var mountFolder = function (connect, dir) {
\r
3 return connect.static(require('path').resolve(dir));
\r
6 module.exports = function ( grunt ) {
\r
9 * Load required Grunt tasks. These are installed based on the versions listed
\r
10 * in `package.json` when you do `npm install` in this directory.
\r
12 grunt.loadNpmTasks('grunt-contrib-clean');
\r
13 grunt.loadNpmTasks('grunt-contrib-copy');
\r
14 grunt.loadNpmTasks('grunt-contrib-jshint');
\r
15 grunt.loadNpmTasks('grunt-contrib-concat');
\r
16 grunt.loadNpmTasks('grunt-contrib-watch');
\r
17 grunt.loadNpmTasks('grunt-contrib-uglify');
\r
18 grunt.loadNpmTasks('grunt-conventional-changelog');
\r
19 grunt.loadNpmTasks('grunt-bump');
\r
20 //grunt.loadNpmTasks('grunt-recess');
\r
21 grunt.loadNpmTasks('grunt-shell');
\r
22 grunt.loadNpmTasks('grunt-karma');
\r
23 grunt.loadNpmTasks('grunt-ng-annotate');
\r
24 grunt.loadNpmTasks('grunt-html2js');
\r
25 grunt.loadNpmTasks('grunt-contrib-less');
\r
26 grunt.loadNpmTasks('grunt-contrib-connect');
\r
27 grunt.loadNpmTasks('grunt-open');
\r
28 grunt.loadNpmTasks('grunt-replace');
\r
31 * Load in our build configuration file.
\r
33 var userConfig = require( './build.config.js' );
\r
42 json: grunt.file.readJSON('./config/development.json')
\r
50 src: ['./config/env.module.js'],
\r
51 dest: 'src/common/config/'
\r
59 json: grunt.file.readJSON('./config/production.json')
\r
67 src: ['./config/env.module.js'],
\r
68 dest: 'src/common/config/'
\r
76 * This is the configuration object Grunt uses to give each plugin its
\r
81 * We read in our `package.json` file so we can access the package name and
\r
82 * version. It's already there, so we don't repeat ourselves here.
\r
84 pkg: grunt.file.readJSON("package.json"),
\r
87 * The banner is the comment that is placed at the top of our compiled
\r
88 * source files. It is first processed as a Grunt template, where the `<%=`
\r
89 * pairs are evaluated based on this very configuration object.
\r
94 ' * <%= pkg.name %> - v<%= pkg.version %> - <%= grunt.template.today("yyyy-mm-dd") %>\n' +
\r
95 ' * <%= pkg.homepage %>\n' +
\r
97 ' * Copyright (c) <%= grunt.template.today("yyyy") %> <%= pkg.author %>\n' +
\r
98 ' * Licensed <%= pkg.licenses.type %> <<%= pkg.licenses.url %>>\n' +
\r
103 * Creates a changelog on a new version.
\r
107 dest: 'CHANGELOG.md',
\r
108 template: 'changelog.tpl'
\r
113 * Increments the version number, etc.
\r
122 commitMessage: 'chore(release): v%VERSION%',
\r
125 "client/bower.json"
\r
128 tagName: 'v%VERSION%',
\r
129 tagMessage: 'Version %VERSION%',
\r
136 * The directories to delete when `grunt clean` is executed.
\r
139 '<%= build_dir %>',
\r
140 '<%= compile_dir %>'
\r
144 * The `copy` task just copies files from A to B. We use it here to copy
\r
145 * our project assets (images, fonts, etc.) and javascripts into
\r
146 * `build_dir`, and then to copy the assets to `compile_dir`.
\r
149 build_app_assets: {
\r
153 dest: '<%= build_dir %>/assets/',
\r
159 build_vendor_assets: {
\r
162 src: [ '<%= vendor_files.assets %>' ],
\r
163 dest: '<%= build_dir %>/assets/',
\r
173 src: [ '<%= app_files.js %>' ],
\r
174 dest: '<%= build_dir %>/',
\r
183 src: ['<%= app_files.templates %>'],
\r
184 dest: '<%= build_dir %>/',
\r
193 src: [ '<%= vendor_files.js %>' ],
\r
194 dest: '<%= build_dir %>/',
\r
200 build_vendorimages: {
\r
203 src: [ '<%= vendor_files.images %>' ],
\r
204 dest: '<%= build_dir %>/',
\r
213 src: [ '<%= vendor_files.css %>' ],
\r
214 dest: '<%= build_dir %>',
\r
224 dest: '<%= compile_dir %>/assets',
\r
225 cwd: '<%= build_dir %>/assets',
\r
235 dest: '<%= compile_dir %>/font',
\r
236 cwd: '<%= build_dir %>/font',
\r
244 * `grunt concat` concatenates multiple source files into a single file.
\r
248 * The `build_css` target concatenates compiled CSS and vendor CSS
\r
253 '<%= vendor_files.css %>',
\r
254 '<%= build_dir %>/assets/<%= pkg.name %>-<%= pkg.version %>.css'
\r
256 dest: '<%= build_dir %>/assets/<%= pkg.name %>-<%= pkg.version %>.css'
\r
259 * The `compile_js` target is the concatenation of our application source
\r
260 * code and all specified vendor source code into a single file.
\r
264 banner: '<%= meta.banner %>'
\r
267 '<%= vendor_files.js %>',
\r
269 '<%= build_dir %>/src/**/*.js',
\r
270 '<%= html2js.common.dest %>',
\r
271 '<%= html2js.app.dest %>',
\r
274 dest: '<%= compile_dir %>/assets/<%= pkg.name %>-<%= pkg.version %>.js'
\r
279 * `ng-min` annotates the sources before minifying. That is, it allows us
\r
280 * to code without the array syntax.
\r
289 src: [ '<%= app_files.js %>' ],
\r
290 cwd: '<%= build_dir %>',
\r
291 dest: '<%= build_dir %>',
\r
299 * Minify the sources!
\r
304 banner: '<%= meta.banner %>'
\r
307 '<%= concat.compile_js.dest %>': '<%= concat.compile_js.dest %>'
\r
313 * `less` less plugin handles the LESS compilation and minification automatically
\r
314 * this has been changed to the LESS plugin from recess plugin above because of
\r
315 * out of memory issues with the original plugin.
\r
321 paths: ["assets/css"],
\r
324 strictImports: true
\r
327 '<%= build_dir %>/assets/<%= pkg.name %>-<%= pkg.version %>.css': '<%= app_files.less %>'
\r
332 paths: ["assets/css"],
\r
337 '<%= build_dir %>/assets/<%= pkg.name %>-<%= pkg.version %>.css': '<%= app_files.less %>'
\r
343 * `jshint` defines the rules of our linter as well as which files we
\r
344 * should check. This file, all javascript sources, and all our unit tests
\r
345 * are linted based on the policies listed in `options`. But we can also
\r
346 * specify exclusionary patterns by prefixing them with an exclamation
\r
347 * point (!); this is useful when code comes from a third party but is
\r
348 * nonetheless inside `src/`.
\r
352 '<%= app_files.js %>'
\r
355 '<%= app_files.jsunit %>'
\r
358 'OriginalGruntfile.js'
\r
374 * HTML2JS is a Grunt plugin that takes all of your template files and
\r
375 * places them into JavaScript files as strings that are added to
\r
376 * AngularJS's template cache. This means that the templates too become
\r
377 * part of the initial payload as one JavaScript file. Neat!
\r
381 * These are the templates from `src/app`.
\r
387 src: [ '<%= app_files.atpl %>' ],
\r
388 dest: '<%= build_dir %>/templates-app.js'
\r
392 * These are the templates from `src/common`.
\r
398 src: [ '<%= app_files.ctpl %>' ],
\r
399 dest: '<%= build_dir %>/templates-common.js'
\r
404 * The Karma configurations.
\r
408 configFile: '<%= build_dir %>/karma-unit.js'
\r
413 port: 9877 // IMPORTANT!
\r
417 browsers: ['PhantomJS']
\r
422 * The `index` task compiles the `index.html` file as a Grunt template. CSS
\r
423 * and JS files co-exist here but they get split apart later.
\r
428 * During development, we don't want to have wait for compilation,
\r
429 * concatenation, minification, etc. So to avoid these steps, we simply
\r
430 * add all script files directly to the `<head>` of `index.html`. The
\r
431 * `src` property contains the list of included files.
\r
434 dir: '<%= build_dir %>',
\r
436 '<%= html2js.common.dest %>',
\r
437 '<%= html2js.app.dest %>',
\r
438 '<%= vendor_files.css %>',
\r
439 '<%= build_dir %>/assets/<%= pkg.name %>-<%= pkg.version %>.css'
\r
444 * When it is time to have a completely compiled application, we can
\r
445 * alter the above to include only a single JavaScript and a single CSS
\r
446 * file. Now we're back!
\r
449 dir: '<%= compile_dir %>',
\r
451 '<%= concat.compile_js.dest %>',
\r
452 '<%= concat.build_css.dest %>'
\r
453 //'<%= recess.compile.dest %>'
\r
459 * This task compiles the karma template so that changes to its file array
\r
460 * don't have to be managed manually.
\r
464 dir: '<%= build_dir %>',
\r
466 '<%= vendor_files.js %>',
\r
467 '<%= html2js.app.dest %>',
\r
468 '<%= html2js.common.dest %>',
\r
469 '<%= app_files.js_common %>',
\r
470 '<%= app_files.js_app %>',
\r
471 '<%= app_files.jsunit %>'
\r
479 hostname: '0.0.0.0',
\r
480 middleware: function (connect) {
\r
482 mountFolder(connect, 'build'),
\r
490 hostname: '0.0.0.0',
\r
505 path: 'http://127.0.0.1:9000/'
\r
508 path: 'http://127.0.0.1:9001/'
\r
512 * And for rapid development, we have a watch set up that checks to see if
\r
513 * any of the files listed below change, and then to execute the listed
\r
514 * tasks when they do. This just saves us from having to type "grunt" into
\r
515 * the command-line every time we want to see what we're working on; we can
\r
516 * instead just leave "grunt watch" running in a background terminal. Set it
\r
517 * and forget it, as Ron Popeil used to tell us.
\r
519 * But we don't need the same thing to happen for all the files.
\r
523 * By default, we want the Live Reload to work for all tasks; this is
\r
524 * overridden in some tasks (like this file) where browser resources are
\r
525 * unaffected. It runs by default on port 35729, which your browser
\r
526 * plugin should auto-detect.
\r
533 * When the Gruntfile changes, we just want to lint it. In fact, when
\r
534 * your Gruntfile changes, it will automatically be reloaded!
\r
537 files: 'OriginalGruntfile.js',
\r
538 tasks: [ 'jshint:gruntfile' ],
\r
545 * When our JavaScript source files change, we want to run lint them and
\r
546 * run our unit tests.
\r
550 '<%= app_files.js %>'
\r
552 tasks: [ 'jshint:src', 'karma:unit:run', 'copy:build_appjs' ]
\r
556 * When assets are changed, copy them. Note that this will *not* copy new
\r
557 * files, so this is probably not very useful.
\r
563 tasks: [ 'copy:build_app_assets' ]
\r
567 * When index.html changes, we need to compile it.
\r
570 files: [ '<%= app_files.html %>' ],
\r
571 tasks: [ 'index:build' ]
\r
575 * When our templates change, we only rewrite the template cache.
\r
579 '<%= app_files.atpl %>',
\r
580 '<%= app_files.ctpl %>'
\r
582 tasks: [ 'html2js' ]
\r
586 * When the CSS files change, we need to compile and minify them.
\r
589 files: [ 'src/**/*.less' ],
\r
590 tasks: [ 'less:development' ]
\r
594 * When a JavaScript unit test file changes, we only want to lint it and
\r
595 * run the unit tests. We don't want to do any live reloading.
\r
599 '<%= app_files.jsunit %>'
\r
601 tasks: [ 'jshint:test', 'karma:unit:run' ],
\r
609 command: "node node_modules/requirejs/bin/r.js -o optimize.js"
\r
614 grunt.initConfig( grunt.util._.extend( taskConfig, userConfig, envConfig ) );
\r
617 * In order to make it safe to just compile or copy *only* what was changed,
\r
618 * we need to ensure we are starting from a clean, fresh build. So we rename
\r
619 * the `watch` task to `delta` (that's why the configuration var above is
\r
620 * `delta`) and then add a new task called `watch` that does a clean build
\r
621 * before watching for changes.
\r
623 grunt.renameTask( 'watch', 'delta' );
\r
624 grunt.registerTask( 'watch', [ 'build', 'karma:unit', 'delta' ] );
\r
626 grunt.registerTask('live', ['build', 'connect:dev', 'delta']);
\r
628 * The default task is to build and compile.
\r
630 grunt.registerTask( 'default', [ 'compile' ] );
\r
633 * The `build` task gets your app ready to run for development and testing.
\r
635 grunt.registerTask( 'common', [
\r
636 'clean', 'html2js', 'jshint', 'less:development',
\r
637 'concat:build_css', 'copy:build_app_assets', 'copy:build_vendor_assets',
\r
638 'copy:build_appjs', 'copy:copy_template', 'copy:build_vendorimages', 'copy:build_vendorjs', 'copy:build_vendorcss', 'karmaconfig', 'index:build'
\r
641 grunt.registerTask( 'build', ['replace:development', 'common', 'karma:continuous']);
\r
644 * The `compile` task gets your app ready for deployment by concatenating and
\r
645 * minifying your code.
\r
647 grunt.registerTask( 'compile', ['replace:production', 'common', 'karma:continuous', 'ngAnnotate', 'shell:requirejs']);
\r
650 * A utility function to get all app JavaScript sources.
\r
652 function filterForJS ( files ) {
\r
653 return files.filter( function ( file ) {
\r
654 return file.match( /\.js$/ );
\r
659 * A utility function to get all app CSS sources.
\r
661 function filterForCSS ( files ) {
\r
662 return files.filter( function ( file ) {
\r
663 return file.match( /\.css$/ );
\r
668 * The index.html template includes the stylesheet and javascript sources
\r
669 * based on dynamic names calculated in this Gruntfile. This task assembles
\r
670 * the list into variables for the template to use and then runs the
\r
673 grunt.registerMultiTask( 'index', 'Process index.html template', function () {
\r
674 var dirRE = new RegExp( '^('+grunt.config('build_dir')+'|'+grunt.config('compile_dir')+')\/', 'g' );
\r
675 var jsFiles = filterForJS( this.filesSrc ).map( function ( file ) {
\r
676 return file.replace( dirRE, '' );
\r
678 var cssFiles = filterForCSS( this.filesSrc ).map( function ( file ) {
\r
679 return file.replace( dirRE, '' );
\r
682 grunt.file.copy('src/index.html', this.data.dir + '/index.html', {
\r
683 process: function ( contents, path ) {
\r
684 return grunt.template.process( contents, {
\r
688 version: grunt.config( 'pkg.version' )
\r
696 * In order to avoid having to specify manually the files needed for karma to
\r
697 * run, we use grunt to manage the list for us. The `karma/*` files are
\r
698 * compiled as grunt templates for use by Karma. Yay!
\r
700 grunt.registerMultiTask( 'karmaconfig', 'Process karma config templates', function () {
\r
701 var jsFiles = filterForJS( this.filesSrc );
\r
703 grunt.file.copy( 'karma/karma-unit.tpl.js', grunt.config( 'build_dir' ) + '/karma-unit.js', {
\r
704 process: function ( contents, path ) {
\r
705 return grunt.template.process( contents, {
\r