Implement compiler flags. Update README. Tidy up tests

Author: MatAtBread

README.md

@@ -1,19 +1,16 @@
 fast-async
 ==========
 
-'fast-async' is a _Babel v6.x.x_ plugin that implements the ES7 keywords `async` and `await` using syntax transformation 
+'fast-async' is a _Babel v6.x.x_ plugin that implements the ES7 keywords `async` and `await` using syntax transformation
 at compile-time rather than generators.
 
-The main reason for using 'fast-async' as opposed to Babel's default implementation of async/await is 
+The main reason for using 'fast-async' as opposed to Babel's default implementation of async/await is
 performance (https://github.com/MatAtBread/nodent#performance) - it's 3-4 times faster in a browser/node, and
 as much as 10 times faster on a mobile browsers, mainly due to avoiding generators (and therefore regenerator).
 
 There's a simple test (that just makes sure the plugin works and generates code that runs). More complete
 test coverage is included with nodent.
 
-fast-async (via nodent) can generate code suitable for use in early Browsers with no Promise support (as well as no generators),
-and has various options for turning sourcemaps on/off and controlling code generation, however for now it simply chooses some defaults.
-
 Because Babel parses the code, the ES7 extensions possible with nodent (`await` anywhere, `async return` and `async throw`) are not supported, however full implementation of `async function` containing `await` expressions is implemented.
 
 For _Babel v5.x.x_ install [email protected]
@@ -22,13 +19,31 @@ Install
 -------
 
 	npm install fast-async
-	
+
 Test
 ----
 From the installation directory (e.g. node_modules/fast-async):
 
 	npm test
 
+Options
+-------
+The plugin accepts the following options object, which itself is optional, as are all members. These are based on the options in nodent,
+but since much of the parsing is done by Babel some are unused.
+
+	env:{
+		log:function(string),        // Supplied routine to emit transformation warnings. Default: console.log
+		augmentObject:false,         // Add the nodent utilities asyncify() and isThenable() to Object.prototype
+		dontMapStackTraces:false,    // Don't install the stack trace hook that maps line numbers
+		asyncStackTrace:false,       // Provide async stack traces
+		dontInstallRequireHook:false // Don't transform all JS files as they are loaded into node
+	},
+	compiler:{
+		promises:true,    // Use nodent's "Promises" mode. Set to false if your execution environment does not support Promises.
+		generators:false  // Transform into 'Generators'.
+	}
+
+For more information on the compiler options, see [ES7 and Promises](https://github.com/matatbread/nodent#es7-and-promises) in the nodent documentation.
 
 Useful Links
 ------------
@@ -41,4 +56,3 @@ Online performance checkers:
 * [nodent](http://nodent.mailed.me.uk/#function%20pause%28%29%20{%0A%20%20%20%20return%20new%20Promise%28function%20%28%24return%2C%20%24error%29%20{%0A%20%20%20%20%20%20%20%20setTimeout%28function%20%28%29%20{%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20%24return%280%29%3B%0A%20%20%20%20%20%20%20%20}%2C%200%29%3B%0A%20%20%20%20}%29%3B%0A}%0A%0Aasync%20function%20doNothing%28%29%20{%0A%20%20%20%20return%3B%0A}%0A%0Aasync%20function%20test%28%29%20{%0A%20%20%20%20var%20t%20%3D%20Date.now%28%29%3B%0A%20%20%20%20for%20%28var%20j%20%3D%200%3B%20j%20%3C%2050%3B%20j%2B%2B%29%20{%0A%20%20%20%20%20%20%20%20for%20%28var%20i%20%3D%200%3B%20i%20%3C%201000%3B%20i%2B%2B%29%20{%0A%20%20%20%20%20%20%20%20%20%20%20%20await%20doNothing%28%29%3B%0A%20%20%20%20%20%20%20%20}%0A%20%20%20%20%20%20%20%20await%20pause%28%29%3B%0A%20%20%20%20}%0A%20%20%20%20return%20Date.now%28%29%20-%20t%3B%0A}%0A%0Atest%28%29.then%28alert%29%3B%0A) 632ms (and shave off another 100ms by selecting 'Pure ES5' mode)
 * [babel](https://babeljs.io/repl/#?experimental=true&evaluate=true&loose=false&spec=false&code=function%20pause%28%29%20{%0A%20%20%20%20return%20new%20Promise%28function%20%28%24return%2C%20%24error%29%20{%0A%20%20%20%20%20%20%20%20setTimeout%28function%20%28%29%20{%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20%24return%280%29%3B%0A%20%20%20%20%20%20%20%20}%2C%200%29%3B%0A%20%20%20%20}%29%3B%0A}%0A%0Aasync%20function%20doNothing%28%29%20{%0A%20%20%20%20return%3B%0A}%0A%0Aasync%20function%20test%28%29%20{%0A%20%20%20%20var%20t%20%3D%20Date.now%28%29%3B%0A%20%20%20%20for%20%28var%20j%20%3D%200%3B%20j%20%3C%2050%3B%20j%2B%2B%29%20{%0A%20%20%20%20%20%20%20%20for%20%28var%20i%20%3D%200%3B%20i%20%3C%201000%3B%20i%2B%2B%29%20{%0A%20%20%20%20%20%20%20%20%20%20%20%20await%20doNothing%28%29%3B%0A%20%20%20%20%20%20%20%20}%0A%20%20%20%20%20%20%20%20await%20pause%28%29%3B%0A%20%20%20%20}%0A%20%20%20%20return%20Date.now%28%29%20-%20t%3B%0A}%0A%0Atest%28%29.then%28alert%2Calert%29%3B%0A) 1877ms - 3x slower
 * [traceur](https://google.github.io/traceur-compiler/demo/repl.html#%2F%2F%20Options%3A%20--annotations%20--array-comprehension%20--async-functions%20--async-generators%20--exponentiation%20--export-from-extended%20--for-on%20--generator-comprehension%20--member-variables%20--proper-tail-calls%20--require%20--symbols%20--types%20%0Afunction%20pause%28%29%20{%0A%20%20%20%20return%20new%20Promise%28function%20%28%24return%2C%20%24error%29%20{%0A%20%20%20%20%20%20%20%20setTimeout%28function%20%28%29%20{%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20%24return%280%29%3B%0A%20%20%20%20%20%20%20%20}%2C%200%29%3B%0A%20%20%20%20}%29%3B%0A}%0A%0Aasync%20function%20doNothing%28%29%20{%0A%20%20%20%20return%3B%0A}%0A%0Aasync%20function%20test%28%29%20{%0A%20%20%20%20var%20t%20%3D%20Date.now%28%29%3B%0A%20%20%20%20for%20%28var%20j%20%3D%200%3B%20j%20%3C%2050%3B%20j%2B%2B%29%20{%0A%20%20%20%20%20%20%20%20for%20%28var%20i%20%3D%200%3B%20i%20%3C%201000%3B%20i%2B%2B%29%20{%0A%20%20%20%20%20%20%20%20%20%20%20%20await%20doNothing%28%29%3B%0A%20%20%20%20%20%20%20%20}%0A%20%20%20%20%20%20%20%20await%20pause%28%29%3B%0A%20%20%20%20}%0A%20%20%20%20return%20Date.now%28%29%20-%20t%3B%0A}%0A%0Atest%28%29.then%28alert%2Calert%29%3B%20%0A) 2488ms - 4x slower
-

package.json

@@ -1,9 +1,9 @@
 {
   "name": "fast-async",
-  "version": "6.0.0",
+  "version": "6.0.1",
   "dependencies": {
-    "acorn-es7-plugin": "^1.0.7",
-    "nodent": "^2.2.3"
+    "acorn-es7-plugin": "^1.0.8",
+    "nodent": "^2.2.4"
   },
   "description": "fast-async/await transformer Babel plugin",
   "main": "plugin.js",

plugin.js

@@ -23,12 +23,9 @@ try {
 
 
 module.exports = function (types) {
+	debugger ;
 	var logger = console.log.bind(console) ;
-	var nodent = require('nodent')({log:logger}) ;
-	var opts = nodent.parseCompilerOptions('"use nodent-promises";',nodent.log) ;
-	opts.babelTree = true ;
-	var binder = nodent.parse("Function.prototype.$asyncbind="+Function.prototype.$asyncbind.toString().replace(/[\s]+/g," "),null,opts);
-	var asyncbind = binder.ast.body[0];	
+	var nodent = require('nodent') ;
 
 	return {
 		// Lifted from https://github.com/babel/babel/blob/master/packages/babel-plugin-syntax-async-functions/src/index.js#L3,
@@ -38,10 +35,24 @@ module.exports = function (types) {
 		},
 		visitor: {
 			Program:function Program(path,state) {
+				var envOpts = state.opts.env || {} ;
+				if (!('log' in envOpts)) envOpts.log = logger ;
+				if (!('dontInstallRequireHook' in envOpts)) envOpts.dontInstallRequireHook = true ;
+				var compiler = nodent(envOpts) ;
+
+				var opts = compiler.parseCompilerOptions('"use nodent-promises";',compiler.log) ;
+				opts.babelTree = true ;
+
+				for (var k in opts) {
+					if (state.opts && state.opts.compiler && (k in state.opts.compiler))
+						opts[k] = state.opts.compiler[k] ;
+				}
 				var pr = { origCode:state.file.code, filename:"", ast:path.node } ;
-				nodent.asynchronize(pr,undefined,opts,nodent.log) ;
+
+				var binder = compiler.parse("Function.prototype.$asyncbind="+Function.prototype.$asyncbind.toString().replace(/[\s]+/g," "),null,opts);
+				var asyncbind = binder.ast.body[0];
+				compiler.asynchronize(pr,undefined,opts,compiler.log) ;
 				pr.ast.body.unshift(asyncbind) ;
-				nodent.prettyPrint(pr,{}) ;
 			}
 		}
 	};

tests/test-input.js

@@ -21,4 +21,4 @@ async function test() {
     return "Finished in "+(Date.now() - t)+"ms";
 }
 
-test().then(done,done) ;
+test().then(resolve,reject) ;

tests/test.js

@@ -1,16 +1,21 @@
-/* Test running for fast-async babel plugin 
- * 
+/* Test running for fast-async babel plugin
+ *
  * Open the file ./test-input.js and compile it using the fast-async plugin and run it.
- * 
+ *
  * It should output 'return: true'
  */
 
 require('colors');
 console.log("#### To run the tests you need to \"npm install babel-core\" and optionally (if you want to compare performance):");
-console.log("####    "+"npm install babel-preset-2015 babel-transform-async-to-module-method babel-transform-async-to-generator bluebird coroutine".yellow);
-console.log("#### These additional modules are only required for testing, not deployment.\n\nStarting tests...")
+console.log("####    "+"npm install babel-preset-es2015 babel-transform-async-to-module-method babel-transform-async-to-generator bluebird coroutine".yellow);
+console.log("#### These additional modules are only required for testing, not deployment.")
+
+console.log("#### "+"As of Nov-05 2015 the babel-transform-async* plugins appear to be broken".cyan)
+
+console.log("\nStarting tests...");
+
 try {
-	global.Promise = global.Promise || global.Promise = require('bluebird') ;
+	global.Promise = global.Promise || require('bluebird') ;
 } catch (ex) {
 	global.Promise = global.Promise || require('nodent').Thenable ;
 }
@@ -19,39 +24,52 @@ var testCode = require('fs').readFileSync(__dirname+'/test-input.js').toString()
 var babel = require("babel-core") ;
 
 var transformers = {
-	'fast-async':{plugins:[require('../plugin.js')]}
+	'fast-async':{plugins:[[require('../plugin.js'),{env:{dontMapStackTraces:true},compiler:{promises:false}}]]},
 };
 
 var requires ;
 try {
-	requires = ['babel-plugin-transform-async-to-generator','babel-preset-2015'] ;
+	requires = ['babel-plugin-transform-async-to-generator','babel-preset-es2015'] ;
 	requires.map(require) ;
 	transformers['transform-async-to-generator'] = {"presets": ["es2015"],plugins:['transform-async-to-generator']} ;
-} catch (ex) { 
+} catch (ex) {
 	/* not installed */
 	console.log("'"+("npm install "+requires.join(' ')).yellow+"' to compare against babel plugin 'transform-async-to-generator'") ;
 }
 
 try {
-	requires = ['babel-plugin-transform-async-to-module-method','babel-preset-2015','bluebird','coroutine'] ;
+	requires = ['babel-plugin-transform-async-to-module-method','babel-preset-es2015','bluebird','coroutine'] ;
 	requires.map(require) ;
 	transformers['transform-async-to-module-method'] = {"presets": ["es2015"],plugins:[["transform-async-to-module-method",{module: 'bluebird',method: 'coroutine'}]]}
-} catch (ex) { 
+} catch (ex) {
 	/* not installed */
 	console.log("'"+("npm install "+requires.join(' ')).yellow+"' to compare against babel plugin 'transform-async-to-module-method'") ;
 }
 
 var keys = Object.keys(transformers) ;
 (function nextTest(i){
-	if (i===0) {
-		global.regeneratorRuntime = require("babel-core/node_modules/babel-runtime/regenerator").default;
+	try {
+		if (i===1) {
+			console.log("Loading babel-runtime/regenerator") ;
+			global.regeneratorRuntime = require("babel-core/node_modules/babel-runtime/regenerator").default;
+		}
+		console.log("Transforming with "+keys[i]);
+		var t = babel.transform(testCode, transformers[keys[i]]);
+		var f = new Function("resolve,reject",t.code) ;
+		f(function(result){
+			console.log(keys[i],result.green) ;
+			next() ;
+		},function(error){
+			console.log(keys[i],(error.stack || error).red) ;
+			next() ;
+		}) ;
+		function next() {
+			i++ ;
+			if (i<keys.length)
+				nextTest(i) ;
+		}
+	} catch (ex) {
+		console.error(ex.stack.red) ;
+		next() ;
 	}
-	var t = babel.transform(testCode, transformers[keys[i]]);
-	var f = new Function("done",t.code) ;
-	f(function(result){
-		console.log(keys[i],result) ;
-		i++ ;
-		if (i<keys.length)
-			nextTest(i) ;
-	}) ;
 })(0) ;