npmpackage.info

Gathering detailed insights and metrics for relay-compiler-language-typescript

relay-compiler-language-typescript

⛔️ Obsolete - A language plugin for Relay that adds TypeScript support, including emitting type definitions.

15.0.1

241

MIT

TypeScript

8,292,704 3.1

Installations

npm install relay-compiler-language-typescript

Pull Requests

Open

13

Total

830

Closed

354

Merged

463

Issues

Open

31

Total

132

Closed

101

Releases

v15.0.1

Published on 30 Jan 2022

v15.0.0

Published on 23 Nov 2021

v14.3.0

Published on 29 Oct 2021

v14.2.1

Published on 06 Oct 2021

v14.2.0

Published on 01 Oct 2021

v14.1.3

Published on 01 Oct 2021

View all 38 releases

Developer

relay-tools

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

14.18.3

NPM Version

6.14.15 Statistics

241 Stars

870 Commits

70 Forks

8 Watching

18 Branches

48 Contributors

Updated on 27 Jul 2024

Languages

TypeScript (82.8%)

JavaScript (9.89%)

CSS (6.74%)

HTML (0.54%)

Shell (0.02%)

Total Downloads

Cumulative downloads

Total Downloads

8,292,704

Last day

6.2%

3,373

Compared to previous day

Last week

4.5%

16,995

Compared to previous week

Last month

8.4%

70,503

Compared to previous month

Last year

-52.9%

827,269

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Obsolete

This repository is obsolete as relay@13 now supports TypeScript directly.

relay-compiler-language-typescript

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

Installation

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.

Configuration

relay-compiler

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

1{
2  "scripts": {
3    "relay":
4      "relay-compiler --src ./src --schema data/schema.graphql --language typescript --artifactDirectory ./src/__generated__"
5  }
6}

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:

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

TypeScript

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:

1{
2  "compilerOptions": {
3    "module": "ES2015", // ES2015 or higher
4    "target": "ES2020"  // best use the highest target setting compatible with your Babel setup
5  }
6}

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):

1react_relay_1.createFragmentContainer(
2  MyComponent,
3  react_relay_1.graphql`
4  ...
5`
6);

… 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.

Custom Headers

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:

1{
2  "compilerOptions": {
3    "banner": "/* &copy; 2021 Example.org - @generated code */"
4  }
5}

Problems

React Hot Loader

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.

Also see

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.
There are Relay tslint rules available here.

License

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

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.1

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

relay-compiler-language-typescript

Installations

Pull Requests

13

830

354

463

Issues

31

132

101

Releases

Developer

relay-tools

Developer Guide

CommonJS

Yes

14.18.3

6.14.15

Statistics

Languages

Total Downloads

8,292,704

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Obsolete

relay-compiler-language-typescript

Installation

Configuration

relay-compiler

TypeScript

Custom Headers

Problems

React Hot Loader

Also see

License

10

10

10

0

0

0

0

0

0

0

0

3.1

/10