@wordpress/babel-preset-default

Babel Preset Default

Default Babel preset for WordPress development.

The preset includes configuration which enable language features and syntax extensions targeted for support by WordPress. This includes ECMAScript proposals which have reached Stage 4 ("Finished"), as well as the JSX syntax extension. For more information, refer to the JavaScript Coding Guidelines.

Installation

Install the module

npm install @wordpress/babel-preset-default --save-dev

Note: This package requires Node.js version with long-term support status (check Active LTS or Maintenance LTS releases). It is not compatible with older versions.

Usage

There are a number of methods to configure Babel. See Babel's Configuration documentation for more information. To use this preset, simply reference @wordpress/babel-preset-default in the presets option in your Babel configuration.

For example, using .babelrc:

{
	"presets": [ "@wordpress/babel-preset-default" ]
}

Extending Configuration

This preset is an opinionated configuration. If you would like to add to or change this configuration, you can do so by expanding your Babel configuration to include plugins or presets which override those included through this preset. It may help to familiarize yourself the implementation of the configuration to see which specific plugins are enabled by default through this preset.

For example, if you'd like to use a new language feature proposal which has not reached the stability requirements of WordPress, you can add those as additional plugins in your Babel configuration:

{
	"presets": [ "@wordpress/babel-preset-default" ],
	"plugins": [ "@babel/plugin-proposal-class-properties" ]
}

Polyfill

There is a complementary build/polyfill.js (minified version – build/polyfill.min.js) file available that polyfills ECMAScript features missing in the browsers supported by the WordPress project (#31279). It's a drop-in replacement for the deprecated @babel/polyfill package, and it's also based on core-js project.

This needs to be included in some cases, if the features being used require polyfills. You can either prepend it to your compiled code or include it in a <script> before it.

TC39 Proposals

If you need to use a proposal that is not Stage 4, this polyfill will not automatically import those for you. You will have to import those from another polyfill like core-js individually.

Contributing to this package

This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.

To find out more about contributing to this package or Gutenberg as a whole, please read the project's main contributor guide.