Registry / web-framework / scala-relay-compiler

scala-relay-compiler

library0.12.4jsnpmunverified

A build tool that generates Scala.js bindings from GraphQL schemas and Relay-compiled queries. It replaces the default Flow type generation of the relay-compiler with Scala.js native traits, enabling type-safe GraphQL queries in Scala.js applications. Current version 0.12.4 is experimental and supports Relay specifications. It uses a regex-based approach to extract GraphQL operations from Scala source files annotated with @gql. Differentiating from similar tools like Apollo Scala.js, it integrates closely with the Relay ecosystem and supports deep hierarchical graph structures, spreading, and custom scalajs annotations.

web-framework serialization data

npm install scala-relay-compiler

github ↗package ↗

INSTALL

IMPORT

SIG · SCALA-RELAY-COMPIL

scala-relay-compiler

web-frameworkjavascriptv0.12.4

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

scala-relay-compiler

✓ npm install scala-relay-compiler

✗ N/A

scala-relay-compiler is installed via npm and used as a CLI tool, not imported as a JavaScript module.

relay.graphql.GenericGraphQLTaggedNode

✓ import relay.graphql.GenericGraphQLTaggedNode

✗ import scala.scalajs.js.JSON.parse

This is a Scala.js import used in generated code to define query objects.

@gql

✓ @gql("""...""")

✗ val gql = graphql`...`

The @gql annotation is a string-based annotation in Scala source files, not a template literal.

Complete workflow to set up scala-relay-compiler with a GraphQL schema and Scala source files.

// 1. Install relay-compiler and scala-relay-compiler npm install --save-dev relay-compiler scala-relay-compiler // 2. Create a GraphQL schema file (schema.graphql) // 3. Create Scala source files with @gql annotations // Example: src/main/scala/com/example/Foo.scala package com.example object Foo { val query = @gql(""" query ExampleQuery { dictionary { ...DictionaryComponent_word } } """) val fragment = @gql(""" fragment DictionaryComponent_word on Word { id text } """) } // 4. Run relay-compiler to generate JSON artifacts npx relay-compiler --schema schema.graphql --src src/ --language javascript --artifactDirectory relay-artifacts/ // 5. Run scala-relay-compiler to generate Scala.js bindings npx scala-relay-compiler --src src/ --schema schema.graphql --out target/generated/ // 6. Include generated files in your Scala.js project build

Debug

Known issues

gotchaThe @gql annotation uses a regex-based extraction, not a compile-time macro. If the string formatting is off (e.g., missing triple quotes), the query may not be found.

fix

Ensure @gql("""...""") is exactly as specified; do not use string interpolation or concatenation inside @gql.

affects: >=0.0.0

gotchascala-relay-compiler relies on the relay-compiler's JSON output for query artifacts. Changes to relay-compiler output format (e.g., version bumps) may break generation.

fix

Pin relay-compiler version to match the scala-relay-compiler's expected version (e.g., relay-compiler 1.6.2 for scala-relay-compiler 0.11.0).

affects: >=0.11.0

breakingscala-relay-compiler is experimental and may have breaking changes between minor versions. Version 0.12.4 may not be compatible with relay-compiler versions >1.6.2.

fix

Check the changelog and README for version compatibility before upgrading.

affects: >=0.12.0

gotchaThe generated Scala.js code uses js.native traits and may require Scala.js runtime setup.

fix

Ensure your project is configured for Scala.js (e.g., sbt-scalajs plugin) and includes the relay runtime library.

affects: >=0.0.0

Errors

Common errors & fixes

fragment DictionaryComponent_definition is not used

The regex-based extraction fails to detect the fragment due to incorrect quoting or spacing around the @gql annotation.

fix

Verify that the @gql annotation is exactly `@gql("""...""")` with no extra whitespace or newlines between `@gql` and the opening quote.

Error: Cannot find module 'relay-compiler'

relay-compiler is not installed as a dependency.

fix

Run `npm install --save-dev relay-compiler`.

TypeError: scala.scalajs.js.JSON.parse is not a function

Running the generated Scala.js code in a JavaScript environment without the Scala.js runtime.

fix

Ensure the code is compiled with Scala.js and the resulting JavaScript is run in a browser or Node.js environment with the Scala.js runtime loaded.

Upgrade

Version history

0.12.4latest on npm

Audit

Dependencies

relay-compilerrequiredscala-relay-compiler generates Scala.js bindings from the output of the relay-compiler

scala-jsrequiredRuntime dependency for the generated Scala.js code

Agent activity

13 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/dispalt/relay-modern-helper ↗

packagehttps://www.npmjs.com/package/scala-relay-compiler ↗