mirror of
https://github.com/JamesIves/github-pages-deploy-action.git
synced 2023-12-15 20:03:39 +08:00
49 lines
1.4 KiB
Markdown
49 lines
1.4 KiB
Markdown
# eslint-plugin-relay [](https://travis-ci.org/relayjs/eslint-plugin-relay) [](http://badge.fury.io/js/eslint-plugin-relay)
|
|
|
|
`eslint-plugin-relay` is a plugin for [ESLint](http://eslint.org/) to catch common problems in code using [Relay](https://facebook.github.io/relay/) early.
|
|
|
|
## Install
|
|
|
|
`npm i --save-dev eslint-plugin-relay`
|
|
|
|
## How To Use
|
|
|
|
1. Add `"relay"` to your eslint `plugins` section.
|
|
2. Add the relay rules such as `"relay/graphql-syntax": "error"` to your eslint `rules` section, see the example for all rules.
|
|
|
|
Example .eslintrc.js:
|
|
|
|
```js
|
|
module.exports = {
|
|
// Other eslint properties here
|
|
rules: {
|
|
'relay/graphql-syntax': 'error',
|
|
'relay/compat-uses-vars': 'warn',
|
|
'relay/graphql-naming': 'error',
|
|
'relay/generated-flow-types': 'warn',
|
|
'relay/no-future-added-value': 'warn',
|
|
'relay/unused-fields': 'warn'
|
|
},
|
|
plugins: ['relay']
|
|
};
|
|
```
|
|
|
|
You can also enable all the recommended or strict rules at once.
|
|
Add `plugin:relay/recommended` or `plugin:relay/strict` in `extends`:
|
|
|
|
```js
|
|
{
|
|
"extends": [
|
|
"plugin:relay/recommended"
|
|
]
|
|
}
|
|
```
|
|
|
|
## Contribute
|
|
|
|
We actively welcome pull requests, learn how to [contribute](./CONTRIBUTING.md).
|
|
|
|
## License
|
|
|
|
`eslint-plugin-relay` is [MIT licensed](./LICENSE).
|