npmpackage.info

Gathering detailed insights and metrics for eslint-plugin-relay

Other packages similar to eslint-plugin-relay

eslint-plugin-graphql

4.0.0

GraphQL ESLint plugin.

@kejistan/eslint-plugin-relay

0.0.4

Additional eslint rules about relay best practices

@typescript-eslint/eslint-plugin

8.16.0

TypeScript plugin for ESLint

eslint-plugin-react

7.37.2

React specific linting rules for ESLint

Gathering detailed insights and metrics for eslint-plugin-relay

eslint-plugin-relay

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

1.8.3

100

MIT

JavaScript

24,522,435 3.7

Installations

npm install eslint-plugin-relay

Pull Requests

Open

4

Total

116

Closed

8

Merged

104

Issues

Open

22

Total

37

Closed

15

Releases

Unable to fetch releases

Developer

relayjs

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

16.6.1

NPM Version

7.20.3 Statistics

100 Stars

256 Commits

46 Forks

20 Watching

5 Branches

30 Contributors

Updated on 23 Oct 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

24,522,435

Last day

-7.4%

21,614

Compared to previous day

Last week

114,290

Compared to previous week

Last month

21.5%

484,985

Compared to previous month

Last year

-28.2%

4,331,962

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

graphql

Dev Dependencies

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

Versions

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

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.

5

Code-Review

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

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Token-Permissions

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

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

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

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

3.7

/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