GitXplorerGitXplorer
f

regenerator

public
3823 stars
1158 forks
84 issues

Commits

List of commits on branch main.
Verified
cb755fd82c648cbc5307a5a2d61cdd598e698fc4

Bump regenerator npm version to 0.14.12.

bbenjamn committed 9 months ago
Verified
8df695c1513f36bd76b2f40d01ca4b8535e9e7dc

Bump regenerator-runtime version in root package[-lock].json.

bbenjamn committed 9 months ago
Verified
6be1e6295ce1577142c44863175d5180d91f8f00

Bump regenerator-runtime version to 0.14.1.

bbenjamn committed 9 months ago
Verified
f4425fb231762a75493cf8fd6a644bcae5aa13ef

Bump @babel/parser from 7.23.0 to 7.23.6 (#712)

ddependabot[bot] committed 9 months ago
Verified
fc6b8442118b855f7ce9da344b3f8afdc0df4582

Fix outdated reference link in `runtime.js` (#704)

rrbals0445 committed 9 months ago
Verified
853925fdf75dcddd484676000c2e1bc025783f05

Bump @babel/traverse from 7.22.10 to 7.23.2 (#707)

ddependabot[bot] committed 9 months ago

README

The README file for this repository.

regenerator Build Status

This package implements a fully-functional source transformation that takes the syntax for generators/yield from ECMAScript 2015 or ES2015 and Asynchronous 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:

npm install -g regenerator

From GitHub:

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:

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:

var es5Source = require("regenerator").compile(es6Source).code;
var es5SourceWithRuntime = require("regenerator").compile(es6Source, {
  includeRuntime: true
}).code;

AST transformation:

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, 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 the repository, create some failing tests cases in 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.