babel-preset-minoris v16.6.0
babel-preset-minoris
Minoris’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-minoris
With npm
npm install babel-core babel-preset-minoris --save-dev --save-exact
Then, 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": ["minoris/web"]
}
}
Presets
This packages comes with several different presets for you to use, depending on your project:
minoris
: The same asminoris/web
.minoris/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 Minoris’s admin runs on. Note that many modern JavaScript features, likeMap
s,Set
s,for of
loops, and more, require runtime polyfills (we recommendbabel-polyfill
, as ourweb
andnode
configs 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 tofalse
when you are using a bundler like Rollup or Webpack 2:{ "babel": { "presets": [ ["minoris/web", {"modules": false}] ] } }
browsers
, a browserslist string or array, which specifies which browsers to transpile for. Defaults to the list found inbrowsers.js
.{ "babel": { "presets": [ ["minoris/web", { "browsers": ["last 3 versions"] }] ] } }
inlineEnv
, a boolean (defaults tofalse
) to automatically replaceprocess.env.<VAR>
statements with the corresponding environment variable.debug
, a boolean (defaults tofalse
) to turn onbabel-preset-env
debugging.
Note that when using this config, you should also install
babel-polyfill
as a production dependency (yarn add babel-polyfill
ornpm install --save babel-polyfill
). This package will be used to reduce duplication of common Babel helpers.minoris/node
: This preset transpiles features to a specified version of Node, defaulting to the currently active version. It accepts an options object. Themodules
andinlineEnv
do the same thing they do inminoris/web
, detailed above. You can also pass a version of Node to target during transpilation using theversion
option:{ "babel": { "presets": [ ["minoris/node", { "modules": false, "version": 4 }] ] } }
As with
minoris/web
, you should installbabel-polyfill
to help reduce the duplication of Babel helpers.minoris/react
: Adds plugins that transform React (including JSX). You can use this preset with theminoris/web
orminoris/node
configuration. Note that if you enable this, you do not need to also enable theminoris/flow
config (it is included automatically). You will, however, need to include anObject.assign
polyfill in your bundle (we recommend the polyfills found inbabel-polyfill
).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-loader
installed as a dependency in your project.pragma
: Replace the function used when compiling JSX expressions. defaults toReact.createElement
.
{ "babel": { "presets": [ ["minoris/react", {"hot": true}] ] } }
minoris/flow
: Adds plugins that transform Flow type annotations. You can use this preset withminoris/web
orminoris/node
.
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": [
"minoris/web",
"minoris/react"
]
}
}
// A Node project using flow and Rollup to create a single bundle
{
"babel": {
"presets": [
["minoris/node", {"modules": false}],
"minoris/flow"
]
}
}
6 years ago