@graphql-eslint/eslint-plugin 3.8.0-alpha-8ddf2a4.0 → 3.9.0

package/README.md

@@ -9,7 +9,7 @@ This project integrates GraphQL and ESLint, for a better developer experience.
 ## Key Features
 
 - 🚀 Integrates with ESLint core (as a ESTree parser)
-- 🚀 Works on `.graphql` files, `gql` usages and `/* GraphQL */` magic comments
+- 🚀 Works on `.graphql` files, `gql` usages and `/* GraphQL */` magic comments
 - 🚀 Lints both GraphQL schema and GraphQL operations
 - 🚀 Extended type info for more advanced usages
 - 🚀 Supports ESLint directives (for example: `eslint-disable-next-line`)
@@ -189,10 +189,10 @@ See [docs/deprecated-rules.md](docs/deprecated-rules.md).
 <!-- prettier-ignore-start -->
 |Name|Description|
 |:-:|-|
-|[`schema-recommended`](packages/plugin/src/configs/schema-recommended.ts)|enables recommended rules for schema (SDL) development|
-|[`schema-all`](packages/plugin/src/configs/schema-all.ts)|enables all rules for schema (SDL) development, except for those that require `parserOptions.operations` option|
-|[`operations-recommended`](packages/plugin/src/configs/operations-recommended.ts) |enables recommended rules for consuming GraphQL (operations) development|
-|[`operations-all`](packages/plugin/src/configs/operations-all.ts)|enables all rules for consuming GraphQL (operations) development|
+|[`schema-recommended`](packages/plugin/src/configs/schema-recommended.json)|enables recommended rules for schema (SDL) development|
+|[`schema-all`](packages/plugin/src/configs/schema-all.json)|enables all rules for schema (SDL) development, except for those that require `parserOptions.operations` option|
+|[`operations-recommended`](packages/plugin/src/configs/operations-recommended.json) |enables recommended rules for consuming GraphQL (operations) development|
+|[`operations-all`](packages/plugin/src/configs/operations-all.json)|enables all rules for consuming GraphQL (operations) development|
 <!-- prettier-ignore-end -->
 
 > If you are in a project that develops the GraphQL schema, you'll need `schema` rules. 

package/configs/base.json

@@ -0,0 +1,4 @@
+{
+  "parser": "@graphql-eslint/eslint-plugin",
+  "plugins": ["@graphql-eslint"]
+}

package/configs/operations-all.json

@@ -0,0 +1,24 @@
+{
+  "extends": ["./base.json", "./operations-recommended.json"],
+  "rules": {
+    "@graphql-eslint/alphabetize": [
+      "error",
+      {
+        "selections": ["OperationDefinition", "FragmentDefinition"],
+        "variables": ["OperationDefinition"],
+        "arguments": ["Field", "Directive"]
+      }
+    ],
+    "@graphql-eslint/match-document-filename": [
+      "error",
+      {
+        "query": "kebab-case",
+        "mutation": "kebab-case",
+        "subscription": "kebab-case",
+        "fragment": "kebab-case"
+      }
+    ],
+    "@graphql-eslint/unique-fragment-name": "error",
+    "@graphql-eslint/unique-operation-name": "error"
+  }
+}

package/configs/operations-recommended.json

@@ -0,0 +1,50 @@
+{
+  "extends": "./base.json",
+  "rules": {
+    "@graphql-eslint/executable-definitions": "error",
+    "@graphql-eslint/fields-on-correct-type": "error",
+    "@graphql-eslint/fragments-on-composite-type": "error",
+    "@graphql-eslint/known-argument-names": "error",
+    "@graphql-eslint/known-directives": "error",
+    "@graphql-eslint/known-fragment-names": "error",
+    "@graphql-eslint/known-type-names": "error",
+    "@graphql-eslint/lone-anonymous-operation": "error",
+    "@graphql-eslint/naming-convention": [
+      "error",
+      {
+        "VariableDefinition": "camelCase",
+        "OperationDefinition": {
+          "style": "PascalCase",
+          "forbiddenPrefixes": ["Query", "Mutation", "Subscription", "Get"],
+          "forbiddenSuffixes": ["Query", "Mutation", "Subscription"]
+        },
+        "FragmentDefinition": {
+          "style": "PascalCase",
+          "forbiddenPrefixes": ["Fragment"],
+          "forbiddenSuffixes": ["Fragment"]
+        }
+      }
+    ],
+    "@graphql-eslint/no-anonymous-operations": "error",
+    "@graphql-eslint/no-deprecated": "error",
+    "@graphql-eslint/no-duplicate-fields": "error",
+    "@graphql-eslint/no-fragment-cycles": "error",
+    "@graphql-eslint/no-undefined-variables": "error",
+    "@graphql-eslint/no-unused-fragments": "error",
+    "@graphql-eslint/no-unused-variables": "error",
+    "@graphql-eslint/one-field-subscriptions": "error",
+    "@graphql-eslint/overlapping-fields-can-be-merged": "error",
+    "@graphql-eslint/possible-fragment-spread": "error",
+    "@graphql-eslint/provided-required-arguments": "error",
+    "@graphql-eslint/require-id-when-available": "error",
+    "@graphql-eslint/scalar-leafs": "error",
+    "@graphql-eslint/selection-set-depth": ["error", { "maxDepth": 7 }],
+    "@graphql-eslint/unique-argument-names": "error",
+    "@graphql-eslint/unique-directive-names-per-location": "error",
+    "@graphql-eslint/unique-input-field-names": "error",
+    "@graphql-eslint/unique-variable-names": "error",
+    "@graphql-eslint/value-literals-of-correct-type": "error",
+    "@graphql-eslint/variables-are-input-types": "error",
+    "@graphql-eslint/variables-in-allowed-position": "error"
+  }
+}

package/configs/schema-all.json

@@ -0,0 +1,26 @@
+{
+  "extends": ["./base.json", "./schema-recommended.json"],
+  "rules": {
+    "@graphql-eslint/alphabetize": [
+      "error",
+      {
+        "fields": [
+          "ObjectTypeDefinition",
+          "InterfaceTypeDefinition",
+          "InputObjectTypeDefinition"
+        ],
+        "values": ["EnumTypeDefinition"],
+        "arguments": [
+          "FieldDefinition",
+          "Field",
+          "DirectiveDefinition",
+          "Directive"
+        ]
+      }
+    ],
+    "@graphql-eslint/input-name": "error",
+    "@graphql-eslint/no-scalar-result-type-on-mutation": "error",
+    "@graphql-eslint/require-deprecation-date": "error",
+    "@graphql-eslint/require-field-of-type-query-in-mutation-result": "error"
+  }
+}

package/configs/schema-recommended.json

@@ -0,0 +1,49 @@
+{
+  "extends": "./base.json",
+  "rules": {
+    "@graphql-eslint/description-style": "error",
+    "@graphql-eslint/known-argument-names": "error",
+    "@graphql-eslint/known-directives": "error",
+    "@graphql-eslint/known-type-names": "error",
+    "@graphql-eslint/lone-schema-definition": "error",
+    "@graphql-eslint/naming-convention": [
+      "error",
+      {
+        "types": "PascalCase",
+        "FieldDefinition": "camelCase",
+        "InputValueDefinition": "camelCase",
+        "Argument": "camelCase",
+        "DirectiveDefinition": "camelCase",
+        "EnumValueDefinition": "UPPER_CASE",
+        "FieldDefinition[parent.name.value=Query]": {
+          "forbiddenPrefixes": ["query", "get"],
+          "forbiddenSuffixes": ["Query"]
+        },
+        "FieldDefinition[parent.name.value=Mutation]": {
+          "forbiddenPrefixes": ["mutation"],
+          "forbiddenSuffixes": ["Mutation"]
+        },
+        "FieldDefinition[parent.name.value=Subscription]": {
+          "forbiddenPrefixes": ["subscription"],
+          "forbiddenSuffixes": ["Subscription"]
+        }
+      }
+    ],
+    "@graphql-eslint/no-case-insensitive-enum-values-duplicates": "error",
+    "@graphql-eslint/no-hashtag-description": "error",
+    "@graphql-eslint/no-typename-prefix": "error",
+    "@graphql-eslint/no-unreachable-types": "error",
+    "@graphql-eslint/provided-required-arguments": "error",
+    "@graphql-eslint/require-deprecation-reason": "error",
+    "@graphql-eslint/require-description": [
+      "error",
+      { "types": true, "DirectiveDefinition": true }
+    ],
+    "@graphql-eslint/strict-id-in-types": "error",
+    "@graphql-eslint/unique-directive-names": "error",
+    "@graphql-eslint/unique-directive-names-per-location": "error",
+    "@graphql-eslint/unique-field-definition-names": "error",
+    "@graphql-eslint/unique-operation-types": "error",
+    "@graphql-eslint/unique-type-names": "error"
+  }
+}

package/docs/README.md

@@ -4,66 +4,68 @@ Each rule has emojis denoting:
 
 - 🚀 `graphql-eslint` rule
 - 🔮 `graphql-js` rule
+- 🔧 if some problems reported by the rule are automatically fixable by the `--fix` [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) option
+- 💡 if some problems reported by the rule are manually fixable by editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
 
 <!-- 🚨 IMPORTANT! Do not manually modify this table. Run: `yarn generate:docs` -->
 <!-- prettier-ignore-start -->
-Name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|Description|&nbsp;&nbsp;&nbsp;&nbsp;Config&nbsp;&nbsp;&nbsp;&nbsp;|🚀&nbsp;/&nbsp;🔮
--|-|:-:|:-:
-[alphabetize](rules/alphabetize.md)|Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.|![all][]|🚀
-[description-style](rules/description-style.md)|Require all comments to follow the same style (either block or inline).|![recommended][]|🚀
-[executable-definitions](rules/executable-definitions.md)|A GraphQL document is only valid for execution if all definitions are either operation or fragment definitions.|![recommended][]|🔮
-[fields-on-correct-type](rules/fields-on-correct-type.md)|A GraphQL document is only valid if all fields selected are defined by the parent type, or are an allowed meta field such as `__typename`.|![recommended][]|🔮
-[fragments-on-composite-type](rules/fragments-on-composite-type.md)|Fragments use a type condition to determine if they apply, since fragments can only be spread into a composite type (object, interface, or union), the type condition must also be a composite type.|![recommended][]|🔮
-[input-name](rules/input-name.md)|Require mutation argument to be always called "input" and input type to be called Mutation name + "Input".|![all][]|🚀
-[known-argument-names](rules/known-argument-names.md)|A GraphQL field is only valid if all supplied arguments are defined by that field.|![recommended][]|🔮
-[known-directives](rules/known-directives.md)|A GraphQL document is only valid if all `@directives` are known by the schema and legally positioned.|![recommended][]|🔮
-[known-fragment-names](rules/known-fragment-names.md)|A GraphQL document is only valid if all `...Fragment` fragment spreads refer to fragments defined in the same document.|![recommended][]|🔮
-[known-type-names](rules/known-type-names.md)|A GraphQL document is only valid if referenced types (specifically variable definitions and fragment conditions) are defined by the type schema.|![recommended][]|🔮
-[lone-anonymous-operation](rules/lone-anonymous-operation.md)|A GraphQL document is only valid if when it contains an anonymous operation (the query short-hand) that it contains only that one operation definition.|![recommended][]|🔮
-[lone-schema-definition](rules/lone-schema-definition.md)|A GraphQL document is only valid if it contains only one schema definition.|![recommended][]|🔮
-[match-document-filename](rules/match-document-filename.md)|This rule allows you to enforce that the file name should match the operation name.|![all][]|🚀
-[naming-convention](rules/naming-convention.md)|Require names to follow specified conventions.|![recommended][]|🚀
-[no-anonymous-operations](rules/no-anonymous-operations.md)|Require name for your GraphQL operations. This is useful since most GraphQL client libraries are using the operation name for caching purposes.|![recommended][]|🚀
-[no-case-insensitive-enum-values-duplicates](rules/no-case-insensitive-enum-values-duplicates.md)|Disallow case-insensitive enum values duplicates.|![recommended][]|🚀
-[no-deprecated](rules/no-deprecated.md)|Enforce that deprecated fields or enum values are not in use by operations.|![recommended][]|🚀
-[no-duplicate-fields](rules/no-duplicate-fields.md)|Checks for duplicate fields in selection set, variables in operation definition, or in arguments set of a field.|![recommended][]|🚀
-[no-fragment-cycles](rules/no-fragment-cycles.md)|A GraphQL fragment is only valid when it does not have cycles in fragments usage.|![recommended][]|🔮
-[no-hashtag-description](rules/no-hashtag-description.md)|Requires to use `"""` or `"` for adding a GraphQL description instead of `#`.|![recommended][]|🚀
-[no-root-type](rules/no-root-type.md)|Disallow using root types `mutation` and/or `subscription`.||🚀
-[no-scalar-result-type-on-mutation](rules/no-scalar-result-type-on-mutation.md)|Avoid scalar result type on mutation type to make sure to return a valid state.|![all][]|🚀
-[no-typename-prefix](rules/no-typename-prefix.md)|Enforces users to avoid using the type name in a field name while defining your schema.|![recommended][]|🚀
-[no-undefined-variables](rules/no-undefined-variables.md)|A GraphQL operation is only valid if all variables encountered, both directly and via fragment spreads, are defined by that operation.|![recommended][]|🔮
-[no-unreachable-types](rules/no-unreachable-types.md)|Requires all types to be reachable at some level by root level fields.|![recommended][]|🚀
-[no-unused-fields](rules/no-unused-fields.md)|Requires all fields to be used at some level by siblings operations.||🚀
-[no-unused-fragments](rules/no-unused-fragments.md)|A GraphQL document is only valid if all fragment definitions are spread within operations, or spread within other fragments spread within operations.|![recommended][]|🔮
-[no-unused-variables](rules/no-unused-variables.md)|A GraphQL operation is only valid if all variables defined by an operation are used, either directly or within a spread fragment.|![recommended][]|🔮
-[one-field-subscriptions](rules/one-field-subscriptions.md)|A GraphQL subscription is valid only if it contains a single root field.|![recommended][]|🔮
-[overlapping-fields-can-be-merged](rules/overlapping-fields-can-be-merged.md)|A selection set is only valid if all fields (including spreading any fragments) either correspond to distinct response names or can be merged without ambiguity.|![recommended][]|🔮
-[possible-fragment-spread](rules/possible-fragment-spread.md)|A fragment spread is only valid if the type condition could ever possibly be true: if there is a non-empty intersection of the possible parent types, and possible types which pass the type condition.|![recommended][]|🔮
-[possible-type-extension](rules/possible-type-extension.md)|A type extension is only valid if the type is defined and has the same kind.||🔮
-[provided-required-arguments](rules/provided-required-arguments.md)|A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.|![recommended][]|🔮
-[require-deprecation-date](rules/require-deprecation-date.md)|Require deletion date on `@deprecated` directive. Suggest removing deprecated things after deprecated date.|![all][]|🚀
-[require-deprecation-reason](rules/require-deprecation-reason.md)|Require all deprecation directives to specify a reason.|![recommended][]|🚀
-[require-description](rules/require-description.md)|Enforce descriptions in type definitions and operations.|![recommended][]|🚀
-[require-field-of-type-query-in-mutation-result](rules/require-field-of-type-query-in-mutation-result.md)|Allow the client in one round-trip not only to call mutation but also to get a wagon of data to update their application.|![all][]|🚀
-[require-id-when-available](rules/require-id-when-available.md)|Enforce selecting specific fields when they are available on the GraphQL type.|![recommended][]|🚀
-[scalar-leafs](rules/scalar-leafs.md)|A GraphQL document is valid only if all leaf fields (fields without sub selections) are of scalar or enum types.|![recommended][]|🔮
-[selection-set-depth](rules/selection-set-depth.md)|Limit the complexity of the GraphQL operations solely by their depth. Based on [graphql-depth-limit](https://github.com/stems/graphql-depth-limit).|![recommended][]|🚀
-[strict-id-in-types](rules/strict-id-in-types.md)|Requires output types to have one unique identifier unless they do not have a logical one. Exceptions can be used to ignore output types that do not have unique identifiers.|![recommended][]|🚀
-[unique-argument-names](rules/unique-argument-names.md)|A GraphQL field or directive is only valid if all supplied arguments are uniquely named.|![recommended][]|🔮
-[unique-directive-names](rules/unique-directive-names.md)|A GraphQL document is only valid if all defined directives have unique names.|![recommended][]|🔮
-[unique-directive-names-per-location](rules/unique-directive-names-per-location.md)|A GraphQL document is only valid if all non-repeatable directives at a given location are uniquely named.|![recommended][]|🔮
-[unique-enum-value-names](rules/unique-enum-value-names.md)|A GraphQL enum type is only valid if all its values are uniquely named.||🔮
-[unique-field-definition-names](rules/unique-field-definition-names.md)|A GraphQL complex type is only valid if all its fields are uniquely named.|![recommended][]|🔮
-[unique-fragment-name](rules/unique-fragment-name.md)|Enforce unique fragment names across your project.|![all][]|🚀
-[unique-input-field-names](rules/unique-input-field-names.md)|A GraphQL input object value is only valid if all supplied fields are uniquely named.|![recommended][]|🔮
-[unique-operation-name](rules/unique-operation-name.md)|Enforce unique operation names across your project.|![all][]|🚀
-[unique-operation-types](rules/unique-operation-types.md)|A GraphQL document is only valid if it has only one type per operation.|![recommended][]|🔮
-[unique-type-names](rules/unique-type-names.md)|A GraphQL document is only valid if all defined types have unique names.|![recommended][]|🔮
-[unique-variable-names](rules/unique-variable-names.md)|A GraphQL operation is only valid if all its variables are uniquely named.|![recommended][]|🔮
-[value-literals-of-correct-type](rules/value-literals-of-correct-type.md)|A GraphQL document is only valid if all value literals are of the type expected at their position.|![recommended][]|🔮
-[variables-are-input-types](rules/variables-are-input-types.md)|A GraphQL operation is only valid if all the variables it defines are of input types (scalar, enum, or input object).|![recommended][]|🔮
-[variables-in-allowed-position](rules/variables-in-allowed-position.md)|Variables passed to field arguments conform to type.|![recommended][]|🔮
+Name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|Description|&nbsp;&nbsp;&nbsp;&nbsp;Config&nbsp;&nbsp;&nbsp;&nbsp;|🚀&nbsp;/&nbsp;🔮|🔧&nbsp;/&nbsp;💡
+-|-|:-:|:-:|:-:
+[alphabetize](rules/alphabetize.md)|Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.|![all][]|🚀|🔧
+[description-style](rules/description-style.md)|Require all comments to follow the same style (either block or inline).|![recommended][]|🚀|💡
+[executable-definitions](rules/executable-definitions.md)|A GraphQL document is only valid for execution if all definitions are either operation or fragment definitions.|![recommended][]|🔮|
+[fields-on-correct-type](rules/fields-on-correct-type.md)|A GraphQL document is only valid if all fields selected are defined by the parent type, or are an allowed meta field such as `__typename`.|![recommended][]|🔮|
+[fragments-on-composite-type](rules/fragments-on-composite-type.md)|Fragments use a type condition to determine if they apply, since fragments can only be spread into a composite type (object, interface, or union), the type condition must also be a composite type.|![recommended][]|🔮|
+[input-name](rules/input-name.md)|Require mutation argument to be always called "input" and input type to be called Mutation name + "Input".|![all][]|🚀|💡
+[known-argument-names](rules/known-argument-names.md)|A GraphQL field is only valid if all supplied arguments are defined by that field.|![recommended][]|🔮|
+[known-directives](rules/known-directives.md)|A GraphQL document is only valid if all `@directive`s are known by the schema and legally positioned.|![recommended][]|🔮|
+[known-fragment-names](rules/known-fragment-names.md)|A GraphQL document is only valid if all `...Fragment` fragment spreads refer to fragments defined in the same document.|![recommended][]|🔮|
+[known-type-names](rules/known-type-names.md)|A GraphQL document is only valid if referenced types (specifically variable definitions and fragment conditions) are defined by the type schema.|![recommended][]|🔮|
+[lone-anonymous-operation](rules/lone-anonymous-operation.md)|A GraphQL document is only valid if when it contains an anonymous operation (the query short-hand) that it contains only that one operation definition.|![recommended][]|🔮|
+[lone-schema-definition](rules/lone-schema-definition.md)|A GraphQL document is only valid if it contains only one schema definition.|![recommended][]|🔮|
+[match-document-filename](rules/match-document-filename.md)|This rule allows you to enforce that the file name should match the operation name.|![all][]|🚀|
+[naming-convention](rules/naming-convention.md)|Require names to follow specified conventions.|![recommended][]|🚀|💡
+[no-anonymous-operations](rules/no-anonymous-operations.md)|Require name for your GraphQL operations. This is useful since most GraphQL client libraries are using the operation name for caching purposes.|![recommended][]|🚀|💡
+[no-case-insensitive-enum-values-duplicates](rules/no-case-insensitive-enum-values-duplicates.md)|Disallow case-insensitive enum values duplicates.|![recommended][]|🚀|💡
+[no-deprecated](rules/no-deprecated.md)|Enforce that deprecated fields or enum values are not in use by operations.|![recommended][]|🚀|💡
+[no-duplicate-fields](rules/no-duplicate-fields.md)|Checks for duplicate fields in selection set, variables in operation definition, or in arguments set of a field.|![recommended][]|🚀|💡
+[no-fragment-cycles](rules/no-fragment-cycles.md)|A GraphQL fragment is only valid when it does not have cycles in fragments usage.|![recommended][]|🔮|
+[no-hashtag-description](rules/no-hashtag-description.md)|Requires to use `"""` or `"` for adding a GraphQL description instead of `#`.|![recommended][]|🚀|💡
+[no-root-type](rules/no-root-type.md)|Disallow using root types `mutation` and/or `subscription`.||🚀|💡
+[no-scalar-result-type-on-mutation](rules/no-scalar-result-type-on-mutation.md)|Avoid scalar result type on mutation type to make sure to return a valid state.|![all][]|🚀|💡
+[no-typename-prefix](rules/no-typename-prefix.md)|Enforces users to avoid using the type name in a field name while defining your schema.|![recommended][]|🚀|💡
+[no-undefined-variables](rules/no-undefined-variables.md)|A GraphQL operation is only valid if all variables encountered, both directly and via fragment spreads, are defined by that operation.|![recommended][]|🔮|
+[no-unreachable-types](rules/no-unreachable-types.md)|Requires all types to be reachable at some level by root level fields.|![recommended][]|🚀|💡
+[no-unused-fields](rules/no-unused-fields.md)|Requires all fields to be used at some level by siblings operations.||🚀|💡
+[no-unused-fragments](rules/no-unused-fragments.md)|A GraphQL document is only valid if all fragment definitions are spread within operations, or spread within other fragments spread within operations.|![recommended][]|🔮|
+[no-unused-variables](rules/no-unused-variables.md)|A GraphQL operation is only valid if all variables defined by an operation are used, either directly or within a spread fragment.|![recommended][]|🔮|
+[one-field-subscriptions](rules/one-field-subscriptions.md)|A GraphQL subscription is valid only if it contains a single root field.|![recommended][]|🔮|
+[overlapping-fields-can-be-merged](rules/overlapping-fields-can-be-merged.md)|A selection set is only valid if all fields (including spreading any fragments) either correspond to distinct response names or can be merged without ambiguity.|![recommended][]|🔮|
+[possible-fragment-spread](rules/possible-fragment-spread.md)|A fragment spread is only valid if the type condition could ever possibly be true: if there is a non-empty intersection of the possible parent types, and possible types which pass the type condition.|![recommended][]|🔮|
+[possible-type-extension](rules/possible-type-extension.md)|A type extension is only valid if the type is defined and has the same kind.||🔮|
+[provided-required-arguments](rules/provided-required-arguments.md)|A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.|![recommended][]|🔮|
+[require-deprecation-date](rules/require-deprecation-date.md)|Require deletion date on `@deprecated` directive. Suggest removing deprecated things after deprecated date.|![all][]|🚀|💡
+[require-deprecation-reason](rules/require-deprecation-reason.md)|Require all deprecation directives to specify a reason.|![recommended][]|🚀|
+[require-description](rules/require-description.md)|Enforce descriptions in type definitions and operations.|![recommended][]|🚀|
+[require-field-of-type-query-in-mutation-result](rules/require-field-of-type-query-in-mutation-result.md)|Allow the client in one round-trip not only to call mutation but also to get a wagon of data to update their application.|![all][]|🚀|
+[require-id-when-available](rules/require-id-when-available.md)|Enforce selecting specific fields when they are available on the GraphQL type.|![recommended][]|🚀|💡
+[scalar-leafs](rules/scalar-leafs.md)|A GraphQL document is valid only if all leaf fields (fields without sub selections) are of scalar or enum types.|![recommended][]|🔮|
+[selection-set-depth](rules/selection-set-depth.md)|Limit the complexity of the GraphQL operations solely by their depth. Based on [graphql-depth-limit](https://github.com/stems/graphql-depth-limit).|![recommended][]|🚀|💡
+[strict-id-in-types](rules/strict-id-in-types.md)|Requires output types to have one unique identifier unless they do not have a logical one. Exceptions can be used to ignore output types that do not have unique identifiers.|![recommended][]|🚀|
+[unique-argument-names](rules/unique-argument-names.md)|A GraphQL field or directive is only valid if all supplied arguments are uniquely named.|![recommended][]|🔮|
+[unique-directive-names](rules/unique-directive-names.md)|A GraphQL document is only valid if all defined directives have unique names.|![recommended][]|🔮|
+[unique-directive-names-per-location](rules/unique-directive-names-per-location.md)|A GraphQL document is only valid if all non-repeatable directives at a given location are uniquely named.|![recommended][]|🔮|
+[unique-enum-value-names](rules/unique-enum-value-names.md)|A GraphQL enum type is only valid if all its values are uniquely named.||🔮|
+[unique-field-definition-names](rules/unique-field-definition-names.md)|A GraphQL complex type is only valid if all its fields are uniquely named.|![recommended][]|🔮|
+[unique-fragment-name](rules/unique-fragment-name.md)|Enforce unique fragment names across your project.|![all][]|🚀|
+[unique-input-field-names](rules/unique-input-field-names.md)|A GraphQL input object value is only valid if all supplied fields are uniquely named.|![recommended][]|🔮|
+[unique-operation-name](rules/unique-operation-name.md)|Enforce unique operation names across your project.|![all][]|🚀|
+[unique-operation-types](rules/unique-operation-types.md)|A GraphQL document is only valid if it has only one type per operation.|![recommended][]|🔮|
+[unique-type-names](rules/unique-type-names.md)|A GraphQL document is only valid if all defined types have unique names.|![recommended][]|🔮|
+[unique-variable-names](rules/unique-variable-names.md)|A GraphQL operation is only valid if all its variables are uniquely named.|![recommended][]|🔮|
+[value-literals-of-correct-type](rules/value-literals-of-correct-type.md)|A GraphQL document is only valid if all value literals are of the type expected at their position.|![recommended][]|🔮|
+[variables-are-input-types](rules/variables-are-input-types.md)|A GraphQL operation is only valid if all the variables it defines are of input types (scalar, enum, or input object).|![recommended][]|🔮|
+[variables-in-allowed-position](rules/variables-in-allowed-position.md)|Variables passed to field arguments conform to type.|![recommended][]|🔮|
 <!-- prettier-ignore-end -->
 [recommended]: https://img.shields.io/badge/-recommended-green.svg
 [all]: https://img.shields.io/badge/-all-blue.svg

package/docs/custom-rules.md

@@ -2,7 +2,7 @@
 
 To get started with your own rules, start by understanding how [ESLint custom rules works](https://eslint.org/docs/developer-guide/working-with-rules).
 
-`graphql-eslint` converts the [GraphQL AST](https://graphql.org/graphql-js/language/) into [ESTree structure](https://github.com/estree/estree), so it allows you to easily travel the GraphQL AST tree easily.
+`graphql-eslint` converts the [GraphQL AST](https://graphql.org/graphql-js/language) into [ESTree structure](https://github.com/estree/estree), so it allows you to easily travel the GraphQL AST tree easily.
 
 You can visit any GraphQL AST node in your custom rules, and report this as error. You don't need to have special handlers for code-files, since `graphql-eslint` extracts usages of `gql` and magic `/* GraphQL */` comments automatically, and runs it through the parser, and eventually it knows to adjust errors location to fit in your code files original location.
 
@@ -10,7 +10,7 @@ You can visit any GraphQL AST node in your custom rules, and report this as erro
 
 Start by creating a [simple ESLint rule file](https://eslint.org/docs/developer-guide/working-with-rules), and choose the AST nodes you wish to visit. It can either be a [simple AST node `Kind`](https://github.com/graphql/graphql-js/blob/master/src/language/kinds.d.ts) or a complex [ESLint selector](https://eslint.org/docs/developer-guide/selectors) that allows you to travel and filter AST nodes.
 
-We recommend you to read the [graphql-eslint parser documentation](./parser.md) before getting started, to understand the differences between the AST structures.
+We recommend you to read the [graphql-eslint parser documentation](parser.md) before getting started, to understand the differences between the AST structures.
 
 The `graphql-eslint` comes with a TypeScript wrapper for ESLint rules, and provides a testkit to simplify testing process with GraphQL schemas, so you can use that by importing `GraphQLESLintRule` type. But if you wish to use JavaScript - that's fine :)
 
@@ -49,7 +49,7 @@ You can scan the `packages/plugin/src/rules` directory in this repo for referenc
 ## Accessing original GraphQL AST nodes
 
 Since our parser converts GraphQL AST to ESTree structure, there are some minor differences in the structure of the objects.
-If you are using TypeScript, and you typed your rule with `GraphQLESLintRule` - you'll see that each `node` is a bit different from the AST nodes of GraphQL (you can read more about that in [graphql-eslint parser documentation](./parser.md)).
+If you are using TypeScript, and you typed your rule with `GraphQLESLintRule` - you'll see that each `node` is a bit different from the AST nodes of GraphQL (you can read more about that in [graphql-eslint parser documentation](parser.md)).
 
 If you need access to the original GraphQL AST `node`, you can use `.rawNode()` method on each node you get from the AST structure of ESLint.
 
@@ -104,13 +104,12 @@ import { requireGraphQLSchemaFromContext } from '@graphql-eslint/eslint-plugin'
 
 export const rule = {
   create(context) {
-    requireGraphQLSchemaFromContext(context)
+    requireGraphQLSchemaFromContext('your-rule-name', context)
 
     return {
       SelectionSet(node) {
         const typeInfo = node.typeInfo()
-
-        if (typeInfo && typeInfo.gqlType) {
+        if (typeInfo.gqlType) {
           console.log(`The GraphQLOutputType is: ${typeInfo.gqlType}`)
         }
       }
@@ -119,7 +118,7 @@ export const rule = {
 }
 ```
 
-The structure of the return value of `.typeInfo()` is [defined here](https://github.com/dotansimha/graphql-eslint/blob/master/packages/plugin/src/estree-parser/converter.ts#L38-L46). So based on the `node` you are using, you'll get a different values on `.typeInfo()` result.
+The structure of the return value of `.typeInfo()` is [defined here](https://github.com/dotansimha/graphql-eslint/blob/master/packages/plugin/src/estree-parser/converter.ts#L45-L53). So based on the `node` you are using, you'll get a different values on `.typeInfo()` result.
 
 ## Testing your rules
 
@@ -141,7 +140,8 @@ ruleTester.runGraphQLTests('my-rule', rule, {
   ],
   invalid: [
     {
-      code: 'query invalid { foo }'
+      code: 'query invalid { foo }',
+      errors: [{ message: 'Your error message.' }],
     }
   ]
 })

package/docs/parser-options.md

@@ -2,13 +2,13 @@
 
 ### `graphQLParserOptions`
 
-With this configuration, you can specify custom configurations for GraphQL's `parse` method. By default, `graphql-eslint` parser just adds `noLocation: false` to make sure all parsed AST has `location` set, since we need this for tokening and for converting the GraphQL AST into ESTree.
+With this configuration, you can specify custom configurations for GraphQL's `parse` method. By default, `graphql-eslint` parser just adds `noLocation: false` to make sure all parsed AST has `location` set, since we need this for tokenizing and for converting the GraphQL AST into ESTree.
 
-You can find the [complete set of options for this object here](https://github.com/graphql/graphql-js/blob/master/src/language/parser.d.ts#L7)
+You can find the [complete set of options for this object here](https://github.com/graphql/graphql-js/blob/6e48d16f92b9a6df8638b1486354c6be2537033b/src/language/parser.ts#L73)
 
 ### `skipGraphQLConfig`
 
-If you are using [`graphql-config`](https://graphql-config.com/) in your project, the parser will automatically use that to load your default GraphQL schema.
+If you are using [`graphql-config`](https://graphql-config.com) in your project, the parser will automatically use that to load your default GraphQL schema.
 
 You can disable this behaviour using `skipGraphQLConfig: true` in the `parserOptions`:
 
@@ -82,4 +82,4 @@ If you wish to send additional configuration for the `graphql-tools` loaders tha
   }
 ```
 
-> The configuration here is flexible, and will be sent to `graphql-tools` and it's loaders. So depends on the schema source, the options may vary. [You can read more about these loaders and their configuration here](https://www.graphql-tools.com/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions).
+> The configuration here is flexible, and will be sent to `graphql-tools` and it's loaders. So depends on the schema source, the options may vary. [You can read more about these loaders and their configuration here](https://graphql-tools.com/docs/api/interfaces/loaders_graphql_file_src.GraphQLFileLoaderOptions#properties).

package/docs/parser.md

@@ -40,10 +40,10 @@ Here's a list of changes that the parser performs, in order to make the GraphQL
 
 ### Loading GraphQL Schema
 
-If you are using [`graphql-config`](https://graphql-config.com/) in your project, the parser will automatically use that to load your default GraphQL schema (you can disable this behaviour using `skipGraphQLConfig: true` in the `parserOptions`).
+If you are using [`graphql-config`](https://graphql-config.com) in your project, the parser will automatically use that to load your default GraphQL schema (you can disable this behaviour using `skipGraphQLConfig: true` in the `parserOptions`).
 
 If you are not using `graphql-config`, you can specify `parserOptions.schema` to load your GraphQL schema. The parser uses `graphql-tools` and it's loaders, that means you can either specify a URL, a path to a local `.json` (introspection) file, or a path to a local `.graphql` file(s). You can also use Glob expressions to load multiple files.
 
-[You can find more detail on the `parserOptions` config here](./parser-options.md)
+[You can find more detail on the `parserOptions` config here](parser-options.md)
 
 Providing the schema will make sure that rules that needs it will be able to access it, and it enriches every converted AST node with `typeInfo`.

package/docs/rules/alphabetize.md

@@ -97,7 +97,7 @@ The schema defines the following properties:
 
 ### `fields` (array)
 
-Fields of `type`, `interface`, and `input`
+Fields of `type`, `interface`, and `input`.
 
 The elements of the array can contain the following enum values:
 
@@ -112,7 +112,7 @@ Additional restrictions:
 
 ### `values` (array)
 
-Values of `enum`
+Values of `enum`.
 
 The elements of the array can contain the following enum values:
 
@@ -125,7 +125,7 @@ Additional restrictions:
 
 ### `selections` (array)
 
-Selections of operations (`query`, `mutation` and `subscription`) and `fragment`
+Selections of `fragment` and operations `query`, `mutation` and `subscription`.
 
 The elements of the array can contain the following enum values:
 
@@ -139,7 +139,7 @@ Additional restrictions:
 
 ### `variables` (array)
 
-Variables of operations (`query`, `mutation` and `subscription`)
+Variables of operations `query`, `mutation` and `subscription`.
 
 The elements of the array can contain the following enum values:
 
@@ -152,7 +152,7 @@ Additional restrictions:
 
 ### `arguments` (array)
 
-Arguments of fields and directives
+Arguments of fields and directives.
 
 The elements of the array can contain the following enum values:
 
@@ -166,6 +166,12 @@ Additional restrictions:
 * Minimum items: `1`
 * Unique items: `true`
 
+### `definitions` (boolean)
+
+Definitions – `type`, `interface`, `enum`, `scalar`, `input`, `union` and `directive`.
+
+Default: `false`
+
 ## Resources
 
 - [Rule source](../../packages/plugin/src/rules/alphabetize.ts)

package/docs/rules/description-style.md

@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Schema`
 - Rule name: `@graphql-eslint/description-style`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

package/docs/rules/executable-definitions.md

@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid for execution if all definitions are either operation or fragment definitions.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/ExecutableDefinitionsRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/fields-on-correct-type.md

@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if all fields selected are defined by the parent type, or are an allowed meta field such as `__typename`.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/FieldsOnCorrectTypeRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/fragments-on-composite-type.md

@@ -9,7 +9,7 @@
 
 Fragments use a type condition to determine if they apply, since fragments can only be spread into a composite type (object, interface, or union), the type condition must also be a composite type.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/FragmentsOnCompositeTypesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/input-name.md

@@ -1,5 +1,7 @@
 # `input-name`
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Schema`
 - Rule name: `@graphql-eslint/input-name`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

package/docs/rules/known-argument-names.md

@@ -9,7 +9,7 @@
 
 A GraphQL field is only valid if all supplied arguments are defined by that field.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownArgumentNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/known-directives.md

@@ -7,9 +7,36 @@
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
 
-A GraphQL document is only valid if all `@directives` are known by the schema and legally positioned.
+A GraphQL document is only valid if all `@directive`s are known by the schema and legally positioned.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownDirectivesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
+
+## Usage Examples
+
+### Valid
+
+```graphql
+# eslint @graphql-eslint/known-directives: ['error', { ignoreClientDirectives: ['client'] }]
+
+{
+  product {
+    someClientField @client
+  }
+}
+```
+
+## Config Schema
+
+The schema defines the following properties:
+
+### `ignoreClientDirectives` (array, required)
+
+The object is an array with all elements of the type `string`.
+
+Additional restrictions:
+
+* Minimum items: `1`
+* Unique items: `true`
 
 ## Resources
 

package/docs/rules/known-fragment-names.md

@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if all `...Fragment` fragment spreads refer to fragments defined in the same document.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownFragmentNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Usage Examples
 

package/docs/rules/known-type-names.md

@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if referenced types (specifically variable definitions and fragment conditions) are defined by the type schema.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownTypeNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/lone-anonymous-operation.md

@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if when it contains an anonymous operation (the query short-hand) that it contains only that one operation definition.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/LoneAnonymousOperationRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources