Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme for validators with Rule prefix introduced in graphql@15 #281

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 30 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ module.exports = {
tagName: 'FirstGQL',
schemaJson: require('./schema-first.json')
}, {
validators: ['FieldsOnCorrectType'],
validators: ['FieldsOnCorrectTypeRule'],
tagName: 'SecondGQL',
schemaJson: require('./schema-second.json')
}]
Expand All @@ -329,33 +329,35 @@ module.exports = {
```

The full list of available validators is:
- `ExecutableDefinitions`
- `FieldsOnCorrectType`
- `FragmentsOnCompositeTypes`
- `KnownArgumentNames`
- `KnownDirectives` (*disabled by default in `relay`*)
- `KnownFragmentNames` (*disabled by default in all envs*)
- `KnownTypeNames`
- `LoneAnonymousOperation`
- `NoFragmentCycles`
- `NoUndefinedVariables` (*disabled by default in `relay`*)
- `NoUnusedFragments` (*disabled by default in all envs*)
- `NoUnusedVariables`
- `OverlappingFieldsCanBeMerged`
- `PossibleFragmentSpreads`
- `ProvidedRequiredArguments` (*disabled by default in `relay`*)
- `ScalarLeafs` (*disabled by default in `relay`*)
- `SingleFieldSubscriptions`
- `UniqueArgumentNames`
- `UniqueDirectivesPerLocation`
- `UniqueFragmentNames`
- `UniqueInputFieldNames`
- `UniqueOperationNames`
- `UniqueVariableNames`
- `ValuesOfCorrectType`
- `VariablesAreInputTypes`
- `VariablesDefaultValueAllowed`
- `VariablesInAllowedPosition`
- `ExecutableDefinitionsRule`
- `FieldsOnCorrectTypeRule`
- `FragmentsOnCompositeTypesRule`
- `KnownArgumentNamesRule`
- `KnownDirectivesRule` (*disabled by default in `relay`*)
- `KnownFragmentNamesRule` (*disabled by default in all envs*)
- `KnownTypeNamesRule`
- `LoneAnonymousOperationRule`
- `NoFragmentCyclesRule`
- `NoUndefinedVariablesRule` (*disabled by default in `relay`*)
- `NoUnusedFragmentsRule` (*disabled by default in all envs*)
- `NoUnusedVariablesRule`
- `OverlappingFieldsCanBeMergedRule`
- `PossibleFragmentSpreadsRule`
- `ProvidedRequiredArgumentsRule` (*disabled by default in `relay`*)
- `ScalarLeafsRule` (*disabled by default in `relay`*)
- `SingleFieldSubscriptionsRule`
- `UniqueArgumentNamesRule`
- `UniqueDirectivesPerLocationRule`
- `UniqueFragmentNamesRule`
- `UniqueInputFieldNamesRule`
- `UniqueOperationNamesRule`
- `UniqueVariableNamesRule`
- `ValuesOfCorrectTypeRule`
- `VariablesAreInputTypesRule`
- `VariablesInAllowedPositionRule`

##### Note
If you're using a version of graphql less than v15, you should remove the validators `Rule` suffix

### Named Operations Validation Rule

Expand Down