Nepotistic Pontifex Maximus

    babel-plugin-relay

    14.1.0 • Public • Published

    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

    Install

    npm i babel-plugin-relay

    Homepage

    relay.dev

    DownloadsWeekly Downloads

    171,451

    Version

    14.1.0

    License

    MIT

    Unpacked Size

    35.1 kB

    Total Files

    15

    Last publish

    Collaborators

    • alunyov
    • rbalicki
    • zpao
    • sugarpirate
    • fb
    • yuzhi
    • josephsavona
    • kassens
    • xiaobu
    • lunaruan
    • relay-bot
    • kacieb