https://github.com/facebook/regenerator

Source transformer enabling ECMAScript 6 generator functions in JavaScript-of-today.
https://github.com/facebook/regenerator

Last synced: 15 days ago
JSON representation

Source transformer enabling ECMAScript 6 generator functions in JavaScript-of-today.

• Host: GitHub
• URL: https://github.com/facebook/regenerator
• Owner: facebook
• License: mit
• Created: 2013-10-05T14:37:03.000Z (about 11 years ago)
• Default Branch: main
• Last Pushed: 2024-02-29T11:04:34.000Z (9 months ago)
• Last Synced: 2024-10-27T16:16:45.566Z (17 days ago)
• Language: JavaScript
• Homepage: http://facebook.github.io/regenerator/
• Size: 8.54 MB
• Stars: 3,830
• Watchers: 91
• Forks: 1,157
• Open Issues: 82
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• es6-tools - regenerator - transform ES6 yield/generator functions to ES5 (Transpilers)

README

        
regenerator [![Build Status](https://travis-ci.org/facebook/regenerator.svg?branch=master)](https://travis-ci.org/facebook/regenerator)

===

This package implements a fully-functional source transformation that

takes the syntax for generators/`yield` from [ECMAScript 2015 or ES2015](http://www.ecma-international.org/ecma-262/6.0/) and [Asynchronous Iteration](https://github.com/tc39/proposal-async-iteration) proposal and

spits out efficient JS-of-today (ES5) that behaves the same way.

A small runtime library (less than 1KB compressed) is required to provide the

`wrapGenerator` function. You can install it either as a CommonJS module

or as a standalone .js file, whichever you prefer.

Installation

---

From npm:

```sh

npm install -g regenerator

```

From GitHub:

```sh

cd path/to/node_modules

git clone git://github.com/facebook/regenerator.git

cd regenerator

npm install .

npm test

```

Usage

---

You have several options for using this module.

Simplest usage:

```sh

regenerator es6.js > es5.js # Just the transform.

regenerator --include-runtime es6.js > es5.js # Add the runtime too.

regenerator src lib # Transform every .js file in src and output to lib.

```

Programmatic usage:

```js

var es5Source = require("regenerator").compile(es6Source).code;

var es5SourceWithRuntime = require("regenerator").compile(es6Source, {

  includeRuntime: true

}).code;

```

AST transformation:

```js

var recast = require("recast");

var ast = recast.parse(es6Source);

ast = require("regenerator").transform(ast);

var es5Source = recast.print(ast);

```

How can you get involved?

---

The easiest way to get involved is to look for buggy examples using [the

sandbox](http://facebook.github.io/regenerator/), and when you find

something strange just click the "report a bug" link (the new issue form

will be populated automatically with the problematic code).

Alternatively, you can

[fork](https://github.com/facebook/regenerator/fork) the repository,

create some failing tests cases in [test/tests.es6.js](test/tests.es6.js),

and send pull requests for me to fix.

If you're feeling especially brave, you are more than welcome to dive into

the transformer code and fix the bug(s) yourself, but I must warn you that

the code could really benefit from [better implementation

comments](https://github.com/facebook/regenerator/issues/7).