
Security News
Browserslist-rs Gets Major Refactor, Cutting Binary Size by Over 1MB
Browserslist-rs now uses static data to reduce binary size by over 1MB, improving memory use and performance for Rust-based frontend tools.
relay-compiler-language-typescript
Advanced tools
A language plugin for Relay that adds TypeScript support, including emitting type definitions.
This is repository is obsolete as relay@13 now supports TypeScript directly.
A language plugin for Relay that adds TypeScript support, including emitting type definitions.
Add the package to your dev dependencies:
yarn add graphql relay-compiler --dev
yarn add typescript relay-compiler-language-typescript --dev
Note: Starting with version 15.0.0 relay-compiler-language-typescript requires a minimum TypeScript version of 4.5.0 being installed in your project.
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__" }]]
}
Also be sure to configure the TypeScript compiler to transpile to ES2015
modules (or higher) and leave transpilation to CommonJS
modules (if required)
up to Babel with the following tsconfig.json
settings:
{
"compilerOptions": {
"module": "ES2015", // ES2015 or higher
"target": "ES2020" // best use the highest target setting compatible with your Babel setup
}
}
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`
...
`
);
… which makes it impossible for babel-plugin-relay
to find the locations
where the graphql
function is being used.
The generated code uses ES2015 module syntax if module
is set to ES2015 or
higher in your tsconfig.json
. Note that the eagerESModules
option from
relay-compiler
has no effect on the generated code if module
is ES2015 or
higher.
If you need to add a custom header to generated files, perhaps for a custom linter
or to get boilerplate license code in, that can be passed in also in compilerOptions
as banner
:
{
"compilerOptions": {
"banner": "/* © 2021 Example.org - @generated code */"
}
}
React Hot Loader is known to not always work well with generated code such as our typing artifacts, which will lead to loading modules with TypeScript types into the browser and break. As a maintainer of RHL pointed out in a similar issue:
The problem - hot reloading is not "complete"
So until RHL will be made “complete” this project can’t gurantee to always work well with it, nor is it our control to do anything about that.
This package is available under the MIT license. See the included LICENSE file for details.
FAQs
A language plugin for Relay that adds TypeScript support, including emitting type definitions.
The npm package relay-compiler-language-typescript receives a total of 12,712 weekly downloads. As such, relay-compiler-language-typescript popularity was classified as popular.
We found that relay-compiler-language-typescript demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Browserslist-rs now uses static data to reduce binary size by over 1MB, improving memory use and performance for Rust-based frontend tools.
Research
Security News
Eight new malicious Firefox extensions impersonate games, steal OAuth tokens, hijack sessions, and exploit browser permissions to spy on users.
Security News
The official Go SDK for the Model Context Protocol is in development, with a stable, production-ready release expected by August 2025.