@risd/grunt-es6-module-transpiler 0.7.0

package/.jshintrc

@@ -0,0 +1,14 @@
+{
+  "curly": true,
+  "eqeqeq": true,
+  "immed": true,
+  "latedef": true,
+  "newcap": true,
+  "noarg": true,
+  "sub": true,
+  "undef": true,
+  "boss": true,
+  "eqnull": true,
+  "node": true,
+  "es5": true
+}

package/.nvmrc

@@ -0,0 +1 @@
+v20.14.0

package/Gruntfile.js

@@ -0,0 +1,160 @@
+/*
+ * grunt-es6-module-transpiler
+ * https://github.com/joefiorini/grunt-es6-module-transpiler
+ *
+ * Copyright (c) 2013 Joe Fiorini
+ * Licensed under the MIT license.
+ */
+
+'use strict';
+
+module.exports = function(grunt) {
+
+  // Project configuration.
+  grunt.initConfig({
+    jshint: {
+      all: [
+        'Gruntfile.js',
+        'tasks/*.js',
+        '<%= nodeunit.tests %>',
+      ],
+      options: {
+        jshintrc: '.jshintrc',
+      },
+    },
+
+    // Before generating any new files, remove any previously-created files.
+    clean: {
+      tests: ['tmp'],
+    },
+
+    release: {
+      options: {
+        tagName: 'v<%= version %>',
+        commitMessage: 'Release v<%= version %> :tada:',
+        tagMessage: 'Release v<%= version %>'
+      }
+    },
+
+    // Configuration to be run (and then tested).
+    transpile: {
+      toCJS: {
+        type: "cjs",
+        files: {
+          'tmp/cjs.js': ['test/fixtures/input.js'],
+          'tmp/cjs-bar.js': ['test/fixtures/bar.js']
+        },
+      },
+      toAMD: {
+        type: "amd",
+        files: {
+          'tmp/amd.js': ['test/fixtures/input.js'],
+          'tmp/amd-bar.js': ['test/fixtures/bar.js']
+        }
+      },
+      toYUI: {
+        type: "yui",
+        files: {
+          'tmp/yui.js': ['test/fixtures/input.js'],
+          'tmp/yui-bar.js': ['test/fixtures/bar.js']
+        }
+      },
+      toGlobals: {
+        type: "globals",
+        imports: { bar: "Bar" },
+        files: {
+          'tmp/globals.js': ['test/fixtures/input.js'],
+          'tmp/globals-bar.js': ['test/fixtures/bar.js']
+        }
+      },
+      moduleName: {
+        type: 'amd',
+        moduleName: 'namedModule',
+        files: {
+          'tmp/name.js': ['test/fixtures/name.js'],
+        }
+      },
+      moduleNameCallback: {
+        type: 'amd',
+        moduleName: function(srcWithoutExt, file){
+          return 'my_app/' + srcWithoutExt.replace(/^test\/fixtures\//, '');
+        },
+        files: {
+          'tmp/name_callback.js': ['test/fixtures/name_callback.js'],
+        }
+      },
+      moduleNameCallbackWithCwd: {
+        type: 'amd',
+        moduleName: function(srcWithoutExt, file){
+          return 'my_app/' + srcWithoutExt;
+        },
+        files: [
+          {
+            expand: true,     // Enable dynamic expansion.
+            cwd: 'test/fixtures/lib/',      // Src matches are relative to this path.
+            src: ['**/*.js'], // Actual pattern(s) to match.
+            dest: 'tmp/'   // Destination path prefix.
+          }
+        ]
+      },
+      anonymous: {
+        type: 'amd',
+        anonymous: true,
+        files: {
+          'tmp/anonymous.js': ['test/fixtures/anonymous.js'],
+        }
+      },
+      coffeeSrc: {
+        type: 'amd',
+        files: {
+          'tmp/coffee.js': ['test/fixtures/coffee.coffee'],
+        }
+      },
+      mixedCoffeeAndJS: {
+        type: 'amd',
+        anonymous: true,
+        files: {
+          'tmp/anonymous.coffee': ['test/fixtures/anonymous.coffee'],
+          'tmp/anonymous.js': ['test/fixtures/anonymous.js'],
+        }
+      }
+      // importError: {
+      //   type: 'amd',
+      //   anonymous: true,
+      //   files: {
+      //     'tmp/import-error.js': ['test/fixtures/import-error.js']
+      //   }
+      // },
+      // exportError: {
+      //   type: 'amd',
+      //   anonymous: true,
+      //   files: {
+      //     'tmp/export-error.js': ['test/fixtures/export-error.js']
+      //   }
+      // }
+    },
+
+    // Unit tests.
+    nodeunit: {
+      tests: ['test/*_test.js'],
+    },
+
+  });
+
+  // Actually load this plugin's task(s).
+  grunt.loadTasks('tasks');
+
+  // These plugins provide necessary tasks.
+  grunt.loadNpmTasks('grunt-contrib-jshint');
+  grunt.loadNpmTasks('grunt-contrib-clean');
+  grunt.loadNpmTasks('grunt-contrib-nodeunit');
+  grunt.loadNpmTasks('grunt-release');
+
+  // Whenever the "test" task is run, first clean the "tmp" dir, then run this
+  // plugin's task(s), then test the result.
+  grunt.registerTask('test', ['clean', 'transpile', 'nodeunit']);
+
+  // By default, lint and run all tests.
+  grunt.registerTask('default', ['jshint', 'test']);
+
+};

package/LICENSE-MIT

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Joe Fiorini
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,80 @@
+# grunt-es6-module-transpiler
+
+> A Grunt task for processing ES6 module import/export syntax into one of AMD, CommonJS, YUI or globals using the es6-module-transpiler. Also allows you to temporarily enable ES6 modules for other tasks.
+
+## Getting Started
+This plugin requires Grunt `~0.4.1`
+
+If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
+
+```shell
+npm install grunt-es6-module-transpiler --save-dev
+```
+
+To use add the `transpile` task to your Grunt configuration.
+
+### Using with RequireJS/CommonJS:
+
+```js
+grunt.loadNpmTasks('grunt-es6-module-transpiler');
+
+grunt.initConfig({
+  transpile: {
+    main: {
+      type: "cjs", // or "amd" or "yui"
+      files: [{
+        expand: true,
+        cwd: 'lib/',
+        src: ['**/*.js'],
+        dest: 'tmp/'
+      }]
+    }
+  }
+});
+```
+
+### Using with Globals
+
+```js
+grunt.loadNpmTasks('grunt-es6-module-transpiler');
+
+grunt.initConfig({
+  transpile: {
+    main: {
+      type: "globals",
+      imports: { bar: "Bar" },
+      files: {
+        'tmp/globals.js': ['test/fixtures/input.js'],
+        'tmp/globals-bar.js': ['test/fixtures/bar.js']
+      }
+    }
+  }
+});
+```
+
+### Transpiling your files
+
+Manually run the task with `grunt transpile` or include it as part of your build task:
+
+```js
+grunt.registerTask('build', ['clean', 'transpile', '...']);
+```
+
+### Resources
+
+- [Using Grunt & the ES6 Module Transpiler](http://www.thomasboyt.com/2013/06/21/es6-module-transpiler) by Thomas Boyt
+
+### Caveat
+
+The module transpiler forces strict mode; there is no option to turn this off. If, like me, you typically use Mocha with [Chai](http://chaijs.com), this can cause a problem because Chai attempts to access `arguments.callee`, which violates strict mode. I switched to using [expect.js](https://github.com/LearnBoost/expect.js/) and it works great.
+
+## Contributing
+In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
+
+## Release History
+10/07/2013 v0.5.0 - Support for v0.3.0 of es6-module-transpiler; removes transpile:enable task as the feature no longer exists
+07/09/2013 v0.4.1 - Improved windows support when using amd
+07/09/2013 v0.4.0 - Update to v0.2.0 of es6-module-transpiler for new syntax support
+05/28/2013 v0.3.0 - Add callback for dynamically specifying AMD modulename
+05/02/2013 v0.2.0 - Fixes for globals, CoffeeScript, transpile:enable task for node scripts
+04/17/2013 v0.1.0 - Initial release, supports basic transpile task

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@risd/grunt-es6-module-transpiler",
+  "description": "A Grunt task for processing ES6 module import/export syntax into one of AMD, CommonJS or globals using the es6-module-transpiler",
+  "version": "0.7.0",
+  "homepage": "https://github.com/rubillionaire/grunt-es6-module-transpiler",
+  "author": {
+    "name": "Ruben Rodriguez",
+    "email": "mail@rubenrodriguez.me"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/rubillionaire/grunt-es6-module-transpiler.git"
+  },
+  "licenses": [
+    {
+      "type": "MIT",
+      "url": "https://github.com/rubillionaire/grunt-es6-module-transpiler/blob/master/LICENSE-MIT"
+    }
+  ],
+  "main": "Gruntfile.js",
+  "engines": {
+    "node": ">= 0.8.0"
+  },
+  "scripts": {
+    "test": "grunt test"
+  },
+  "devDependencies": {
+    "grunt-contrib-jshint": "~0.1.1",
+    "grunt-contrib-clean": "~0.4.0",
+    "grunt-contrib-nodeunit": "~5.0.0",
+    "grunt": "~0.4.1",
+    "grunt-release": "~0.6.0"
+  },
+  "peerDependencies": {
+    "grunt": ">=0.4.0"
+  },
+  "keywords": [
+    "gruntplugin"
+  ],
+  "dependencies": {
+    "es6-module-transpiler": "~0.3"
+  }
+}

package/tasks/es6_module_transpiler.js

@@ -0,0 +1,101 @@
+/*
+ * grunt-es6-module-transpiler
+ * https://github.com/joefiorini/grunt-es6-module-transpiler
+ *
+ * Copyright (c) 2013 Joe Fiorini
+ * Licensed under the MIT license.
+ */
+
+'use strict';
+
+module.exports = function(grunt) {
+
+  var path = require('path');
+
+  function transpile(file, options) {
+    var src = file.src,
+        Compiler = require("es6-module-transpiler").Compiler,
+        compiler, compiled, ext, method, moduleName;
+
+    ext = path.extname(src);
+
+    if (ext.slice(1) === 'coffee') {
+      options = grunt.util._.extend({coffee: true}, options);
+    }
+
+    if (options.anonymous) {
+      moduleName = '';
+    } else if (typeof options.moduleName === 'string') {
+      moduleName = options.moduleName;
+    } else {
+      moduleName = path.join(path.dirname(src), path.basename(src, ext)).replace(/[\\]/g, '/');
+      if (file.orig.cwd) {
+        moduleName = moduleName.slice(file.orig.cwd.length);
+      }
+      if (options.moduleName) {
+        moduleName = options.moduleName(moduleName, file);
+      }
+    }
+
+    compiler = new Compiler(grunt.file.read(src), moduleName, options);
+
+    switch(options.type){
+    case 'cjs':
+      method = "toCJS";
+      break;
+    case 'amd':
+      method = "toAMD";
+      break;
+    case 'yui':
+      method = "toYUI";
+      break;
+    case 'globals':
+      method = "toGlobals";
+      break;
+    default:
+      throw new Error("unknown transpile destination type: " + options.type);
+    }
+
+    compiled = compiler[method].apply(compiler);
+
+    grunt.file.write(file.dest, compiled);
+  }
+
+  function formatTranspilerError(filename, e) {
+    var pos = '[' + 'L' + e.lineNumber + ':' + ('C' + e.column) + ']';
+    return filename + ': ' + pos + ' ' + e.description;
+  }
+
+  grunt.registerMultiTask("transpile", function(){
+
+    var opts = {};
+
+    opts.imports = this.data.imports;
+    opts.type = this.data.type;
+    opts.moduleName = this.data.moduleName;
+    opts.anonymous = this.data.anonymous;
+    opts.compatFix = this.data.compatFix;
+
+    this.files.forEach(function(file){
+      file.src.filter(function(path){
+        if(!grunt.file.exists(path)){
+          grunt.log.warn('Source file "' + path + '" not found.');
+          return false;
+        } else {
+          return true;
+        }
+      }).forEach(function(path){
+        try {
+          transpile({src:path, dest:file.dest, orig:file.orig}, opts);
+        } catch (e) {
+          var message = formatTranspilerError(path, e);
+
+          grunt.log.error(message);
+          grunt.fail.warn('Error compiling ' + path);
+        }
+      });
+    });
+
+  });
+
+};

package/test/es6_module_transpiler_test.js

@@ -0,0 +1,115 @@
+'use strict';
+
+var grunt = require('grunt');
+
+/*
+  ======== A Handy Little Nodeunit Reference ========
+  https://github.com/caolan/nodeunit
+
+  Test methods:
+    test.expect(numAssertions)
+    test.done()
+  Test assertions:
+    test.ok(value, [message])
+    test.equal(actual, expected, [message])
+    test.notEqual(actual, expected, [message])
+    test.deepEqual(actual, expected, [message])
+    test.notDeepEqual(actual, expected, [message])
+    test.strictEqual(actual, expected, [message])
+    test.notStrictEqual(actual, expected, [message])
+    test.throws(block, [error], [message])
+    test.doesNotThrow(block, [error], [message])
+    test.ifError(value)
+*/
+
+function normalizedFileRead(path) {
+  return grunt.util.normalizelf(grunt.file.read(path));
+}
+
+exports.es6_module_transpiler = {
+  setUp: function(done) {
+    done();
+  },
+  toCJS: function(test) {
+    test.expect(1);
+
+    var actual = normalizedFileRead('tmp/cjs.js');
+    var expected = normalizedFileRead('test/expected/cjs.js');
+    test.equal(actual, expected, 'outputs CommonJS');
+
+    test.done();
+  },
+  toAMD: function(test) {
+    test.expect(1);
+
+    var actual = normalizedFileRead('tmp/amd.js');
+    var expected = normalizedFileRead('test/expected/amd.js');
+    test.equal(actual, expected, 'outputs AMD');
+
+    test.done();
+  },
+  toYUI: function(test) {
+    test.expect(1);
+
+    var actual = normalizedFileRead('tmp/yui.js');
+    var expected = normalizedFileRead('test/expected/yui.js');
+    test.equal(actual, expected, 'outputs YUI');
+
+    test.done();
+  },
+  toGlobals: function(test) {
+    test.expect(1);
+
+    var actual = normalizedFileRead('tmp/globals.js');
+    var expected = normalizedFileRead('test/expected/globals.js');
+    test.equal(actual, expected, 'outputs Globals');
+
+    test.done();
+  },
+  moduleNameOption: function(test) {
+    test.expect(1);
+
+    var actual = normalizedFileRead('tmp/name.js');
+    var expected = normalizedFileRead('test/expected/name.js');
+    test.equal(actual, expected, 'understands moduleName option');
+
+    test.done();
+  },
+  moduleNameCallbackOption: function(test) {
+    test.expect(1);
+
+    var actual = normalizedFileRead('tmp/name_callback.js');
+    var expected = normalizedFileRead('test/expected/name_callback.js');
+    test.equal(actual, expected, 'understands moduleName option with function');
+
+    test.done();
+  },
+  moduleNameCallbackOptionWithCwd: function(test) {
+    test.expect(1);
+
+    var actual = normalizedFileRead('tmp/name_callback_with_cwd.js');
+    var expected = normalizedFileRead('test/expected/name_callback_with_cwd.js');
+    test.equal(actual, expected, 'understands moduleName option with function with cwd');
+
+    test.done();
+  },
+  anonymousOption: function(test) {
+    test.expect(1);
+
+    var actual = normalizedFileRead('tmp/anonymous.js');
+    var expected = normalizedFileRead('test/expected/anonymous.js');
+    test.equal(actual, expected, 'understands anonymous option');
+
+    test.done();
+  },
+  mixedCoffeeAndJS: function(test) {
+    test.expect(1);
+
+    // in the config there is a .coffee file listed before this one
+    var actual = normalizedFileRead('tmp/anonymous.js');
+    var expected = normalizedFileRead('test/expected/anonymous.js');
+    test.equal(actual, expected, 'uses coffee option only on CoffeeScript files');
+
+    test.done();
+  }
+};

package/test/expected/amd.js

@@ -0,0 +1,6 @@
+define("test/fixtures/input", 
+  ["bar"],
+  function(__dependency1__) {
+    "use strict";
+    var foo = __dependency1__.foo;
+  });

package/test/expected/anonymous.coffee

@@ -0,0 +1,9 @@
+define(
+  ["exports"]
+  (__exports__) ->
+    "use strict"
+    foo = "bar"
+
+
+    __exports__.foo = foo
+  )

package/test/expected/anonymous.js

@@ -0,0 +1,8 @@
+define(
+  ["exports"],
+  function(__exports__) {
+    "use strict";
+    var foo = "bar";
+
+    __exports__.foo = foo;
+  });

package/test/expected/cjs.js

@@ -0,0 +1,2 @@
+"use strict";
+var foo = require("bar").foo;

package/test/expected/custom_options

@@ -0,0 +1 @@
+Testing: 1 2 3 !!!

package/test/expected/default_options

@@ -0,0 +1 @@
+Testing, 1 2 3.

package/test/expected/enable.js

@@ -0,0 +1,3 @@
+import foo from "./foo";
+
+export default foo;

package/test/expected/foo.js

@@ -0,0 +1 @@
+export default "bar";

package/test/expected/globals.js

@@ -0,0 +1,4 @@
+(function(__dependency1__) {
+  "use strict";
+  var foo = __dependency1__.foo;
+})(window.Bar);

package/test/expected/name.js

@@ -0,0 +1,8 @@
+define("namedModule", 
+  ["exports"],
+  function(__exports__) {
+    "use strict";
+    var foo = "bar";
+
+    __exports__.foo = foo;
+  });

package/test/expected/name_callback.js

@@ -0,0 +1,8 @@
+define("my_app/name_callback", 
+  ["exports"],
+  function(__exports__) {
+    "use strict";
+    var foo = "bar";
+
+    __exports__.foo = foo;
+  });

package/test/expected/name_callback_with_cwd.js

@@ -0,0 +1,8 @@
+define("my_app/name_callback_with_cwd", 
+  ["exports"],
+  function(__exports__) {
+    "use strict";
+    var foo = "bar";
+
+    __exports__.foo = foo;
+  });

package/test/expected/yui-bar.js

@@ -0,0 +1,7 @@
+YUI.add("test/fixtures/bar", function(Y, NAME, __imports__, __exports__) {
+    "use strict";
+    var foo = "bar";
+
+    __exports__.foo = foo;
+    return __exports__;
+}, "@VERSION@", {"es":true,"requires":[]});

package/test/expected/yui.js

@@ -0,0 +1,5 @@
+YUI.add("test/fixtures/input", function(Y, NAME, __imports__, __exports__) {
+    "use strict";
+    var foo = __imports__["bar"].foo;
+    return __exports__;
+}, "@VERSION@", {"es":true,"requires":["bar"]});

package/test/fixtures/123

@@ -0,0 +1 @@
+1 2 3

package/test/fixtures/anonymous.coffee

@@ -0,0 +1,3 @@
+foo = "bar"
+
+export { foo }

package/test/fixtures/anonymous.js

@@ -0,0 +1,3 @@
+var foo = "bar";
+
+export { foo };

package/test/fixtures/bar.js

@@ -0,0 +1,3 @@
+var foo = "bar";
+
+export { foo };

package/test/fixtures/export-error.js

@@ -0,0 +1 @@
+export doody doo;

package/test/fixtures/import-error.js

@@ -0,0 +1 @@
+import blah dee as doo;

package/test/fixtures/input.js

@@ -0,0 +1 @@
+import { foo } from "bar";

package/test/fixtures/lib/name_callback_with_cwd.js

@@ -0,0 +1,3 @@
+var foo = "bar";
+
+export { foo };

package/test/fixtures/name.js

@@ -0,0 +1,3 @@
+var foo = "bar";
+
+export { foo };

package/test/fixtures/name_callback.js

@@ -0,0 +1,3 @@
+var foo = "bar";
+
+export { foo };

package/test/fixtures/testing

@@ -0,0 +1 @@
+Testing