@babel/plugin-transform-runtime

A plugin that enables the re-use of Babel's injected helper code to save on codesize.

NOTE: Instance methods such as "foobar".includes("foo") will not work since that would require modification of existing built-ins (you can use @babel/polyfill for that).

Installation

Install it as development dependency.

  1. npm install --save-dev @babel/plugin-transform-runtime

and @babel/runtime as a production dependency (since it's for the "runtime").

  1. npm install --save @babel/runtime

The transformation plugin is typically used only in development, but the runtime itself will be depended on by your deployed code. See the examples below for more details.

Why?

Babel uses very small helpers for common functions such as _extend. By default this will be added to every file that requires it. This duplication is sometimes unnecessary, especially when your application is spread out over multiple files.

This is where the @babel/plugin-transform-runtime plugin comes in: all of the helpers will reference the module @babel/runtime to avoid duplication across your compiled output. The runtime will be compiled into your build.

Another purpose of this transformer is to create a sandboxed environment for your code. If you use @babel/polyfill and the built-ins it provides such as Promise, Set and Map, those will pollute the global scope. While this might be ok for an app or a command line tool, it becomes a problem if your code is a library which you intend to publish for others to use or if you can't exactly control the environment in which your code will run.

The transformer will alias these built-ins to core-js so you can use them seamlessly without having to require the polyfill.

See the technical details section for more information on how this works and the types of transformations that occur.

Usage

Via .babelrc (Recommended)

Add the following line to your .babelrc file:

Without options:

  1. {
  2.   "plugins": ["@babel/plugin-transform-runtime"]
  3. }

With options (and their defaults):

  1. {
  2.   "plugins": [
  3.     [
  4.       "@babel/plugin-transform-runtime",
  5.       {
  6.         "absoluteRuntime": false,
  7.         "corejs": false,
  8.         "helpers": true,
  9.         "regenerator": true,
  10.         "useESModules": false
  11.       }
  12.     ]
  13.   ]
  14. }

The plugin defaults to assuming that all polyfillable APIs will be provided by the user. Otherwise the corejs option needs to be specified.

Via CLI

  1. babel --plugins @babel/plugin-transform-runtime script.js

Via Node API

  1. require("@babel/core").transform("code", {
  2.   plugins: ["@babel/plugin-transform-runtime"],
  3. });

Options

corejs

boolean or number , defaults to false.

e.g. ['@babel/plugin-transform-runtime', { corejs: 2 }],

Specifying a number will rewrite the helpers that need polyfillable APIs to reference core-js instead.

This requires changing the dependency used to be @babel/runtime-corejs2 instead of @babel/runtime.

  1. npm install --save @babel/runtime-corejs2

helpers

boolean, defaults to true.

Toggles whether or not inlined Babel helpers (classCallCheck, extends, etc.) are replaced with calls to moduleName.

For more information, see Helper aliasing.

polyfill

This option was removed in v7 by just making it the default.

regenerator

boolean, defaults to true.

Toggles whether or not generator functions are transformed to use a regenerator runtime that does not pollute the global scope.

For more information, see Regenerator aliasing.

useBuiltIns

This option was removed in v7 by just making it the default.

useESModules

boolean, defaults to false.

When enabled, the transform will use helpers that do not get run through@babel/plugin-transform-modules-commonjs. This allows for smaller builds in modulesystems like webpack, since it doesn't need to preserve commonjs semantics.

For example, here is the classCallCheck helper with useESModules disabled:

  1. exports.__esModule = true;
  3. exports.default = function(instance, Constructor) {
  4.   if (!(instance instanceof Constructor)) {
  5.     throw new TypeError("Cannot call a class as a function");
  6.   }
  7. };

And, with it enabled:

  1. export default function(instance, Constructor) {
  2.   if (!(instance instanceof Constructor)) {
  3.     throw new TypeError("Cannot call a class as a function");
  4.   }
  5. }

absoluteRuntime

boolean or string, defaults to false.

This allows users to run transform-runtime broadly across a whole project. By default, transform-runtime imports from @babel/runtime/foo directly, but that only works if @babel/runtime is in the node_modules of the file that is being compiled. This can be problematic for nested node_modules, npm-linked modules, or CLIs that reside outside the user's project, among other cases. To avoid worrying about how the runtime module's location is resolved, this allows users to resolve the runtime once up front, and then insert absolute paths to the runtime into the output code.

Using absolute paths is not desirable if files are compiled for use at a later time, but in contexts where a file is compiled and then immediately consumed, they can be quite helpful.

You can read more about configuring plugin options here

Technical details

The transform-runtime transformer plugin does three things:

  • Automatically requires @babel/runtime/regenerator when you use generators/async functions (toggleable with the regenerator option).
  • Can use core-js for helpers if necessary instead of assuming it will be polyfilled by the user (toggleable with the corejs option)
  • Automatically removes the inline Babel helpers and uses the module @babel/runtime/helpers instead (toggleable with the helpers option).What does this actually mean though? Basically, you can use built-ins such as Promise, Set, Symbol, etc., as well use all the Babel features that require a polyfill seamlessly, without global pollution, making it extremely suitable for libraries.

Make sure you include @babel/runtime as a dependency.

Regenerator aliasing

Whenever you use a generator function or async function:

  1. function* foo() {}

the following is generated:

  1. "use strict";
  3. var _marked = [foo].map(regeneratorRuntime.mark);
  5. function foo() {
  6.   return regeneratorRuntime.wrap(
  7.     function foo$(_context) {
  8.       while (1) {
  9.         switch ((_context.prev = _context.next)) {
  10.           case 0:
  11.           case "end":
  12.             return _context.stop();
  13.         }
  14.       }
  15.     },
  16.     _marked[0],
  17.     this
  18.   );
  19. }

This isn't ideal since it relies on the regenerator runtime being included, whichpollutes the global scope.

With the runtime transformer, however, it is compiled to:

  1. "use strict";
  3. var _regenerator = require("@babel/runtime/regenerator");
  5. var _regenerator2 = _interopRequireDefault(_regenerator);
  7. function _interopRequireDefault(obj) {
  8.   return obj && obj.__esModule ? obj : { default: obj };
  9. }
  11. var _marked = [foo].map(_regenerator2.default.mark);
  13. function foo() {
  14.   return _regenerator2.default.wrap(
  15.     function foo$(_context) {
  16.       while (1) {
  17.         switch ((_context.prev = _context.next)) {
  18.           case 0:
  19.           case "end":
  20.             return _context.stop();
  21.         }
  22.       }
  23.     },
  24.     _marked[0],
  25.     this
  26.   );
  27. }

This means that you can use the regenerator runtime without polluting your current environment.

core-js aliasing

Sometimes you may want to use new built-ins such as Map, Set, Promise etc. Your only wayto use these is usually to include a globally polluting polyfill.

This is with the corejs option.

The plugin transforms the following:

  1. var sym = Symbol();
  3. var promise = new Promise();
  5. console.log(arr[Symbol.iterator]());

into the following:

  1. "use strict";
  3. var _getIterator2 = require("@babel/runtime-corejs2/core-js/get-iterator");
  5. var _getIterator3 = _interopRequireDefault(_getIterator2);
  7. var _promise = require("@babel/runtime-corejs2/core-js/promise");
  9. var _promise2 = _interopRequireDefault(_promise);
  11. var _symbol = require("@babel/runtime-corejs2/core-js/symbol");
  13. var _symbol2 = _interopRequireDefault(_symbol);
  15. function _interopRequireDefault(obj) {
  16.   return obj && obj.__esModule ? obj : { default: obj };
  17. }
  19. var sym = (0, _symbol2.default)();
  21. var promise = new _promise2.default();
  23. console.log((0, _getIterator3.default)(arr));

This means is that you can seamlessly use these native built-ins and static methodswithout worrying about where they come from.

NOTE: Instance methods such as "foobar".includes("foo") will not work.

Helper aliasing

Usually Babel will place helpers at the top of your file to do common tasks to avoidduplicating the code around in the current file. Sometimes these helpers can get alittle bulky and add unnecessary duplication across files. The runtimetransformer replaces all the helper calls to a module.

That means that the following code:

  1. class Person {}

usually turns into:

  1. "use strict";
  3. function _classCallCheck(instance, Constructor) {
  4.   if (!(instance instanceof Constructor)) {
  5.     throw new TypeError("Cannot call a class as a function");
  6.   }
  7. }
  9. var Person = function Person() {
  10.   _classCallCheck(this, Person);
  11. };

the runtime transformer however turns this into:

  1. "use strict";
  3. var _classCallCheck2 = require("@babel/runtime/helpers/classCallCheck");
  5. var _classCallCheck3 = _interopRequireDefault(_classCallCheck2);
  7. function _interopRequireDefault(obj) {
  8.   return obj && obj.__esModule ? obj : { default: obj };
  9. }
  11. var Person = function Person() {
  12.   (0, _classCallCheck3.default)(this, Person);
  13. };

You can read more about configuring plugin options here