gruntfile.js

// Copyright 2014 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

module.exports = function(grunt) {
  // Load the grunt related dev deps listed in package.json.
  require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);
  var path = require('path');

  // Load our custom tasks.
  grunt.loadTasks('./build/tasks/');

  var browsers = grunt.option('browsers');
  if (browsers) {
    browsers = browsers.split(/\s*,\s*/g);
  } else {
    browsers = ['PhantomJS'];
  }

  var pkg = require('./package.json');

  grunt.initConfig({
    clean: {
      all: ['tmp', 'dist']
    },

    // Install closure compiler locally
    'closure-compiler-build': {
      build: {
        url: 'http://dl.google.com/closure-compiler/compiler-20150126.zip',
        dir: 'node_modules/grunt-closure-compiler-build/build/',
        filename: 'compiler.zip'
      }
    },

    'closure-compiler': {
      check: {
        cwd: 'lib/',
        js: ['**/*.js',
             '../third_party/closure-compiler/contrib/externs/jasmine.js',
             '../chrome_agent/js/*.js',
             '../externs/google_api/google_api.js',
             '../externs/google_api/chrome_api.js',
             '../tmp/third_party/dcodeIO/fs.js',
             '../tmp/third_party/dcodeIO/buffer.js',
             '../tmp/third_party/dcodeIO/stream.js',
             '../tmp/third_party/dcodeIO/events.js'
            ],
        jsOutputFile: 'tmp/closure/out.js',
        options: require('./build/closure-options.json'),
        closurePath: process.env.CLOSURE_PATH ?
            process.env.CLOSURE_PATH :
            '../node_modules/grunt-closure-compiler-build'
      }
    },

    git_deploy: {
      samples: {
        options: {
          url: 'git@github.com:chromium/axiom.git'
        },
        src: 'tmp/samples'
      }
    },

    make_version_module: {
      axiom: {
        version: pkg.version,
        dest: 'lib/axiom/version.js'
      },
      wash: {
        version: pkg.version,
        dest: 'lib/wash/version.js'
      }
    },

    make_dir_module: {
      wash: {
        strip: 2,
        dest: 'lib/wash/exe_modules.js',
        cwd: 'lib',
        modules: ['wash/exe/*.js', '!wash/exe/*.test.js']
      }
    },

    make_main_module: {
      test: {
        require: '__axiomRequire__',
        dest: 'tmp/test/test_main.js',
        cwd: 'lib/',
        modules: ['**/*.test.js']
      }
    },

    closure_externs: {
      build: {
        expand: true,
        src: ['**/*.js'],
        dest: 'tmp/third_party/dcodeIO/',
        cwd: 'third_party/dcodeIO/',
      }
    },

    make_package_json: {
      make: {
        options: {
          version: pkg.version
        },
        files: {
          'dist/axiom_base/package.json': 'lib/axiom/package_dist.json',
          'dist/axiom_wash/package.json': 'lib/wash/package_dist.json'
        }
      }
    },

    concat: {
      axiom_base: {
        src: ['loader/axiom_amd.js',
              'tmp/amd/lib/axiom/**/*.js',
              '!tmp/amd/lib/axiom/fs/node/*.js',
              '!tmp/amd/lib/axiom/**/*.test.js'],
        dest: 'dist/axiom_base/amd/lib/axiom_base.amd.concat.js'
      },
      wash: {
        src: ['tmp/amd/lib/wash/**/*.js',
              '!tmp/amd/lib/wash/**/*.test.js'],
        dest: 'dist/axiom_wash/amd/lib/wash.amd.concat.js'
      }
    },

    copy: {
      axiom_dist: {
        files: [
          {expand: true, cwd: 'tmp/cjs/', src: ['lib/axiom/**/*.js',
              'lib/axiom/**/*.js.map'], dest: 'dist/axiom_base/cjs'},
          {expand: true, cwd: 'tmp/amd/', src: ['lib/axiom/**/*.js'],
              dest: 'dist/axiom_base/amd'},
          {expand: true, cwd: '', src: ['lib/axiom/**/*.js',
              '!package_dist.json'], dest: 'dist/axiom_base/es6'}
        ]
      },
      wash_dist: {
        files: [
          {expand: true, cwd: 'tmp/cjs/', src: ['lib/wash/**/*.js',
              'lib/wash/**/*.js.map'], dest: 'dist/axiom_wash/cjs'},
          {expand: true, cwd: 'tmp/amd/', src: ['lib/wash/**/*.js'],
              dest: 'dist/axiom_wash/amd'},
          {expand: true, cwd: '', src: ['lib/wash/**/*.js',
              '!package_dist.json'], dest: 'dist/axiom_wash/es6'}
        ]
      },
      samples_web_shell_files: {
        files: [{
          expand: true,
          cwd: 'dist/axiom_base/amd/lib/',
          src: ['*.js', '*.map'],
          dest: 'tmp/samples/web_shell/js/'
        },
        {
          expand: true,
          cwd: 'dist/axiom_wash/amd/lib/',
          src: ['*.js'],
          dest: 'tmp/samples/web_shell/js/'
        },
        {
          expand: true,
          cwd: 'node_modules/hterm/dist/amd/lib/',
          src: ['hterm.amd.js'],
          dest: 'tmp/samples/web_shell/js/'
        },
        {
          expand: true,
          cwd: 'samples/web_shell/boot/',
          src: ['**/*.js',
                '**/*.js.map'
          ],
          dest: 'tmp/samples/web_shell/js/boot'
        },
        {
          expand: true,
          cwd: 'samples/web_shell/scripts/',
          src: ['**/*.js',
                '**/*.html'],
          dest: 'tmp/samples/web_shell/scripts'
        },
        {
          expand: true,
          cwd: 'samples/web_shell/css/',
          src: ['**/*.css'],
          dest: 'tmp/samples/web_shell/css'
        },
        {
          expand: true,
          cwd: 'samples/web_shell/assets/',
          src: ['**/*'],
          dest: 'tmp/samples/web_shell/assets'
        },
        {
          src: 'samples/web_shell/service_worker.js',
          dest: 'tmp/samples/web_shell/service_worker.js'
        },
        {
          src: 'third_party/idb.filesystem.js/idb.filesystem.js',
          dest: 'tmp/samples/web_shell/polyfill/idb.filesystem.js/idb.filesystem.js'
        }]
      },
      samples_use_globals_files: {
        files: [{
          expand: true,
          cwd: 'tmp/dist/',
          src: ['**/*.js'],
          dest: 'tmp/samples/use_globals/js/'
        },
        {
          expand: true,
          cwd: 'samples/use_globals/css/',
          src: ['**/*.css'],
          dest: 'tmp/samples/use_globals/css'
        },
        {
          expand: true,
          cwd: 'samples/use_globals/',
          src: ['**/*.html'],
          dest: 'tmp/samples/use_globals/'
        }]
      },
      samples_landing_files: {
        files: [{
          expand: true,
          cwd: 'samples/landing',
          src: ['**'],
          dest: 'tmp/samples'
        }]
      },
      chrome_agent: {
        files: [{
          expand: true,
          cwd: 'chrome_agent',
          src: ['**'],
          dest: 'tmp/chrome_agent'
        },
        {
          expand: true,
          cwd: 'dist/axiom_base/amd/lib/',
          src: ['*.js', '*.map'],
          dest: 'tmp/chrome_agent/js/lib/'
        },
        {
          expand: true,
          cwd: 'dist/axiom_wash/amd/lib/',
          src: ['*.js'],
          dest: 'tmp/chrome_agent/js/lib/'
        }]
      },
    },

    make_html_index: {
      samples_web_shell: {
        dest: 'tmp/samples/web_shell/index.html',
        title: 'Console',
        cwd: 'tmp/samples/web_shell/',
        scriptrefs: [
          'polyfill/idb.filesystem.js/*.js',
          'js/axiom_base.amd.concat.js',
          'js/wash.amd.concat.js',
          'js/*.js',
          'js/shell/**/*.js',
          'js/boot/startup.js' // last entry since we are synchronous (for now)
        ],
        cssrefs: [
          'css/**/*.css'
        ],
        links: [
          {
            rel: 'chrome-webstore-item',
            href: 'https://chrome.google.com/webstore/detail/lfbhahfblgmngkkgbgbccedhhnkkhknb'
          },
          {
            rel: 'shortcut icon',
            href: 'assets/favicon.png'
          }
        ]
      },

      test_harness: {
        dest: 'tmp/test_harness.html',
        title: 'test',
        cwd: 'tmp/',
        inlines: [
          'node_modules/jasmine-core/lib/jasmine-core/jasmine.css',
          'node_modules/jasmine-core/lib/jasmine-core/jasmine.js',
          'node_modules/jasmine-core/lib/jasmine-core/jasmine-html.js',
          'node_modules/jasmine-core/lib/jasmine-core/boot.js',
          'loader/axiom_amd.js'
        ],
        scriptrefs: [
          'amd/lib/axiom/**/*.js',
          'amd/lib/wash/**/*.js',
          'test/test_main.js'
        ],
        cssrefs: [
          'css/**/*.css'
        ]
      }
    },

    watch: {
      check: {
        options: {
          atBegin: true
        },
        files: ['lib/**/*.js'],
        tasks: ['check']
      },
      test_harness: {
        options: {
          atBegin: true
        },
        files: ['lib/**/*.js', 'test/**/*.js'],
        tasks: ['clean',
                'make_generated',
                'es6_transpile:amd',
                'make_main_module:test',
                'make_html_index:test_harness']
      },
      samples: {
        options: {
          atBegin: true,
          livereload: true
        },
        files: ['lib/**/*.js', 'samples/**/*.js'],
        tasks: ['check', 'samples']
      },
      check_test_harness: {
        options: {
          atBegin: true
        },
        files: ['lib/**/*.js', 'test/**/*.js'],
        tasks: ['check',
                'clean',
                'make_generated',
                'es6_transpile:amd',
                'make_main_module:test',
                'make_html_index:test_harness']
      },
      chrome_agent: {
        options: {
          atBegin: true,
          livereload: true
        },
        files: ['/gruntfile.js',
                'externs/**/*.js',
                'chrome_agent/**/*.html',
                'chrome_agent/**/*.json',
                'chrome_agent/**/*.png',
                'chrome_agent/js/extension/**/*.js',
                'lib/**/*.js'],
        tasks: ['chrome_agent']
      }
    },

    es6_transpile: {
      amd: {
        type: "amd",
        fileResolver: ['lib/'],
        files: [{
          expand: true,
          cwd: 'lib/',
          src: ['**/*.js'],
          dest: 'tmp/amd/lib/'
        }]
      },

      cjs: {
        type: "cjs",
        fileResolver: ['lib/'],
        files: [{
          expand: true,
          cwd: 'lib/',
          src: ['**/*.js'],
          dest: 'tmp/cjs/lib/'
        }]
      },
      samples_web_shell: {
        type: "amd",
        fileResolver: ['lib/',
                       'node_modules/hterm/dist/stub/',
                       'samples/web_shell/lib'],
        files: [{
          expand: true,
          cwd: 'samples/web_shell/lib/',
          src: ['**/*.js'],
          dest: 'tmp/samples/web_shell/js/'
        }]
      },
      chrome_agent: {
        type: "amd",
        fileResolver: ['lib/',
                       'chrome_agent/js'],
        files: [{
          expand: true,
          cwd: 'chrome_agent/js/',
          src: ['*.js'],
          dest: 'tmp/chrome_agent/js'
        }]
      }
    },

    shell: {
      publish_axiom: {
        command: function() {
          return 'npm publish ' + path.join('dist', 'axiom_base');
        }
      },
      publish_wash: {
        command: function() {
          return 'npm publish ' + path.join('dist', 'axiom_wash');
        }
      }
    },

    karma: {
      options: {
        browsers: browsers,
        frameworks: ['jasmine'],
        files: [
          'node_modules/es6-collections/index.js',
          'node_modules/es6-promise/dist/es6-promise.js',
          'polyfill/promise.js',
          'polyfill/bind.js',
          'loader/axiom_amd.js',
          'tmp/amd/lib/**/*.js',
          'tmp/test/test_main.js',
        ]
      },
      once: {
        singleRun: true
      },
      server: {
        singleRun: false
      }
    },

    run_wash: {
      main: {}
    }
  });

  // Install local copy of closure compiler.
  grunt.registerTask('closure_install', ['closure-compiler-build']);

  // Make the generated files.
  grunt.registerTask('make_generated', ['closure_externs',
                                        'make_dir_module',
                                        'make_version_module']);

  // Just transpile.
  grunt.registerTask('transpile', ['clean',
                                   'make_generated',
                                   'es6_transpile']);

  // Static check with closure compiler.
  grunt.registerTask('check', ['make_generated',
                               'closure_externs:build',
                               'closure-compiler:check']);
  grunt.registerTask('check-watch', ['watch:check']);

  grunt.registerTask('dist', ['transpile',
                              'concat:axiom_base',
                              'concat:wash',
                              'copy:axiom_dist',
                              'copy:wash_dist',
                              'make_package_json']);

  // Transpile and test.
  grunt.registerTask('test', ['transpile',
                              'make_main_module:test',
                              'karma:once']);
  grunt.registerTask('test-watch',
                     ['clean',
                      'watch:test_harness']);

  // Static check, transpile, test, repeat on changes.
  grunt.registerTask('check-test-watch',
                     ['clean',
                      'watch:check_test_harness']);

  // Build, then run wash from node.js
  grunt.registerTask('wash', ['clean',
                              'make_generated',
                              'es6_transpile:cjs',
                              'run_wash']);

  grunt.registerTask('default', ['check', 'test']);

  // Sample apps
  grunt.registerTask('samples_web_shell',
                     ['copy:samples_web_shell_files',
                      'make_html_index:samples_web_shell']);

  grunt.registerTask('samples', ['dist', 'copy:samples_landing_files',
                                 'samples_web_shell',
                                 'copy:samples_use_globals_files']);

  grunt.registerTask('publish_samples', ['samples', 'git_deploy:samples']);

  grunt.registerTask('publish_npm', ['dist',
                                     'shell:publish_axiom',
                                     'shell:publish_wash']);
  grunt.registerTask('chrome_agent', ['check', 'dist', 'samples',
                                     'copy:chrome_agent',
                                     'es6_transpile:chrome_agent']);
};