Commit 1719738e authored by Arunoda Susiripala's avatar Arunoda Susiripala Committed by Guillermo Rauch

Allow to customize our babel configuration (#466)

* Add a way to customize babel configurations.

* Add babel configuration docs to README.
parent 9ac79ed1
...@@ -396,10 +396,40 @@ In order to extend our usage of `webpack`, you can define a function that extend ...@@ -396,10 +396,40 @@ In order to extend our usage of `webpack`, you can define a function that extend
The following example shows how you can use [`react-svg-loader`](https://github.com/boopathi/react-svg-loader) to easily import any `.svg` file as a React component, without modification. The following example shows how you can use [`react-svg-loader`](https://github.com/boopathi/react-svg-loader) to easily import any `.svg` file as a React component, without modification.
```js ```js
// This file is not going through babel transformation.
// So, we write it in vanilla JS
// (But you could use ES2015 features supported by your Node.js version)
module.exports = {
webpack: (config, { dev }) => {
config.module.rules.push({ test: /\.svg$/, loader: 'babel!react-svg' })
// Important: return the modified config
return config
}
}
```
### Customizing babel config
In order to extend our usage of `babel`, you can define a function that extends its config via `next.config.js`.
The following example config shows you how to use `babel-preset-stage-0` with your app.
```js
// This file is not going through babel transformation.
// So, we write it in vanilla JS
// (But you could use ES2015 features supported by your Node.js version)
module.exports = { module.exports = {
webpack: (cfg, { dev }) => { // config is the set of options we pass to our babel-loaders's query option
cfg.module.rules.push({ test: /\.svg$/, loader: 'babel!react-svg' }) babel: function (config, { dev }) {
return cfg // Add the stage-0 preset.
// Make sure to use 'require.resolve' otherwise we won't be able to find it.
config.presets.push(require.resolve('babel-preset-stage-0'))
// Important: return the modified config
return config
} }
} }
``` ```
......
# Example app using custom babel config
This example features:
* An app using proposed [do expressions](https://babeljs.io/docs/plugins/transform-do-expressions/).
* It uses babel-preset-stage-0, which allows us to use above JavaScript feature.
## How to run it
```sh
npm install
npm run dev
```
// This file is not going through babel transformation.
// So, we write it in vanilla JS
// (But you could use ES2015 features supported by your Node.js version)
module.exports = {
// config is the set of options we pass to our babel-loaders's query option
babel: function (config) {
// Add the stage-0 preset.
// Make sure to use 'require.resolve' otherwise we won't be able to find it.
config.presets.push(require.resolve('babel-preset-stage-0'))
// Important: return the modified config
return config
}
}
{
"name": "with-custom-babel-config",
"version": "1.0.0",
"description": "This example features:",
"main": "index.js",
"scripts": {
"dev": "next",
"build": "next build",
"start": "next start"
},
"dependencies": {
"next": "^2.0.0-beta"
},
"author": "",
"license": "ISC",
"devDependencies": {
"babel-preset-stage-0": "^6.16.0"
}
}
import React from 'react'
export default class MyLuckNo extends React.Component {
constructor (...args) {
super(...args)
this.state = { randomNo: null }
}
componentDidMount () {
this.recalculate()
}
recalculate () {
this.setState({
randomNo: Math.ceil(Math.random() * 100)
})
}
render () {
const { randomNo } = this.state
if (randomNo === null) {
return (<p>Please wait..</p>)
}
// This is an experimental JavaScript feature where we can get with
// using babel-preset-stage-0
const message = do {
if (randomNo < 30) {
'Do not give up. Try again.'
} else if (randomNo < 60) {
'You are a lucky guy'
} else {
'You are soooo lucky!'
}
}
return (
<div>
<h3>Your Lucky number is: "{randomNo}"</h3>
<p>{message}</p>
<button onClick={() => this.recalculate()}>Try Again</button>
</div>
)
}
}
...@@ -3,11 +3,13 @@ import { readFile, writeFile } from 'mz/fs' ...@@ -3,11 +3,13 @@ import { readFile, writeFile } from 'mz/fs'
import { transform } from 'babel-core' import { transform } from 'babel-core'
import chokidar from 'chokidar' import chokidar from 'chokidar'
import mkdirp from 'mkdirp-then' import mkdirp from 'mkdirp-then'
import getConfig from '../../config'
export default babel export default babel
async function babel (dir, { dev = false } = {}) { async function babel (dir, { dev = false } = {}) {
dir = resolve(dir) dir = resolve(dir)
const config = getConfig('../')
let src let src
try { try {
...@@ -20,11 +22,18 @@ async function babel (dir, { dev = false } = {}) { ...@@ -20,11 +22,18 @@ async function babel (dir, { dev = false } = {}) {
} }
} }
const { code } = transform(src, { let babelOptions = {
babelrc: false, babelrc: false,
sourceMaps: dev ? 'inline' : false, sourceMaps: dev ? 'inline' : false,
presets: [require.resolve('./preset')] presets: [require.resolve('./preset')]
}) }
if (config.babel) {
console.log('> Using "babel" config function defined in next.config.js.')
babelOptions = await config.babel(babelOptions, { dev })
}
const { code } = transform(src, babelOptions)
const file = join(dir, '.next', 'dist', 'pages', '_document.js') const file = join(dir, '.next', 'dist', 'pages', '_document.js')
await mkdirp(dirname(file)) await mkdirp(dirname(file))
......
...@@ -13,6 +13,7 @@ import getConfig from '../config' ...@@ -13,6 +13,7 @@ import getConfig from '../config'
export default async function createCompiler (dir, { dev = false, quiet = false } = {}) { export default async function createCompiler (dir, { dev = false, quiet = false } = {}) {
dir = resolve(dir) dir = resolve(dir)
const config = getConfig(dir)
const pages = await glob('pages/**/*.js', { const pages = await glob('pages/**/*.js', {
cwd: dir, cwd: dir,
...@@ -83,6 +84,19 @@ export default async function createCompiler (dir, { dev = false, quiet = false ...@@ -83,6 +84,19 @@ export default async function createCompiler (dir, { dev = false, quiet = false
) )
} }
let mainBabelOptions = {
babelrc: false,
sourceMaps: dev ? 'both' : false,
presets: [
require.resolve('./babel/preset')
]
}
if (config.babel) {
console.log('> Using "babel" config function defined in next.config.js.')
mainBabelOptions = await config.babel(mainBabelOptions, { dev })
}
const loaders = (dev ? [{ const loaders = (dev ? [{
test: /\.js(\?[^?]*)?$/, test: /\.js(\?[^?]*)?$/,
loader: 'hot-self-accept-loader', loader: 'hot-self-accept-loader',
...@@ -133,13 +147,7 @@ export default async function createCompiler (dir, { dev = false, quiet = false ...@@ -133,13 +147,7 @@ export default async function createCompiler (dir, { dev = false, quiet = false
exclude (str) { exclude (str) {
return /node_modules/.test(str) && str.indexOf(nextPagesDir) !== 0 return /node_modules/.test(str) && str.indexOf(nextPagesDir) !== 0
}, },
query: { query: mainBabelOptions
babelrc: false,
sourceMaps: dev ? 'both' : false,
presets: [
require.resolve('./babel/preset')
]
}
}]) }])
const interpolateNames = new Map([ const interpolateNames = new Map([
...@@ -188,9 +196,9 @@ export default async function createCompiler (dir, { dev = false, quiet = false ...@@ -188,9 +196,9 @@ export default async function createCompiler (dir, { dev = false, quiet = false
return interpolateNames.get(this.resourcePath) || url return interpolateNames.get(this.resourcePath) || url
} }
} }
const config = getConfig(dir)
if (config.webpack) { if (config.webpack) {
console.log('> Using Webpack config function defined in next.config.js.') console.log('> Using "webpack" config function defined in next.config.js.')
webpackConfig = await config.webpack(webpackConfig, { dev }) webpackConfig = await config.webpack(webpackConfig, { dev })
} }
return webpack(webpackConfig) return webpack(webpackConfig)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment