Skip to content

Commit

Permalink
feat(babel-preset-gatsby): allow setting importSource on preset-react (
Browse files Browse the repository at this point in the history
…#29260)

* feat(babel-preset-gatsby): allow passing importSource to preset-react

With React 17's new JSX transform feature, it is possible to pass a custom JSX factory besides React's default one. This is useful when working with libraries like Emotion 11: https://emotion.sh/docs/css-prop#babel-preset.

In order to support this feature in `babel-preset-gatsby`, this PR adds an option called `reactImportSource` that is passed down to the underlying `@babel/preset-react` preset option `importSource`.

Users of `babel-preset-gatsby` can then use this like so:

```json
{
  "presets": [
    [
      "babel-preset-gatsby",
      { "reactRuntime": "automatic", "reactImportSource": "@emotion/react" }
    ]
  ]
}
```

* conditionally pass through the preset option rather than undefined

* throwing if runtime is wrong, move the logic out of the object

* clean up tests, change syntax

Co-authored-by: Laurie <laurie@gatsbyjs.com>
  • Loading branch information
disintegrator and Laurie committed Feb 25, 2021
1 parent f1d7cae commit f72ff77
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
20 changes: 20 additions & 0 deletions packages/babel-preset-gatsby/src/__tests__/index.js
Expand Up @@ -50,4 +50,24 @@ describe(`babel-preset-gatsby`, () => {
}),
])
})

it(`Allows to configure react importSource`, () => {
const { presets } = preset(null, {
reactImportSource: `@emotion/react`,
reactRuntime: `automatic`,
})

expect(presets[1]).toEqual([
expect.stringContaining(path.join(`@babel`, `preset-react`)),
expect.objectContaining({
importSource: `@emotion/react`,
}),
])
})

it(`Fails to configure react importSource if source is classic`, () => {
expect(() => preset(null, { reactImportSource: `@emotion/react` })).toThrow(
`@babel/preset-react\` requires reactRuntime \`automatic\` in order to use \`importSource\`.`
)
})
})
9 changes: 8 additions & 1 deletion packages/babel-preset-gatsby/src/index.js
Expand Up @@ -30,7 +30,7 @@ export function loadCachedConfig() {
}

export default function preset(_, options = {}) {
let { targets = null } = options
let { targets = null, reactImportSource = null } = options

const stage = options.stage || `test`
const pluginBabelConfig = loadCachedConfig()
Expand All @@ -54,6 +54,12 @@ export default function preset(_, options = {}) {
}
}

if (reactImportSource && options.reactRuntime !== `automatic`) {
throw Error(
`\`@babel/preset-react\` requires reactRuntime \`automatic\` in order to use \`importSource\`.`
)
}

return {
presets: [
[
Expand Down Expand Up @@ -87,6 +93,7 @@ export default function preset(_, options = {}) {
: `React.createElement`,
development: stage === `develop`,
runtime: options.reactRuntime || `classic`,
...(reactImportSource && { importSource: reactImportSource }),
},
],
],
Expand Down

0 comments on commit f72ff77

Please sign in to comment.