JSPM

babel-plugin-relay

20.1.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 217966
  • Score
    100M100P100Q173693F
  • License MIT

A Babel Plugin for use with Relay applications.

Package Exports

  • babel-plugin-relay
  • babel-plugin-relay/index.js
  • babel-plugin-relay/lib/compileGraphQLTag
  • babel-plugin-relay/lib/compileGraphQLTag.js
  • babel-plugin-relay/lib/getValidGraphQLTag
  • babel-plugin-relay/lib/getValidGraphQLTag.js
  • babel-plugin-relay/macro
  • babel-plugin-relay/macro.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (babel-plugin-relay) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

babel-plugin-relay

Relay requires a Babel plugin to convert GraphQL tags to runtime artifacts.

A very simplified example of what this plugin is doing:

// It converts this code
const fragment = graphql`
  fragment User_fragment on User {
    name
  }
`;

// To require generated ASTs for fragments and queries
const fragment = require('__generated__/User_fragment.graphql');

Plugin Configuration

babel-plugin-relay will discover the config if:

  • There is a relay.config.json, relay.config.js file at the root of the project (i.e. in the same folder as the package.json file).
  • The package.json file contains a "relay" key.

Supported configuration options for babel-plugin-relay

  • artifactDirectory A specific directory to output all artifacts to. When enabling this the babel plugin needs artifactDirectory to be set as well. [string]
  • eagerEsModules This option enables emitting ES modules artifacts. [boolean][default: false]
  • codegenCommand The command to run to compile Relay files. [string]
  • isDevVariableName Name of the global variable for dev mode (e.g. __DEV__). [string]
  • jsModuleFormat Formatting style for generated files. commonjs or haste. Default is commonjs. [string]

Configuration Instructions