npmpackage.info

Gathering detailed insights and metrics for @kbjz/eslint-plugin-relay

@kbjz/eslint-plugin-relay - 1.9.3 | npmpackage.info

@kbjz/eslint-plugin-relay

A plugin for the code linter ESLint to lint specific details about Relay.

1.9.3

104

MIT

JavaScript

66.75 kB

4.6

Installations

npm install @kbjz/eslint-plugin-relay

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Pull Requests

Open

6

Total

123

Closed

9

Merged

108

Issues

Open

25

Total

43

Closed

18

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

relayjs

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

104 Stars

267 Commits

50 Forks

17 Watchers

5 Branches

33 Contributors

Updated on Jul 03, 2025

Maintainers

View All 33 Contributors

Package Meta Information

Latest Version

1.9.3

Package Id

@kbjz/eslint-plugin-relay@1.9.3

Unpacked Size

66.75 kB

Size

15.06 kB

File Count

Published on

Aug 18, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

graphql

Dev Dependencies

babel-eslint eslint eslint-config-prettier eslint-plugin-prettier mocha prettier

eslint-plugin-relay

eslint-plugin-relay is a plugin for ESLint to catch common problems in code using Relay early.

Install

npm i --save-dev eslint-plugin-relay

How To Use

Add "relay" to your eslint plugins section.
Add the relay rules such as "relay/graphql-syntax": "error" to your eslint rules section, see the example for all rules.

Example .eslintrc.js:

1module.exports = {
2  // Other eslint properties here
3  rules: {
4    'relay/graphql-syntax': 'error',
5    'relay/compat-uses-vars': 'warn',
6    'relay/graphql-naming': 'error',
7    'relay/generated-flow-types': 'warn',
8    'relay/must-colocate-fragment-spreads': 'warn',
9    'relay/no-future-added-value': 'warn',
10    'relay/unused-fields': 'warn',
11    'relay/function-required-argument': 'warn',
12    'relay/hook-required-argument': 'warn'
13  },
14  plugins: ['relay']
15};

You can also enable all the recommended or strict rules at once. Add plugin:relay/recommended or plugin:relay/strict in extends:

1{
2  "extends": [
3    "plugin:relay/recommended"
4  ]
5}

Suppressing rules within graphql tags

The following rules support suppression within graphql tags:

relay/unused-fields
relay/must-colocate-fragment-spreads

Supported rules can be suppressed by adding # eslint-disable-next-line relay/name-of-rule to the preceding line:

1graphql`fragment foo on Page {
2  # eslint-disable-next-line relay/must-colocate-fragment-spreads
3  ...unused1
4}`

Note that only the eslint-disable-next-line form of suppression works. eslint-disable-line doesn't currently work until graphql-js provides support for parsing Comment nodes in their AST.

Contribute

We actively welcome pull requests, learn how to contribute.

License

eslint-plugin-relay is MIT licensed.

No vulnerabilities found.

10

Binary-Artifacts

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

10

Dangerous-Workflow

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

10

License

Determines if the project has defined a license.

9

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

5

Maintained

Determines if the project is "actively maintained".

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Pinned-Dependencies

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

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

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.

Score

4.6

/10

Last Scanned on 2025-07-07

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