relay-compiler-language-typescript

A language plugin for Relay that adds TypeScript support, including emitting type definitions.

⚠️ As of this writing, the pull-request that adds language plugin support to Relay has not yet been merged. Thus, if you want to use this plugin you’ll have to cut a release with that patch yourself. Alternatively, you can use prebuilt packages that Artsy uses (use the ones that are of the form vx.x.x-plugin.x, not vx.x.x-artsy.x).

Installation

Add the package to your dev dependencies:

yarn add relay-compiler-language-typescript --dev

Configuration

relay-compiler

Then configure your relay-compiler script to use it, like so:

{
  "scripts": {
    "relay": "relay-compiler --src ./src --schema data/schema.graphql --language typescript --artifactDirectory ./src/__generated__"
  }
}

This is going to store all artifacts in a single directory, which you also need to instruct babel-plugin-relay to use in your .babelrc:

{
  "plugins": [
    ["relay", { "artifactDirectory": "./src/__generated__" }]
  ]
}

TypeScript

Also be sure to configure the TypeScript compiler to transpile to es2015 modules and leave transpilation to commonjs modules up to Babel with the following tsconfig.json settings:

{
  "compilerOptions": {
    "target": "es2015",
    "module": "es2015"
  }
}

The reason for this is that tsc would otherwise generate code where the imported graphql function is being namespaced (react_relay_1 in this example):

react_relay_1.createFragmentContainer(MyComponent, react_relay_1.graphql `
  ...
`);

…and this makes it impossible for babel-plugin-relay to find the locations where the graphql function is being used.

Note that this does mean you need to configure Babel to transform the ES module import and export statements, by using the babel-plugin-transform-es2015-modules-commonjs transform plugin, if you’re not already.

Examples

You can find a copy of the Relay example TODO app inside this repository or you can take a look at the Artsy React Native app.

License

This package is available under the MIT license. See the included LICENSE file for details.