Shopifybabel-preset-shopify
Shopify’s org-wide set of Babel transforms.
Usage
Install this package, as well as the parts of Babel you wish to use:
With Yarn
yarn add --dev --exact babel-core babel-preset-shopifyWith npm
npm install babel-core babel-preset-shopify --save-dev --save-exactThen, in your Babel configuration (which should be under the babel key of your package.json), set this package as the babel preset you’d like to use:
{
"babel": {
"presets": ["babel-preset-shopify/web"]
}
}Presets
This packages comes with several different presets for you to use, depending on your project:
babel-preset-shopify: The same asbabel-preset-shopify/web.babel-preset-shopify/web: A preset to use for JavaScript that is meant to run in browsers. It compiles down features to only those supported by browsers that you have specified in your browserslist config. Note that many modern JavaScript features, likeMaps,Sets,for ofloops, and more, require runtime polyfills (we recommend@shopify/polyfills, as ourwebandnodeconfigs will reduce these imports to the set of features needed to polyfill your target environment).This preset accepts an options object. The following options are allowed:
modules, a boolean indicating whether native ES2015 modules should be transpiled to CommonJS equivalents. Set this option tofalsewhen you are using a bundler like Rollup or Webpack 2:{ "babel": { "presets": [ ["babel-preset-shopify/web", {"modules": false}] ] } }browsers, a browserslist string or array, which specifies which browsers to transpile for. We recommend setting your target browsers using abrowserslistkey inpackage.json, as that method will automatically be used by all browserslist-compatible tools.{ "babel": { "presets": [ ["babel-preset-shopify/web", { "browsers": ["last 3 versions"] }] ] } }typescript, a boolean (defaults tofalse) to turn on@babel/preset-typescriptand other plugins that allow babel to read typescript files directly.inlineEnv, a boolean (defaults tofalse) to automatically replaceprocess.env.<VAR>statements with the corresponding environment variable.debug, a boolean (defaults tofalse) to turn on@babel/preset-envdebugging.corejs, a number of string that will be used to set thecorejsversion to useuseBuiltIns, a string that is passed to theuseBuiltInsoption of@babel/preset-env
babel-preset-shopify/node: This preset transpiles features to a specified version of Node, defaulting to the currently active version. It accepts an options object. Themodules,typescript,inlineEnv,debug,corejsanduseBuiltInsoptions do the same thing they do inbabel-preset-shopify/web, detailed above. You can also pass a version of Node to target during transpilation using theversionoption:{ "babel": { "presets": [ ["babel-preset-shopify/node", { "modules": false, "version": 4 }] ] } }babel-preset-shopify/react: Adds plugins that transform React (including JSX). You can use this preset with thebabel-preset-shopify/weborbabel-preset-shopify/nodeconfiguration.This preset accepts an options object.
hot: Will automatically add plugins to enable hot reloading of React components. Note that this requires you to have a recent version ofreact-hot-loaderinstalled as a dependency in your project.pragma: Replace the function used when compiling JSX expressions. Defaults toReact.createElement.pragmaFrag: Replace the function used when compiling JSX fragment expressions. Defaults toReact.Fragment.
{ "babel": { "presets": [ ["babel-preset-shopify/react", {"hot": true}] ] } }
As noted above, you can include multiple of these presets together. Some common recipes are shown below:
// A React project without any server component, using sprockets-commoner for bundling
{
"babel": {
"presets": [
"babel-preset-shopify/web",
"babel-preset-shopify/react"
]
}
}
// A Node project using Rollup to create a single bundle
{
"babel": {
"presets": [
["babel-preset-shopify/node", {"modules": false}]
]
}
}