@graphql-eslint/eslint-plugin 2.1.0-alpha-b4cd82d.0 → 2.3.0-alpha-6ba4002.0

package/README.md

@@ -32,13 +32,13 @@ This project integrates GraphQL and ESLint, for a better developer experience.
 
 Start by installing the plugin package, which includes everything you need:
 
-```
+```sh
 yarn add -D @graphql-eslint/eslint-plugin
 ```
 
 Or, with NPM:
 
-```
+```sh
 npm install --save-dev @graphql-eslint/eslint-plugin
 ```
 
@@ -46,8 +46,6 @@ npm install --save-dev @graphql-eslint/eslint-plugin
 
 ### Configuration
 
-> Note: This plugin doesn't activate any rule by default at the moment, we are currently thinking of the right rules to be the "recommended" and the default set. Until then, please make sure to active rules based on your needs.
-
 To get started, create an override configuration for your ESLint, while applying it to to `.graphql` files (do that even if you are declaring your operations in code files):
 
 ```json
@@ -166,7 +164,36 @@ You can find a list of [ESLint directives here](https://eslint.org/docs/2.13.1/u
 
 You can find a complete list of [all available rules here](./docs/README.md)
 
-> This repo doesn't exports a "recommended" set of rules - feel free to recommend us!
+## Available Configs
+
+This plugin exports a [`recommended` config](packages/plugin/src/configs/recommended.ts) that enforces good practices and an [`all` config](packages/plugin/src/configs/all.ts) that makes use of all rules (except for deprecated ones).
+
+Enable it in your `.eslintrc` file with the `extends` option.
+
+> These configs under the hood set `parser` as `@graphql-eslint/eslint-plugin` and add `@graphql-eslint` to `plugins` array, so you don't need to specify them.
+
+```diff
+{
+  "overrides": [
+    {
+      "files": ["*.js"],
+      "processor": "@graphql-eslint/graphql",
+      "rules": {
+        // your rules for JavaScript files
+      }
+    },
+    {
+      "files": ["*.graphql"],
+-     "parser": "@graphql-eslint/eslint-plugin",
+-     "plugins": ["@graphql-eslint"],
++     "extends": "plugin:@graphql-eslint/recommended", // or plugin:@graphql-eslint/all
+      "rules": {
+        // your rules for GraphQL files
+      }
+    }
+  ]
+}
+```
 
 ### `prettier` rule
 
@@ -179,23 +206,16 @@ All you need to do is like the following for now:
 module.exports = {
   overrides: [
     {
-      files: ['*.tsx', '*.ts', '*.jsx', '*.js'],
+      files: ['*.js'],
       processor: '@graphql-eslint/graphql',
+      extends: ['plugin:prettier/recommended'],
     },
     {
       files: ['*.graphql'],
       parser: '@graphql-eslint/eslint-plugin',
       plugins: ['@graphql-eslint'],
-      // the following is required for `eslint-plugin-prettier@<=3.4.0` temporarily
-      // after https://github.com/prettier/eslint-plugin-prettier/pull/413
-      // been merged and released, it can be deleted safely
       rules: {
-        'prettier/prettier': [
-          2,
-          {
-            parser: 'graphql',
-          },
-        ],
+        'prettier/prettier': 'error',
       },
     },
     // the following is required for `eslint-plugin-prettier@<=3.4.0` temporarily
@@ -204,8 +224,8 @@ module.exports = {
     {
       files: ['*.js/*.graphql'],
       rules: {
-        'prettier/prettier': 0
-      }
+        'prettier/prettier': 'off',
+      },
     },
   ],
 };
@@ -213,7 +233,7 @@ module.exports = {
 
 You can take [`examples/prettier`](examples/prettier/.eslintrc.js) as example.
 
-It could be better to remove the unnecessary parser setting if https://github.com/prettier/eslint-plugin-prettier/pull/413 and https://github.com/prettier/eslint-plugin-prettier/pull/415 been merged and released.
+It could be better to remove the unnecessary `*.js/*.graphql` overrides setting if <https://github.com/prettier/eslint-plugin-prettier/pull/415> will be merged and released.
 
 Please help to vote up if you want to speed up the progress.
 

package/configs/all.d.ts

@@ -0,0 +1,61 @@
+export declare const allConfig: {
+    rules: {
+        '@graphql-eslint/avoid-duplicate-fields': string;
+        '@graphql-eslint/avoid-operation-name-prefix': string;
+        '@graphql-eslint/avoid-scalar-result-type-on-mutation': string;
+        '@graphql-eslint/description-style': string;
+        '@graphql-eslint/input-name': string;
+        '@graphql-eslint/match-document-filename': string;
+        '@graphql-eslint/no-deprecated': string;
+        '@graphql-eslint/no-hashtag-description': string;
+        '@graphql-eslint/no-unreachable-types': string;
+        '@graphql-eslint/no-unused-fields': string;
+        '@graphql-eslint/require-deprecation-date': string;
+        '@graphql-eslint/require-description': string;
+        '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
+        '@graphql-eslint/require-id-when-available': string;
+        '@graphql-eslint/selection-set-depth': string;
+        '@graphql-eslint/unique-fragment-name': string;
+        '@graphql-eslint/unique-operation-name': string;
+        '@graphql-eslint/avoid-typename-prefix': string;
+        '@graphql-eslint/executable-definitions': string;
+        '@graphql-eslint/fields-on-correct-type': string;
+        '@graphql-eslint/fragments-on-composite-type': string;
+        '@graphql-eslint/known-argument-names': string;
+        '@graphql-eslint/known-directives': string;
+        '@graphql-eslint/known-fragment-names': string;
+        '@graphql-eslint/known-type-names': string;
+        '@graphql-eslint/lone-anonymous-operation': string;
+        '@graphql-eslint/lone-schema-definition': string;
+        '@graphql-eslint/naming-convention': string;
+        '@graphql-eslint/no-anonymous-operations': string;
+        '@graphql-eslint/no-case-insensitive-enum-values-duplicates': string;
+        '@graphql-eslint/no-fragment-cycles': string;
+        '@graphql-eslint/no-operation-name-suffix': string;
+        '@graphql-eslint/no-undefined-variables': string;
+        '@graphql-eslint/no-unused-fragments': string;
+        '@graphql-eslint/no-unused-variables': string;
+        '@graphql-eslint/one-field-subscriptions': string;
+        '@graphql-eslint/overlapping-fields-can-be-merged': string;
+        '@graphql-eslint/possible-fragment-spread': string;
+        '@graphql-eslint/possible-type-extension': string;
+        '@graphql-eslint/provided-required-arguments': string;
+        '@graphql-eslint/require-deprecation-reason': string;
+        '@graphql-eslint/scalar-leafs': string;
+        '@graphql-eslint/strict-id-in-types': string;
+        '@graphql-eslint/unique-argument-names': string;
+        '@graphql-eslint/unique-directive-names': string;
+        '@graphql-eslint/unique-directive-names-per-location': string;
+        '@graphql-eslint/unique-enum-value-names': string;
+        '@graphql-eslint/unique-field-definition-names': string;
+        '@graphql-eslint/unique-input-field-names': string;
+        '@graphql-eslint/unique-operation-types': string;
+        '@graphql-eslint/unique-type-names': string;
+        '@graphql-eslint/unique-variable-names': string;
+        '@graphql-eslint/value-literals-of-correct-type': string;
+        '@graphql-eslint/variables-are-input-types': string;
+        '@graphql-eslint/variables-in-allowed-position': string;
+    };
+    parser: string;
+    plugins: string[];
+};

package/configs/index.d.ts

@@ -0,0 +1,107 @@
+export declare const configs: {
+    all: {
+        rules: {
+            '@graphql-eslint/avoid-duplicate-fields': string;
+            '@graphql-eslint/avoid-operation-name-prefix': string;
+            '@graphql-eslint/avoid-scalar-result-type-on-mutation': string;
+            '@graphql-eslint/description-style': string;
+            '@graphql-eslint/input-name': string;
+            '@graphql-eslint/match-document-filename': string;
+            '@graphql-eslint/no-deprecated': string;
+            '@graphql-eslint/no-hashtag-description': string;
+            '@graphql-eslint/no-unreachable-types': string;
+            '@graphql-eslint/no-unused-fields': string;
+            '@graphql-eslint/require-deprecation-date': string;
+            '@graphql-eslint/require-description': string;
+            '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
+            '@graphql-eslint/require-id-when-available': string;
+            '@graphql-eslint/selection-set-depth': string;
+            '@graphql-eslint/unique-fragment-name': string;
+            '@graphql-eslint/unique-operation-name': string;
+            '@graphql-eslint/avoid-typename-prefix': string;
+            '@graphql-eslint/executable-definitions': string;
+            '@graphql-eslint/fields-on-correct-type': string;
+            '@graphql-eslint/fragments-on-composite-type': string;
+            '@graphql-eslint/known-argument-names': string;
+            '@graphql-eslint/known-directives': string;
+            '@graphql-eslint/known-fragment-names': string;
+            '@graphql-eslint/known-type-names': string;
+            '@graphql-eslint/lone-anonymous-operation': string;
+            '@graphql-eslint/lone-schema-definition': string;
+            '@graphql-eslint/naming-convention': string;
+            '@graphql-eslint/no-anonymous-operations': string;
+            '@graphql-eslint/no-case-insensitive-enum-values-duplicates': string;
+            '@graphql-eslint/no-fragment-cycles': string;
+            '@graphql-eslint/no-operation-name-suffix': string;
+            '@graphql-eslint/no-undefined-variables': string;
+            '@graphql-eslint/no-unused-fragments': string;
+            '@graphql-eslint/no-unused-variables': string;
+            '@graphql-eslint/one-field-subscriptions': string;
+            '@graphql-eslint/overlapping-fields-can-be-merged': string;
+            '@graphql-eslint/possible-fragment-spread': string;
+            '@graphql-eslint/possible-type-extension': string;
+            '@graphql-eslint/provided-required-arguments': string;
+            '@graphql-eslint/require-deprecation-reason': string;
+            '@graphql-eslint/scalar-leafs': string;
+            '@graphql-eslint/strict-id-in-types': string;
+            '@graphql-eslint/unique-argument-names': string;
+            '@graphql-eslint/unique-directive-names': string;
+            '@graphql-eslint/unique-directive-names-per-location': string;
+            '@graphql-eslint/unique-enum-value-names': string;
+            '@graphql-eslint/unique-field-definition-names': string;
+            '@graphql-eslint/unique-input-field-names': string;
+            '@graphql-eslint/unique-operation-types': string;
+            '@graphql-eslint/unique-type-names': string;
+            '@graphql-eslint/unique-variable-names': string;
+            '@graphql-eslint/value-literals-of-correct-type': string;
+            '@graphql-eslint/variables-are-input-types': string;
+            '@graphql-eslint/variables-in-allowed-position': string;
+        };
+        parser: string;
+        plugins: string[];
+    };
+    recommended: {
+        parser: string;
+        plugins: string[];
+        rules: {
+            '@graphql-eslint/avoid-typename-prefix': string;
+            '@graphql-eslint/executable-definitions': string;
+            '@graphql-eslint/fields-on-correct-type': string;
+            '@graphql-eslint/fragments-on-composite-type': string;
+            '@graphql-eslint/known-argument-names': string;
+            '@graphql-eslint/known-directives': string;
+            '@graphql-eslint/known-fragment-names': string;
+            '@graphql-eslint/known-type-names': string;
+            '@graphql-eslint/lone-anonymous-operation': string;
+            '@graphql-eslint/lone-schema-definition': string;
+            '@graphql-eslint/naming-convention': string;
+            '@graphql-eslint/no-anonymous-operations': string;
+            '@graphql-eslint/no-case-insensitive-enum-values-duplicates': string;
+            '@graphql-eslint/no-fragment-cycles': string;
+            '@graphql-eslint/no-operation-name-suffix': string;
+            '@graphql-eslint/no-undefined-variables': string;
+            '@graphql-eslint/no-unused-fragments': string;
+            '@graphql-eslint/no-unused-variables': string;
+            '@graphql-eslint/one-field-subscriptions': string;
+            '@graphql-eslint/overlapping-fields-can-be-merged': string;
+            '@graphql-eslint/possible-fragment-spread': string;
+            '@graphql-eslint/possible-type-extension': string;
+            '@graphql-eslint/provided-required-arguments': string;
+            '@graphql-eslint/require-deprecation-reason': string;
+            '@graphql-eslint/scalar-leafs': string;
+            '@graphql-eslint/strict-id-in-types': string;
+            '@graphql-eslint/unique-argument-names': string;
+            '@graphql-eslint/unique-directive-names': string;
+            '@graphql-eslint/unique-directive-names-per-location': string;
+            '@graphql-eslint/unique-enum-value-names': string;
+            '@graphql-eslint/unique-field-definition-names': string;
+            '@graphql-eslint/unique-input-field-names': string;
+            '@graphql-eslint/unique-operation-types': string;
+            '@graphql-eslint/unique-type-names': string;
+            '@graphql-eslint/unique-variable-names': string;
+            '@graphql-eslint/value-literals-of-correct-type': string;
+            '@graphql-eslint/variables-are-input-types': string;
+            '@graphql-eslint/variables-in-allowed-position': string;
+        };
+    };
+};

package/configs/recommended.d.ts

@@ -0,0 +1,44 @@
+export declare const recommendedConfig: {
+    parser: string;
+    plugins: string[];
+    rules: {
+        '@graphql-eslint/avoid-typename-prefix': string;
+        '@graphql-eslint/executable-definitions': string;
+        '@graphql-eslint/fields-on-correct-type': string;
+        '@graphql-eslint/fragments-on-composite-type': string;
+        '@graphql-eslint/known-argument-names': string;
+        '@graphql-eslint/known-directives': string;
+        '@graphql-eslint/known-fragment-names': string;
+        '@graphql-eslint/known-type-names': string;
+        '@graphql-eslint/lone-anonymous-operation': string;
+        '@graphql-eslint/lone-schema-definition': string;
+        '@graphql-eslint/naming-convention': string;
+        '@graphql-eslint/no-anonymous-operations': string;
+        '@graphql-eslint/no-case-insensitive-enum-values-duplicates': string;
+        '@graphql-eslint/no-fragment-cycles': string;
+        '@graphql-eslint/no-operation-name-suffix': string;
+        '@graphql-eslint/no-undefined-variables': string;
+        '@graphql-eslint/no-unused-fragments': string;
+        '@graphql-eslint/no-unused-variables': string;
+        '@graphql-eslint/one-field-subscriptions': string;
+        '@graphql-eslint/overlapping-fields-can-be-merged': string;
+        '@graphql-eslint/possible-fragment-spread': string;
+        '@graphql-eslint/possible-type-extension': string;
+        '@graphql-eslint/provided-required-arguments': string;
+        '@graphql-eslint/require-deprecation-reason': string;
+        '@graphql-eslint/scalar-leafs': string;
+        '@graphql-eslint/strict-id-in-types': string;
+        '@graphql-eslint/unique-argument-names': string;
+        '@graphql-eslint/unique-directive-names': string;
+        '@graphql-eslint/unique-directive-names-per-location': string;
+        '@graphql-eslint/unique-enum-value-names': string;
+        '@graphql-eslint/unique-field-definition-names': string;
+        '@graphql-eslint/unique-input-field-names': string;
+        '@graphql-eslint/unique-operation-types': string;
+        '@graphql-eslint/unique-type-names': string;
+        '@graphql-eslint/unique-variable-names': string;
+        '@graphql-eslint/value-literals-of-correct-type': string;
+        '@graphql-eslint/variables-are-input-types': string;
+        '@graphql-eslint/variables-in-allowed-position': string;
+    };
+};

package/docs/README.md

@@ -2,67 +2,71 @@
 
 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
+- 🚀 `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 it belongs to the `recommended` configuration
 
-<!-- Do not manually modify this table. Run: `yarn generate:docs` -->
-<!-- RULES_TABLE_START -->
-| Name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description | 🚀&nbsp;/&nbsp;🔮 | 🔧 |
-| :-- | :-- | :-- | :-- |
-| [avoid-duplicate-fields](rules/avoid-duplicate-fields.md) | Checks for duplicate fields in selection set, variables in operation definition, or in arguments set of a field. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [avoid-operation-name-prefix](rules/avoid-operation-name-prefix.md) | Enforce/avoid operation name prefix, useful if you wish to avoid prefix in your root fields, or avoid using REST terminology in your schema. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [avoid-typename-prefix](rules/avoid-typename-prefix.md) | Enforces users to avoid using the type name in a field name while defining your schema. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [description-style](rules/description-style.md) | Require all comments to follow the same style (either block or inline). | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [executable-definitions](rules/executable-definitions.md) | A GraphQL document is only valid for execution if all definitions are either operation or fragment definitions. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [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`. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [input-name](rules/input-name.md) | Require mutation argument to be always called "input" and input type to be called Mutation name + "Input". | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [known-argument-names](rules/known-argument-names.md) | A GraphQL field is only valid if all supplied arguments are defined by that field. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [known-directives](rules/known-directives.md) | A GraphQL document is only valid if all `@directives` are known by the schema and legally positioned. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [lone-schema-definition](rules/lone-schema-definition.md) | A GraphQL document is only valid if it contains only one schema definition. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [match-document-filename](rules/match-document-filename.md) | This rule allows you to enforce that the file name should match the operation name | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [naming-convention](rules/naming-convention.md) | Require names to follow specified conventions. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [no-case-insensitive-enum-values-duplicates](rules/no-case-insensitive-enum-values-duplicates.md) |  | &nbsp;&nbsp;&nbsp;&nbsp;🚀 | 🔧 |
-| [no-deprecated](rules/no-deprecated.md) | Enforce that deprecated fields or enum values are not in use by operations. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [no-fragment-cycles](rules/no-fragment-cycles.md) | A GraphQL fragment is only valid when it does not have cycles in fragments usage. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [no-hashtag-description](rules/no-hashtag-description.md) | Requires to use `"""` or `"` for adding a GraphQL description instead of `#`. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [no-operation-name-suffix](rules/no-operation-name-suffix.md) | Makes sure you are not adding the operation type to the name of the operation. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 | 🔧 |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [no-unreachable-types](rules/no-unreachable-types.md) | Requires all types to be reachable at some level by root level fields. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 | 🔧 |
-| [no-unused-fields](rules/no-unused-fields.md) | Requires all fields to be used at some level by siblings operations. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 | 🔧 |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [one-field-subscriptions](rules/one-field-subscriptions.md) | A GraphQL subscription is valid only if it contains a single root field. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [possible-type-extension](rules/possible-type-extension.md) | A type extension is only valid if the type is defined and has the same kind. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [require-deprecation-reason](rules/require-deprecation-reason.md) | Require all deprecation directives to specify a reason. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [require-description](rules/require-description.md) | Enforce descriptions in your type definitions. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [require-id-when-available](rules/require-id-when-available.md) | Enforce selecting specific fields when they are available on the GraphQL type. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [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). | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [unique-argument-names](rules/unique-argument-names.md) | A GraphQL field or directive is only valid if all supplied arguments are uniquely named. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [unique-directive-names](rules/unique-directive-names.md) | A GraphQL document is only valid if all defined directives have unique names. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [unique-enum-value-names](rules/unique-enum-value-names.md) | A GraphQL enum type is only valid if all its values are uniquely named. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [unique-field-definition-names](rules/unique-field-definition-names.md) | A GraphQL complex type is only valid if all its fields are uniquely named. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [unique-fragment-name](rules/unique-fragment-name.md) | Enforce unique fragment names across your project. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [unique-operation-name](rules/unique-operation-name.md) | Enforce unique operation names across your project. | &nbsp;&nbsp;&nbsp;&nbsp;🚀 |  |
-| [unique-operation-types](rules/unique-operation-types.md) | A GraphQL document is only valid if it has only one type per operation. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [unique-type-names](rules/unique-type-names.md) | A GraphQL document is only valid if all defined types have unique names. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [unique-variable-names](rules/unique-variable-names.md) | A GraphQL operation is only valid if all its variables are uniquely named. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [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. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [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). | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-| [variables-in-allowed-position](rules/variables-in-allowed-position.md) | Variables passed to field arguments conform to type. | &nbsp;&nbsp;&nbsp;&nbsp;🔮 |  |
-<!-- RULES_TABLE_END -->
+<!-- 🚨 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;🔮|🔧|✅
+-|-|:-:|-|-
+[avoid-duplicate-fields](rules/avoid-duplicate-fields.md)|Checks for duplicate fields in selection set, variables in operation definition, or in arguments set of a field.|🚀||
+[avoid-operation-name-prefix](rules/avoid-operation-name-prefix.md)|Enforce/avoid operation name prefix, useful if you wish to avoid prefix in your root fields, or avoid using REST terminology in your schema.|🚀||
+[avoid-scalar-result-type-on-mutation](rules/avoid-scalar-result-type-on-mutation.md)|Avoid scalar result type on mutation type to make sure to return a valid state.|🚀||
+[avoid-typename-prefix](rules/avoid-typename-prefix.md)|Enforces users to avoid using the type name in a field name while defining your schema.|🚀||✅
+[description-style](rules/description-style.md)|Require all comments to follow the same style (either block or inline).|🚀||
+[executable-definitions](rules/executable-definitions.md)|A GraphQL document is only valid for execution if all definitions are either operation or fragment definitions.|🔮||✅
+[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`.|🔮||✅
+[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.|🔮||✅
+[input-name](rules/input-name.md)|Require mutation argument to be always called "input" and input type to be called Mutation name + "Input".|🚀||
+[known-argument-names](rules/known-argument-names.md)|A GraphQL field is only valid if all supplied arguments are defined by that field.|🔮||✅
+[known-directives](rules/known-directives.md)|A GraphQL document is only valid if all `@directives` are known by the schema and legally positioned.|🔮||✅
+[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.|🔮||✅
+[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.|🔮||✅
+[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.|🔮||✅
+[lone-schema-definition](rules/lone-schema-definition.md)|A GraphQL document is only valid if it contains only one schema definition.|🔮||✅
+[match-document-filename](rules/match-document-filename.md)|This rule allows you to enforce that the file name should match the operation name.|🚀||
+[naming-convention](rules/naming-convention.md)|Require names to follow specified conventions.|🚀||✅
+[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.|🚀||✅
+[no-case-insensitive-enum-values-duplicates](rules/no-case-insensitive-enum-values-duplicates.md)|Disallow case-insensitive enum values duplicates.|🚀|🔧|✅
+[no-deprecated](rules/no-deprecated.md)|Enforce that deprecated fields or enum values are not in use by operations.|🚀||
+[no-fragment-cycles](rules/no-fragment-cycles.md)|A GraphQL fragment is only valid when it does not have cycles in fragments usage.|🔮||✅
+[no-hashtag-description](rules/no-hashtag-description.md)|Requires to use `"""` or `"` for adding a GraphQL description instead of `#`.|🚀||
+[no-operation-name-suffix](rules/no-operation-name-suffix.md)|Makes sure you are not adding the operation type to the name of the operation.|🚀|🔧|✅
+[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.|🔮||✅
+[no-unreachable-types](rules/no-unreachable-types.md)|Requires all types to be reachable at some level by root level fields.|🚀|🔧|
+[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.|🔮||✅
+[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.|🔮||✅
+[one-field-subscriptions](rules/one-field-subscriptions.md)|A GraphQL subscription is valid only if it contains a single root field.|🔮||✅
+[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.|🔮||✅
+[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.|🔮||✅
+[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.|🔮||✅
+[require-deprecation-date](rules/require-deprecation-date.md)|Require deletion date on `@deprecated` directive. Suggest removing deprecated things after deprecated date.|🚀||
+[require-deprecation-reason](rules/require-deprecation-reason.md)|Require all deprecation directives to specify a reason.|🚀||✅
+[require-description](rules/require-description.md)|Enforce descriptions in your type definitions.|🚀||
+[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.|🚀||
+[require-id-when-available](rules/require-id-when-available.md)|Enforce selecting specific fields when they are available on the GraphQL type.|🚀||
+[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.|🔮||✅
+[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).|🚀||
+[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.|🚀||✅
+[unique-argument-names](rules/unique-argument-names.md)|A GraphQL field or directive is only valid if all supplied arguments are uniquely named.|🔮||✅
+[unique-directive-names](rules/unique-directive-names.md)|A GraphQL document is only valid if all defined directives have unique names.|🔮||✅
+[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.|🔮||✅
+[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.|🔮||✅
+[unique-fragment-name](rules/unique-fragment-name.md)|Enforce unique fragment names across your project.|🚀||
+[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.|🔮||✅
+[unique-operation-name](rules/unique-operation-name.md)|Enforce unique operation names across your project.|🚀||
+[unique-operation-types](rules/unique-operation-types.md)|A GraphQL document is only valid if it has only one type per operation.|🔮||✅
+[unique-type-names](rules/unique-type-names.md)|A GraphQL document is only valid if all defined types have unique names.|🔮||✅
+[unique-variable-names](rules/unique-variable-names.md)|A GraphQL operation is only valid if all its variables are uniquely named.|🔮||✅
+[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.|🔮||✅
+[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).|🔮||✅
+[variables-in-allowed-position](rules/variables-in-allowed-position.md)|Variables passed to field arguments conform to type.|🔮||✅
+<!-- prettier-ignore-end -->
 
 ## Further Reading
 

package/docs/rules/avoid-scalar-result-type-on-mutation.md

@@ -0,0 +1,30 @@
+# `avoid-scalar-result-type-on-mutation`
+
+- Category: `Best Practices`
+- Rule name: `@graphql-eslint/avoid-scalar-result-type-on-mutation`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Avoid scalar result type on mutation type to make sure to return a valid state.
+
+## Usage Examples
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/avoid-scalar-result-type-on-mutation: 'error'
+
+type Mutation {
+  createUser: Boolean
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/avoid-scalar-result-type-on-mutation: 'error'
+
+type Mutation {
+  createUser: User!
+}
+```

package/docs/rules/avoid-typename-prefix.md

@@ -1,5 +1,7 @@
 # `avoid-typename-prefix`
 
+✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
+
 - Category: `Best Practices`
 - Rule name: `@graphql-eslint/avoid-typename-prefix`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

package/docs/rules/executable-definitions.md

@@ -1,5 +1,7 @@
 # `executable-definitions`
 
+✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
+
 - Category: `Validation`
 - Rule name: `@graphql-eslint/executable-definitions`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
@@ -7,4 +9,4 @@
 
 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 it's 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. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/ExecutableDefinitionsRule.ts).

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

@@ -1,5 +1,7 @@
 # `fields-on-correct-type`
 
+✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
+
 - Category: `Validation`
 - Rule name: `@graphql-eslint/fields-on-correct-type`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
@@ -7,4 +9,4 @@
 
 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 it's 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. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/FieldsOnCorrectTypeRule.ts).

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

@@ -1,5 +1,7 @@
 # `fragments-on-composite-type`
 
+✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
+
 - Category: `Validation`
 - Rule name: `@graphql-eslint/fragments-on-composite-type`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
@@ -7,4 +9,4 @@
 
 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 it's 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. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/FragmentsOnCompositeTypesRule.ts).

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

@@ -1,5 +1,7 @@
 # `known-argument-names`
 
+✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
+
 - Category: `Validation`
 - Rule name: `@graphql-eslint/known-argument-names`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
@@ -7,4 +9,4 @@
 
 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 it's 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. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownArgumentNamesRule.ts).