babel-plugin-relay 13.0.0-rc.1 → 13.0.0-rc.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/BabelPluginRelay.js.flow +9 -6
- package/BabelPluginRelay.macro.js.flow +1 -1
- package/README.md +47 -0
- package/babel-plugin-relay.js +2 -2
- package/babel-plugin-relay.min.js +2 -2
- package/compileGraphQLTag.js.flow +6 -7
- package/getValidGraphQLTag.js.flow +1 -1
- package/index.js +1 -1
- package/lib/BabelPluginRelay.js +1 -1
- package/lib/BabelPluginRelay.macro.js +1 -1
- package/lib/compileGraphQLTag.js +8 -6
- package/lib/getValidGraphQLTag.js +1 -1
- package/macro.js +1 -1
- package/package.json +1 -1
package/BabelPluginRelay.js.flow
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Copyright (c)
|
|
2
|
+
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
3
3
|
*
|
|
4
4
|
* This source code is licensed under the MIT license found in the
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
@@ -31,11 +31,14 @@ if (result) {
|
|
|
31
31
|
|
|
32
32
|
export type RelayPluginOptions = {
|
|
33
33
|
// The command to run to compile Relay files, used for error messages.
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
haste
|
|
37
|
-
//
|
|
38
|
-
|
|
34
|
+
codegenCommand?: string,
|
|
35
|
+
|
|
36
|
+
// Formatting style for generated files. `commonjs` or `haste`.
|
|
37
|
+
// Default is `commonjs`.
|
|
38
|
+
jsModuleFormat?: string,
|
|
39
|
+
|
|
40
|
+
// Name of the global variable for dev mode
|
|
41
|
+
isDevVariableName?: string,
|
|
39
42
|
|
|
40
43
|
// enable generating eager es modules for modern runtime
|
|
41
44
|
eagerESModules?: boolean,
|
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
babel-plugin-relay
|
|
2
|
+
---
|
|
3
|
+
|
|
4
|
+
Relay requires a Babel plugin to convert GraphQL tags to runtime artifacts.
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
A *very* simplified example of what this plugin is doing:
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
|
|
11
|
+
// It converts this code
|
|
12
|
+
const fragment = graphql`
|
|
13
|
+
fragment User_fragment on User {
|
|
14
|
+
name
|
|
15
|
+
}
|
|
16
|
+
`;
|
|
17
|
+
|
|
18
|
+
// To require generated ASTs for fragments and queries
|
|
19
|
+
const fragment = require('__generated__/User_fragment.graphql');
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Plugin Configuration
|
|
23
|
+
|
|
24
|
+
`babel-plugin-relay` will discover the config if:
|
|
25
|
+
|
|
26
|
+
- There is a `relay.config.json`, `relay.config.js` file at the root of the
|
|
27
|
+
project (i.e. in the same folder as the `package.json` file).
|
|
28
|
+
- The `package.json` file contains a `"relay"` key.
|
|
29
|
+
|
|
30
|
+
### Supported configuration options for `babel-plugin-relay`
|
|
31
|
+
|
|
32
|
+
- `artifactDirectory` A specific directory to output all artifacts to. When
|
|
33
|
+
enabling this the babel plugin needs `artifactDirectory`
|
|
34
|
+
to be set as well. [string]
|
|
35
|
+
- `eagerEsModules` This option enables emitting ES modules artifacts.
|
|
36
|
+
[boolean][default: false]
|
|
37
|
+
- `codegenCommand` The command to run to compile Relay files.
|
|
38
|
+
[string]
|
|
39
|
+
- `isDevVariableName` Name of the global variable for dev mode
|
|
40
|
+
(e.g. `__DEV__`).
|
|
41
|
+
[string]
|
|
42
|
+
- `jsModuleFormat` Formatting style for generated files. `commonjs`
|
|
43
|
+
or `haste`. Default is `commonjs`.
|
|
44
|
+
[string]
|
|
45
|
+
|
|
46
|
+
[Configuration Instructions](
|
|
47
|
+
https://relay.dev/docs/getting-started/installation-and-setup/#set-up-babel-plugin-relay)
|
package/babel-plugin-relay.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Relay v13.0.0-rc.
|
|
2
|
+
* Relay v13.0.0-rc.2
|
|
3
3
|
*/
|
|
4
|
-
module.exports=function(e){var r={};function t
|
|
4
|
+
module.exports=function(e){var r={};function n(t){if(r[t])return r[t].exports;var i=r[t]={i:t,l:!1,exports:{}};return e[t].call(i.exports,i,i.exports,n),i.l=!0,i.exports}return n.m=e,n.c=r,n.d=function(e,r,t){n.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:t})},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.t=function(e,r){if(1&r&&(e=n(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var t=Object.create(null);if(n.r(t),Object.defineProperty(t,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var i in e)n.d(t,i,function(r){return e[r]}.bind(null,i));return t},n.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(r,"a",r),r},n.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},n.p="",n(n.s=1)}([function(e,r){e.exports=require("graphql")},function(e,r,n){"use strict";var t,i=n(2)(n(3)),o=n(4),a=n(7),l=n(8),s=l("relay",{searchPlaces:["relay.config.js","relay.config.json","package.json"],loaders:{".json":l.loadJson,".js":l.loadJs,noExt:l.loadYaml}}).searchSync();s&&(t=s.config),e.exports=function(e){var r=e.types;if(!r)throw new Error('BabelPluginRelay: Expected plugin context to include "types", but got:'+String(e));var n={TaggedTemplateExpression:function(e,n){var t=a(e);t&&o(r,e,n,t)}};return{visitor:{Program:function(e,r){e.traverse(n,(0,i.default)((0,i.default)({},r),{},{opts:(0,i.default)((0,i.default)({},t),r.opts)}))}}}}},function(e,r){e.exports=require("@babel/runtime/helpers/interopRequireDefault")},function(e,r){e.exports=require("@babel/runtime/helpers/objectSpread2")},function(e,r,n){"use strict";var t=n(5),i=n(0).print,o=n(6),a=o.dirname,l=o.join,s=o.relative,u=o.resolve;e.exports=function(e,r,n,o){var p,d,f,c,g,v,m;if(1!==o.definitions.length)throw new Error("BabelPluginRelay: Expected exactly one definition per graphql tag.");var x=o.definitions[0];if("FragmentDefinition"!==x.kind&&"OperationDefinition"!==x.kind)throw new Error("BabelPluginRelay: Expected a fragment, mutation, query, or subscription, got `"+x.kind+"`.");var h=null!==(p=null===(d=n.opts)||void 0===d?void 0:d.eagerESModules)&&void 0!==p&&p,b="haste"===(null===(f=n.opts)||void 0===f?void 0:f.jsModuleFormat),y=null===(c=n.opts)||void 0===c?void 0:c.isDevVariableName;return function(e,r,n,o,p){var d=o.name&&o.name.value;if(!d)throw new Error("GraphQL operations and fragments must contain names");var f=d+".graphql",c=p.isHasteMode?f:p.artifactDirectory?function(e,r,n){if(null==e.file)throw new Error("Babel state is missing expected file name");var t=e.file.opts.filename,i=s(a(t),u(r));return(0!==i.length&&i.startsWith(".")?"":"./")+l(i,n)}(r,p.artifactDirectory,f):"./__generated__/"+f,g=t.createHash("md5").update(i(o),"utf8").digest("hex"),v=n.scope;for(;v.parent;)v=v.parent;var m=v.generateUidIdentifier(d),x=e.MemberExpression(m,e.Identifier("hash")),h=function(e,r,n){return e.callExpression(e.memberExpression(e.identifier("console"),e.identifier("error")),[e.stringLiteral("The definition of '".concat(r,"' appears to have changed. Run ")+"`"+n+"` to update the generated files to receive the expected data.")])}(e,d,p.buildCommand),b=e.LogicalExpression("&&",x,e.LogicalExpression("&&",e.BinaryExpression("!==",x,e.StringLiteral(g)),h));if(p.eagerESModules){var y=e.ImportDeclaration([e.ImportDefaultSpecifier(m)],e.StringLiteral(c));n.findParent((function(e){return e.isProgram()})).unshiftContainer("body",y);var E,q=e.SequenceExpression([b,m]);E=null!=p.isDevVariable?e.ConditionalExpression(e.Identifier(p.isDevVariable),q,m):p.isDevelopment?q:m,n.replaceWith(E)}else{v.push({id:m});var D,S=e.CallExpression(e.Identifier("require"),[e.StringLiteral(c)]),w=e.AssignmentExpression("=",m,S),j=e.SequenceExpression([w,b,m]);D=null!=p.isDevVariable?e.ConditionalExpression(e.Identifier(p.isDevVariable),j,w):p.isDevelopment?j:w;var P=e.UnaryExpression("void",e.NumericLiteral(0));n.replaceWith(e.ConditionalExpression(e.BinaryExpression("!==",m,P),m,D))}}(e,n,r,x,{artifactDirectory:null===(g=n.opts)||void 0===g?void 0:g.artifactDirectory,eagerESModules:h,buildCommand:null!==(v=null===(m=n.opts)||void 0===m?void 0:m.codegenCommand)&&void 0!==v?v:"relay-compiler",isDevelopment:"production"!==(process.env.BABEL_ENV||"development"),isHasteMode:b,isDevVariable:y})}},function(e,r){e.exports=require("crypto")},function(e,r){e.exports=require("path")},function(e,r,n){"use strict";var t=n(0);e.exports=function(e){if(!e.get("tag").isIdentifier({name:"graphql"}))return null;var r=e.node.quasi.quasis;if(1!==r.length)throw new Error("BabelPluginRelay: Substitutions are not allowed in graphql fragments. Included fragments should be referenced as `...MyModule_propName`.");var n=r[0].value.raw,i=t.parse(n);if(0===i.definitions.length)throw new Error("BabelPluginRelay: Unexpected empty graphql tag.");return i}},function(e,r){e.exports=require("cosmiconfig")}]);
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Relay v13.0.0-rc.
|
|
2
|
+
* Relay v13.0.0-rc.2
|
|
3
3
|
*
|
|
4
4
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
5
5
|
*
|
|
6
6
|
* This source code is licensed under the MIT license found in the
|
|
7
7
|
* LICENSE file in the root directory of this source tree.
|
|
8
8
|
*/
|
|
9
|
-
module.exports=function(e){var r={};function t
|
|
9
|
+
module.exports=function(e){var r={};function n(t){if(r[t])return r[t].exports;var i=r[t]={i:t,l:!1,exports:{}};return e[t].call(i.exports,i,i.exports,n),i.l=!0,i.exports}return n.m=e,n.c=r,n.d=function(e,r,t){n.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:t})},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.t=function(e,r){if(1&r&&(e=n(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var t=Object.create(null);if(n.r(t),Object.defineProperty(t,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var i in e)n.d(t,i,function(r){return e[r]}.bind(null,i));return t},n.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(r,"a",r),r},n.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},n.p="",n(n.s=1)}([function(e,r){e.exports=require("graphql")},function(e,r,n){"use strict";var t,i=n(2)(n(3)),o=n(4),a=n(7),l=n(8),s=l("relay",{searchPlaces:["relay.config.js","relay.config.json","package.json"],loaders:{".json":l.loadJson,".js":l.loadJs,noExt:l.loadYaml}}).searchSync();s&&(t=s.config),e.exports=function(e){var r=e.types;if(!r)throw new Error('BabelPluginRelay: Expected plugin context to include "types", but got:'+String(e));var n={TaggedTemplateExpression:function(e,n){var t=a(e);t&&o(r,e,n,t)}};return{visitor:{Program:function(e,r){e.traverse(n,(0,i.default)((0,i.default)({},r),{},{opts:(0,i.default)((0,i.default)({},t),r.opts)}))}}}}},function(e,r){e.exports=require("@babel/runtime/helpers/interopRequireDefault")},function(e,r){e.exports=require("@babel/runtime/helpers/objectSpread2")},function(e,r,n){"use strict";var t=n(5),i=n(0).print,o=n(6),a=o.dirname,l=o.join,s=o.relative,u=o.resolve;e.exports=function(e,r,n,o){var p,d,c,f,g,v,m;if(1!==o.definitions.length)throw new Error("BabelPluginRelay: Expected exactly one definition per graphql tag.");var x=o.definitions[0];if("FragmentDefinition"!==x.kind&&"OperationDefinition"!==x.kind)throw new Error("BabelPluginRelay: Expected a fragment, mutation, query, or subscription, got `"+x.kind+"`.");var h=null!==(p=null===(d=n.opts)||void 0===d?void 0:d.eagerESModules)&&void 0!==p&&p,b="haste"===(null===(c=n.opts)||void 0===c?void 0:c.jsModuleFormat),y=null===(f=n.opts)||void 0===f?void 0:f.isDevVariableName;return function(e,r,n,o,p){var d=o.name&&o.name.value;if(!d)throw new Error("GraphQL operations and fragments must contain names");var c=d+".graphql",f=p.isHasteMode?c:p.artifactDirectory?function(e,r,n){if(null==e.file)throw new Error("Babel state is missing expected file name");var t=e.file.opts.filename,i=s(a(t),u(r));return(0!==i.length&&i.startsWith(".")?"":"./")+l(i,n)}(r,p.artifactDirectory,c):"./__generated__/"+c,g=t.createHash("md5").update(i(o),"utf8").digest("hex"),v=n.scope;for(;v.parent;)v=v.parent;var m=v.generateUidIdentifier(d),x=e.MemberExpression(m,e.Identifier("hash")),h=function(e,r,n){return e.callExpression(e.memberExpression(e.identifier("console"),e.identifier("error")),[e.stringLiteral("The definition of '".concat(r,"' appears to have changed. Run ")+"`"+n+"` to update the generated files to receive the expected data.")])}(e,d,p.buildCommand),b=e.LogicalExpression("&&",x,e.LogicalExpression("&&",e.BinaryExpression("!==",x,e.StringLiteral(g)),h));if(p.eagerESModules){var y=e.ImportDeclaration([e.ImportDefaultSpecifier(m)],e.StringLiteral(f));n.findParent((function(e){return e.isProgram()})).unshiftContainer("body",y);var E,q=e.SequenceExpression([b,m]);E=null!=p.isDevVariable?e.ConditionalExpression(e.Identifier(p.isDevVariable),q,m):p.isDevelopment?q:m,n.replaceWith(E)}else{v.push({id:m});var D,S=e.CallExpression(e.Identifier("require"),[e.StringLiteral(f)]),w=e.AssignmentExpression("=",m,S),j=e.SequenceExpression([w,b,m]);D=null!=p.isDevVariable?e.ConditionalExpression(e.Identifier(p.isDevVariable),j,w):p.isDevelopment?j:w;var P=e.UnaryExpression("void",e.NumericLiteral(0));n.replaceWith(e.ConditionalExpression(e.BinaryExpression("!==",m,P),m,D))}}(e,n,r,x,{artifactDirectory:null===(g=n.opts)||void 0===g?void 0:g.artifactDirectory,eagerESModules:h,buildCommand:null!==(v=null===(m=n.opts)||void 0===m?void 0:m.codegenCommand)&&void 0!==v?v:"relay-compiler",isDevelopment:"production"!==(process.env.BABEL_ENV||"production"),isHasteMode:b,isDevVariable:y})}},function(e,r){e.exports=require("crypto")},function(e,r){e.exports=require("path")},function(e,r,n){"use strict";var t=n(0);e.exports=function(e){if(!e.get("tag").isIdentifier({name:"graphql"}))return null;var r=e.node.quasi.quasis;if(1!==r.length)throw new Error("BabelPluginRelay: Substitutions are not allowed in graphql fragments. Included fragments should be referenced as `...MyModule_propName`.");var n=r[0].value.raw,i=t.parse(n);if(0===i.definitions.length)throw new Error("BabelPluginRelay: Unexpected empty graphql tag.");return i}},function(e,r){e.exports=require("cosmiconfig")}]);
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Copyright (c)
|
|
2
|
+
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
3
3
|
*
|
|
4
4
|
* This source code is licensed under the MIT license found in the
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
@@ -56,12 +56,11 @@ function compileGraphQLTag(
|
|
|
56
56
|
);
|
|
57
57
|
}
|
|
58
58
|
|
|
59
|
-
const eagerESModules =
|
|
60
|
-
const isHasteMode =
|
|
61
|
-
const isDevVariable = state.opts
|
|
62
|
-
const artifactDirectory = state.opts
|
|
63
|
-
const buildCommand =
|
|
64
|
-
(state.opts && state.opts.buildCommand) || 'relay-compiler';
|
|
59
|
+
const eagerESModules = state.opts?.eagerESModules ?? false;
|
|
60
|
+
const isHasteMode = state.opts?.jsModuleFormat === 'haste';
|
|
61
|
+
const isDevVariable = state.opts?.isDevVariableName;
|
|
62
|
+
const artifactDirectory = state.opts?.artifactDirectory;
|
|
63
|
+
const buildCommand = state.opts?.codegenCommand ?? 'relay-compiler';
|
|
65
64
|
// Fallback is 'true'
|
|
66
65
|
const isDevelopment =
|
|
67
66
|
(process.env.BABEL_ENV || process.env.NODE_ENV) !== 'production';
|
package/index.js
CHANGED
package/lib/BabelPluginRelay.js
CHANGED
package/lib/compileGraphQLTag.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Copyright (c)
|
|
2
|
+
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
3
3
|
*
|
|
4
4
|
* This source code is licensed under the MIT license found in the
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
@@ -27,6 +27,8 @@ var GENERATED = './__generated__/';
|
|
|
27
27
|
*/
|
|
28
28
|
|
|
29
29
|
function compileGraphQLTag(t, path, state, ast) {
|
|
30
|
+
var _state$opts$eagerESMo, _state$opts, _state$opts2, _state$opts3, _state$opts4, _state$opts$codegenCo, _state$opts5;
|
|
31
|
+
|
|
30
32
|
if (ast.definitions.length !== 1) {
|
|
31
33
|
throw new Error('BabelPluginRelay: Expected exactly one definition per graphql tag.');
|
|
32
34
|
}
|
|
@@ -37,11 +39,11 @@ function compileGraphQLTag(t, path, state, ast) {
|
|
|
37
39
|
throw new Error('BabelPluginRelay: Expected a fragment, mutation, query, or ' + 'subscription, got `' + definition.kind + '`.');
|
|
38
40
|
}
|
|
39
41
|
|
|
40
|
-
var eagerESModules =
|
|
41
|
-
var isHasteMode =
|
|
42
|
-
var isDevVariable = state.opts
|
|
43
|
-
var artifactDirectory = state.opts
|
|
44
|
-
var buildCommand =
|
|
42
|
+
var eagerESModules = (_state$opts$eagerESMo = (_state$opts = state.opts) === null || _state$opts === void 0 ? void 0 : _state$opts.eagerESModules) !== null && _state$opts$eagerESMo !== void 0 ? _state$opts$eagerESMo : false;
|
|
43
|
+
var isHasteMode = ((_state$opts2 = state.opts) === null || _state$opts2 === void 0 ? void 0 : _state$opts2.jsModuleFormat) === 'haste';
|
|
44
|
+
var isDevVariable = (_state$opts3 = state.opts) === null || _state$opts3 === void 0 ? void 0 : _state$opts3.isDevVariableName;
|
|
45
|
+
var artifactDirectory = (_state$opts4 = state.opts) === null || _state$opts4 === void 0 ? void 0 : _state$opts4.artifactDirectory;
|
|
46
|
+
var buildCommand = (_state$opts$codegenCo = (_state$opts5 = state.opts) === null || _state$opts5 === void 0 ? void 0 : _state$opts5.codegenCommand) !== null && _state$opts$codegenCo !== void 0 ? _state$opts$codegenCo : 'relay-compiler'; // Fallback is 'true'
|
|
45
47
|
|
|
46
48
|
var isDevelopment = (process.env.BABEL_ENV || process.env.NODE_ENV) !== 'production';
|
|
47
49
|
return createNode(t, state, path, definition, {
|
package/macro.js
CHANGED