gnode

Run node with ES6 Generators, today!

gnode is a very light wrapper around your node executable that ensures ES6 Generator support, even on versions of node that do not support ES6 Generators natively.

You use it exactly like the regular node executable, except that you do not need to pass the --harmony-generators flag. That is where the magic happens.

With gnode you can use co or suspend, or any other Generator-based flow control based module, today!

How does this magic work?

node < 0.11.3

When V8 provides no native ES6 generators support, then gnode invokes a node instance with a patched require.extensions['.js'] function, which transparently transpiles your ES6 code with Generators into ES5-compatible code. We can thank facebook/regenerator for making this possible.

Under the hood, this command:

$ gnode foo.js all the args

Turns into something like this:

$ GNODE_ENTRY_POINT=foo.js node fallback.js all the args

node >= 0.11.3

When V8 supports ES6 generators natively, then gnode invokes a node instance with the --harmony-generators flag passed in transparently, so that the native generators are used, and no transpiling takes place. Everything else just works as you would expect it to.

Under the hood, this command:

$ gnode foo.js all the args

Turns into something like this:

$ node --harmony-generators foo.js all the args

Installation

Install the gnode executable via npm:

$ npm install -g gnode

CLI Examples

The gnode executable uses whatever version of node is installed in your PATH:

Here's our example t.js file:

var co = require('co');

function sleep (ms) {
  return function (fn) {
    setTimeout(fn, ms);
  };
}

co(function* () {
  for (var i = 0; i < 5; i++) {
    console.log(i);
    yield sleep(1000);
  }
})();

This script with an ES6 Generator in it can be run using any version of node by using gnode:

☮ ~ (master) ∴ n 0.8.26

☮ ~ (master) ∴ gnode -v
v0.8.26

☮ ~ (master) ∴ gnode t.js
0
1
2
3
4

☮ ~ (master) ∴ n 0.10.21

☮ ~ (master) ∴ gnode -v
v0.10.21

☮ ~ (master) ∴ gnode t.js
0
1
2
3
4

☮ ~ (master) ∴ n 0.11.8

☮ ~ (master) ∴ gnode -v
v0.11.8

☮ ~ (master) ∴ gnode t.js
0
1
2
3
4

Programmatic API

You can also just require('gnode') in a script without any generators, and then require() any other .js file that has generators after that.

require('gnode');
var gen = require('./someGenerator');
// etc…

0.1.2 / 2016-02-08

• travis: test lots more node versions
• README: use SVG for Travis-CI badge
• test: fix npm test failing to run (#21, @etiktin)
• test: fix typo in test case name

0.1.1 / 2015-01-14

• package: upgrade regenerator to v0.8.8 (#18, @popomore)
• travis: use "strings" for version numbers

0.1.0 / 2014-09-12

• package: update "regenerator" to v0.6.3 (@benjamn, #13)

0.0.8 / 2014-04-28

• bin: fix repl erroring on valid code (@timoxley, #10)
• bin: make gnode -p &/or gnode -e work properly (@timoxley, #2, #9)

0.0.7 / 2014-02-14

• package: allow any v0.x.x of "regenerator"

0.0.6 / 2014-01-06

• Never compile code that is already valid (#6, @ForbesLindesay)
• package: update "regenerator" to v0.3.4

0.0.5 / 2013-12-19

• Upgrade regenerator dependency to v0.3.2 (@benjamn)
• README++
• fallback: make process.argv only have 1 entry in the repl
• index: don't add the global require .js hook in some cases
• index: match the strip shebang logic from lib/module.js

0.0.4 / 2013-11-11

• gnode: fix entering the REPL with other flags are passed in as well
• gnode: print out the args for debugging purposes with GNODE_PRINT_ARGS
• gnode: proxy the exit code from the child node process
• test: initial CLI tests
• index: strip away the hashbang before feeding the script to esprima

0.0.3 / 2013-10-31

• gnode: avoid adding the --harmony_generators flag when not supported
• fallback: set process.execPath and process.argv[0] to the gnode binary
• fallback, index: include the regenerator runtime immediately

0.0.2 / 2013-10-30

• fallback: add proper REPL support
• fallback: add stdin piping support

0.0.1 / 2013-10-30

• gitignore: ignore ?.js files
• gnode: add support for flags on gnode
• gnode: move the --harmony_generators flag out into a variable
• gnode: fall back to process.argv[0] for the node process
• README++
• add .gitignore
• fallback: throw an error for REPL / stdin mode for now
• gnode: only set GNODE_ENTRY_POINT if a 3rd argument was passed in
• gnode: mark as executable
• gnode: add comment
• fallback: clean up the GNODE_ENTRY_POINT env variable
• gnode: drop the "flag" stuff for now
• initial commit