Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Summary: This PR adds support for [babel-plugin-macros](https://github.com/kentcdodds/babel-plugin-macros). Usage: ```js import graphql from 'babel-plugin-relay/macro'; // Or: // const graphql = require('babel-plugin-relay/macro'); ``` `graphql` is exported from both the `react-relay` and `relay-runtime` packages, but as I created this PR mostly in the interest of possible Create React App integration, I only added an export to `react-relay`. This PR currently only adds support for Relay Modern. I'm not sure if Compat and/or Classic should be supported? I currently only have a single basic test. I certainly could copy over the fixtures in `__tests__/fixtures-modern` and change the imports, although I'm not sure how beneficial that would be, as most of the logic is shared with `babel-plugin-relay`. Closes #1968 Related: facebook/create-react-app#2730 (comment) /cc kentcdodds Pull Request resolved: #2171 Reviewed By: jstejada Differential Revision: D6831205 Pulled By: kassens fbshipit-source-id: 704a239b45974359cc1dcecacd85efb4aeddeef5
- Loading branch information
1 parent
7d43533
commit f74387d
Showing
8 changed files
with
182 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /** | ||
| * Copyright (c) 2013-present, Facebook, Inc. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| * | ||
| * @flow | ||
| * @format | ||
| */ | ||
|
|
||
| 'use strict'; | ||
|
|
||
| const compileGraphQLTag = require('./compileGraphQLTag'); | ||
| const getValidGraphQLTag = require('./getValidGraphQLTag'); | ||
|
|
||
| const {createMacro} = require('babel-plugin-macros'); | ||
|
|
||
| function BabelPluginRelayMacro({references, state, babel}) { | ||
| const {types: t} = babel; | ||
| Object.keys(references).forEach(referenceKey => { | ||
| references[referenceKey].forEach(reference => { | ||
| const path = reference.parentPath; | ||
| const ast = getValidGraphQLTag(path); | ||
| if (ast) { | ||
| compileGraphQLTag(t, path, state, ast); | ||
| } | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| module.exports = createMacro(BabelPluginRelayMacro); |
42 changes: 42 additions & 0 deletions
42
packages/babel-plugin-relay/__tests__/BabelPluginRelay.macro-test.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /** | ||
| * Copyright (c) 2013-present, Facebook, Inc. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| * | ||
| * @format | ||
| * @emails oncall+relay | ||
| */ | ||
|
|
||
| 'use strict'; | ||
|
|
||
| require('configureForRelayOSS'); | ||
|
|
||
| const pluginTester = require('babel-plugin-tester'); | ||
| const plugin = require('babel-plugin-macros'); | ||
|
|
||
| pluginTester({ | ||
| plugin, | ||
| snapshot: true, | ||
| title: 'BabelPluginRelayMacro', | ||
| babelOptions: {filename: __filename, parserOpts: {plugins: ['jsx']}}, | ||
| tests: { | ||
| works: ` | ||
| 'use strict'; | ||
| const {graphql} = require('../BabelPluginRelay.macro'); | ||
| const ProfilePic = require('ProfilePic'); | ||
| const ViewerQuery = graphql\` | ||
| query ViewerQuery($id: ID!, $scale: Float = 1.5) { | ||
| node(id: $id) { | ||
| ... on User { | ||
| id | ||
| ...ProfilePic_user | ||
| } | ||
| } | ||
| } | ||
| \`; | ||
| `, | ||
| }, | ||
| }); |
37 changes: 37 additions & 0 deletions
37
packages/babel-plugin-relay/__tests__/__snapshots__/BabelPluginRelay.macro-test.js.snap
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| // Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
|
||
| exports[`BabelPluginRelayMacro works: works 1`] = ` | ||
| " | ||
| 'use strict'; | ||
| const {graphql} = require('../BabelPluginRelay.macro'); | ||
| const ProfilePic = require('ProfilePic'); | ||
| const ViewerQuery = graphql\` | ||
| query ViewerQuery($id: ID!, $scale: Float = 1.5) { | ||
| node(id: $id) { | ||
| ... on User { | ||
| id | ||
| ...ProfilePic_user | ||
| } | ||
| } | ||
| } | ||
| \`; | ||
| ↓ ↓ ↓ ↓ ↓ ↓ | ||
| 'use strict'; | ||
| const ProfilePic = require('ProfilePic'); | ||
| const ViewerQuery = function () { | ||
| const node = require('./__generated__/ViewerQuery.graphql'); | ||
| if (node.hash && node.hash !== 'b046a97b7823510c05083ebb114377f4') { | ||
| console.error('The definition of \\\\'ViewerQuery\\\\' appears to have changed. Run \`relay-compiler\` to update the generated files to receive the expected data.'); | ||
| } | ||
| return require('./__generated__/ViewerQuery.graphql'); | ||
| }; | ||
| " | ||
| `; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters