@graphql-eslint/eslint-plugin 3.0.0-alpha-0a66b90.0 → 3.0.0-alpha-2918431.0

package/README.md

@@ -1,8 +1,6 @@
 This project integrates GraphQL and ESLint, for a better developer experience.
 
-<p align="left">
-  <img height="150" src="./logo.png">
-</p>
+<img height="150" src="./logo.png">
 
 [![npm version](https://badge.fury.io/js/%40graphql-eslint%2Feslint-plugin.svg)](https://badge.fury.io/js/%40graphql-eslint%2Feslint-plugin)
 
@@ -184,11 +182,20 @@ You can find a complete list of [all available rules here](docs/README.md).
 
 ## 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).
+<!-- prettier-ignore-start -->
+|Name|Description|
+|:-:|-|
+|[`schema-recommended`](packages/plugin/src/configs/schema-recommended.ts)|enables all recommended rules|
+|[`operations-recommended`](packages/plugin/src/configs/operations-recommended.ts) |enables all recommended rules|
+|[`schema-all`](packages/plugin/src/configs/schema-all.ts)|enables all rules (except for the rules that require `parserOptions.operations` option)|
+|[`operations-all`](packages/plugin/src/configs/operations-all.ts)|enables all rules|
+<!-- prettier-ignore-end -->
 
-Enable it in your `.eslintrc` file with the `extends` option.
+## Config usage
 
-> 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.
+For example, to enable the `schema-recommended` config, enable it in your `.eslintrc` file with the `extends` option:
+
+> All 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
 {
@@ -201,7 +208,7 @@ Enable it in your `.eslintrc` file with the `extends` option.
       "files": ["*.graphql"],
 -     "parser": "@graphql-eslint/eslint-plugin",
 -     "plugins": ["@graphql-eslint"],
-+     "extends": "plugin:@graphql-eslint/recommended" // or plugin:@graphql-eslint/all
++     "extends": "plugin:@graphql-eslint/schema-recommended"
     }
   ]
 }
@@ -248,7 +255,11 @@ Please help to vote up if you want to speed up the progress.
 
 ## Further Reading
 
-If you wish to learn more about this project, how the parser works, how to add custom rules and more, [please refer to the docs directory](docs/README.md).
+If you wish to learn more about this project, how the parser works, how to add custom rules and more please refer to the below links:
+
+- [Writing Custom Rules](docs/custom-rules.md)
+- [How the parser works?](docs/parser.md)
+- [`parserOptions`](docs/parser-options.md)
 
 ## Contributions
 

package/configs/base.d.ts

@@ -0,0 +1,5 @@
+declare const _default: {
+    parser: string;
+    plugins: string[];
+};
+export default _default;

package/configs/index.d.ts

@@ -1,113 +1,72 @@
 export declare const configs: {
-    all: {
+    base: {
+        parser: string;
+        plugins: string[];
+    };
+    'schema-recommended': {
+        extends: string[];
         rules: {
-            '@graphql-eslint/alphabetize': (string | {
-                fields: string[];
-                values: string[];
-                selections: string[];
-                variables: string[];
-                arguments: string[];
-            })[];
-            '@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-root-type': (string | {
-                disallow: string[];
-            })[];
-            '@graphql-eslint/no-unreachable-types': string;
-            '@graphql-eslint/no-unused-fields': string;
-            '@graphql-eslint/require-deprecation-date': string;
-            '@graphql-eslint/require-description': (string | {
-                types: boolean;
-                overrides: {
-                    DirectiveDefinition: boolean;
-                };
-            })[];
-            '@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 | {
                 types: string;
                 fields: string;
-                overrides: {
-                    EnumValueDefinition: string;
-                    OperationDefinition: {
-                        style: string;
-                        forbiddenPrefixes: string[];
-                        forbiddenSuffixes: string[];
-                    };
-                    FragmentDefinition: {
-                        style: string;
-                        forbiddenPrefixes: string[];
-                        forbiddenSuffixes: string[];
-                    };
-                    'FieldDefinition[parent.name.value=Query]': {
-                        forbiddenPrefixes: string[];
-                        forbiddenSuffixes: string[];
-                    };
-                    'FieldDefinition[parent.name.value=Mutation]': {
-                        forbiddenPrefixes: string[];
-                        forbiddenSuffixes: string[];
-                    };
-                    'FieldDefinition[parent.name.value=Subscription]': {
-                        forbiddenPrefixes: string[];
-                        forbiddenSuffixes: string[];
-                    };
+                EnumValueDefinition: string;
+                'FieldDefinition[parent.name.value=Query]': {
+                    forbiddenPrefixes: string[];
+                    forbiddenSuffixes: string[];
+                };
+                'FieldDefinition[parent.name.value=Mutation]': {
+                    forbiddenPrefixes: string[];
+                    forbiddenSuffixes: string[];
+                };
+                'FieldDefinition[parent.name.value=Subscription]': {
+                    forbiddenPrefixes: string[];
+                    forbiddenSuffixes: 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/no-hashtag-description': string;
+            '@graphql-eslint/no-typename-prefix': string;
+            '@graphql-eslint/no-unreachable-types': 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[];
+    'schema-all': {
+        extends: string[];
+        rules: {
+            '@graphql-eslint/alphabetize': (string | {
+                fields: string[];
+                values: string[];
+                arguments: string[];
+            })[];
+            '@graphql-eslint/input-name': string;
+            '@graphql-eslint/no-root-type': string;
+            '@graphql-eslint/no-scalar-result-type-on-mutation': string;
+            '@graphql-eslint/no-unused-fields': string;
+            '@graphql-eslint/require-deprecation-date': string;
+            '@graphql-eslint/require-description': (string | {
+                types: boolean;
+                DirectiveDefinition: boolean;
+            })[];
+            '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
+        };
+    };
+    'operations-recommended': {
+        extends: 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;
@@ -116,63 +75,61 @@ export declare const configs: {
             '@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 | {
-                types: string;
-                fields: string;
-                overrides: {
-                    EnumValueDefinition: string;
-                    OperationDefinition: {
-                        style: string;
-                        forbiddenPrefixes: string[];
-                        forbiddenSuffixes: string[];
-                    };
-                    FragmentDefinition: {
-                        style: string;
-                        forbiddenPrefixes: string[];
-                        forbiddenSuffixes: string[];
-                    };
-                    'FieldDefinition[parent.name.value=Query]': {
-                        forbiddenPrefixes: string[];
-                        forbiddenSuffixes: string[];
-                    };
-                    'FieldDefinition[parent.name.value=Mutation]': {
-                        forbiddenPrefixes: string[];
-                        forbiddenSuffixes: string[];
-                    };
-                    'FieldDefinition[parent.name.value=Subscription]': {
-                        forbiddenPrefixes: string[];
-                        forbiddenSuffixes: string[];
-                    };
+                Argument: string;
+                VariableDefinition: string;
+                OperationDefinition: {
+                    style: string;
+                    forbiddenPrefixes: string[];
+                    forbiddenSuffixes: string[];
+                };
+                FragmentDefinition: {
+                    style: string;
+                    forbiddenPrefixes: string[];
+                    forbiddenSuffixes: string[];
                 };
             })[];
             '@graphql-eslint/no-anonymous-operations': string;
-            '@graphql-eslint/no-case-insensitive-enum-values-duplicates': string;
+            '@graphql-eslint/no-deprecated': string;
+            '@graphql-eslint/no-duplicate-fields': 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/require-id-when-available': string;
             '@graphql-eslint/scalar-leafs': string;
-            '@graphql-eslint/strict-id-in-types': string;
+            '@graphql-eslint/selection-set-depth': (string | {
+                maxDepth: number;
+            })[];
             '@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;
         };
     };
+    'operations-all': {
+        extends: string[];
+        rules: {
+            '@graphql-eslint/alphabetize': (string | {
+                selections: string[];
+                variables: string[];
+                arguments: string[];
+            })[];
+            '@graphql-eslint/match-document-filename': (string | {
+                query: string;
+                mutation: string;
+                subscription: string;
+                fragment: string;
+            })[];
+            '@graphql-eslint/unique-fragment-name': string;
+            '@graphql-eslint/unique-operation-name': string;
+        };
+    };
 };

package/configs/operations-all.d.ts

@@ -0,0 +1,19 @@
+declare const _default: {
+    extends: string[];
+    rules: {
+        '@graphql-eslint/alphabetize': (string | {
+            selections: string[];
+            variables: string[];
+            arguments: string[];
+        })[];
+        '@graphql-eslint/match-document-filename': (string | {
+            query: string;
+            mutation: string;
+            subscription: string;
+            fragment: string;
+        })[];
+        '@graphql-eslint/unique-fragment-name': string;
+        '@graphql-eslint/unique-operation-name': string;
+    };
+};
+export default _default;

package/configs/operations-recommended.d.ts

@@ -0,0 +1,51 @@
+declare const _default: {
+    extends: string[];
+    rules: {
+        '@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/naming-convention': (string | {
+            Argument: string;
+            VariableDefinition: string;
+            OperationDefinition: {
+                style: string;
+                forbiddenPrefixes: string[];
+                forbiddenSuffixes: string[];
+            };
+            FragmentDefinition: {
+                style: string;
+                forbiddenPrefixes: string[];
+                forbiddenSuffixes: string[];
+            };
+        })[];
+        '@graphql-eslint/no-anonymous-operations': string;
+        '@graphql-eslint/no-deprecated': string;
+        '@graphql-eslint/no-duplicate-fields': string;
+        '@graphql-eslint/no-fragment-cycles': 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/provided-required-arguments': string;
+        '@graphql-eslint/require-id-when-available': string;
+        '@graphql-eslint/scalar-leafs': string;
+        '@graphql-eslint/selection-set-depth': (string | {
+            maxDepth: number;
+        })[];
+        '@graphql-eslint/unique-argument-names': string;
+        '@graphql-eslint/unique-directive-names-per-location': string;
+        '@graphql-eslint/unique-input-field-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;
+    };
+};
+export default _default;

package/configs/schema-all.d.ts

@@ -0,0 +1,21 @@
+declare const _default: {
+    extends: string[];
+    rules: {
+        '@graphql-eslint/alphabetize': (string | {
+            fields: string[];
+            values: string[];
+            arguments: string[];
+        })[];
+        '@graphql-eslint/input-name': string;
+        '@graphql-eslint/no-root-type': string;
+        '@graphql-eslint/no-scalar-result-type-on-mutation': string;
+        '@graphql-eslint/no-unused-fields': string;
+        '@graphql-eslint/require-deprecation-date': string;
+        '@graphql-eslint/require-description': (string | {
+            types: boolean;
+            DirectiveDefinition: boolean;
+        })[];
+        '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
+    };
+};
+export default _default;

package/configs/schema-recommended.d.ts

@@ -0,0 +1,42 @@
+declare const _default: {
+    extends: string[];
+    rules: {
+        '@graphql-eslint/description-style': string;
+        '@graphql-eslint/known-argument-names': string;
+        '@graphql-eslint/known-directives': string;
+        '@graphql-eslint/known-type-names': string;
+        '@graphql-eslint/lone-schema-definition': string;
+        '@graphql-eslint/naming-convention': (string | {
+            types: string;
+            fields: string;
+            EnumValueDefinition: string;
+            'FieldDefinition[parent.name.value=Query]': {
+                forbiddenPrefixes: string[];
+                forbiddenSuffixes: string[];
+            };
+            'FieldDefinition[parent.name.value=Mutation]': {
+                forbiddenPrefixes: string[];
+                forbiddenSuffixes: string[];
+            };
+            'FieldDefinition[parent.name.value=Subscription]': {
+                forbiddenPrefixes: string[];
+                forbiddenSuffixes: string[];
+            };
+        })[];
+        '@graphql-eslint/no-case-insensitive-enum-values-duplicates': string;
+        '@graphql-eslint/no-hashtag-description': string;
+        '@graphql-eslint/no-typename-prefix': string;
+        '@graphql-eslint/no-unreachable-types': string;
+        '@graphql-eslint/possible-type-extension': string;
+        '@graphql-eslint/provided-required-arguments': string;
+        '@graphql-eslint/require-deprecation-reason': string;
+        '@graphql-eslint/strict-id-in-types': 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-operation-types': string;
+        '@graphql-eslint/unique-type-names': string;
+    };
+};
+export default _default;

package/docs/README.md

@@ -12,11 +12,7 @@ Each rule has emojis denoting:
 Name                    |Description|🚀 / 🔮|🔧|✅
 -|-|:-:|-|-
 [alphabetize](rules/alphabetize.md)|Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.|🚀||
-[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).|🚀||
+[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.|🔮||✅
@@ -31,13 +27,15 @@ Name            &nbs
 [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-deprecated](rules/no-deprecated.md)|Enforce that deprecated fields or enum values are not in use by operations.|🚀||✅
+[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.|🚀||✅
 [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-root-type](rules/no-root-type.md)|Disallow using root types for `read-only` or `write-only` schemas.|🚀||
+[no-hashtag-description](rules/no-hashtag-description.md)|Requires to use `"""` or `"` for adding a GraphQL description instead of `#`.|🚀||✅
+[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.|🚀||
+[no-typename-prefix](rules/no-typename-prefix.md)|Enforces users to avoid using the type name in a field name while defining your schema.|🚀||✅
 [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-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.|🔮||✅
@@ -50,9 +48,9 @@ Name            &nbs
 [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.|🚀||
+[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).|🚀||
+[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.|🔮||✅
@@ -69,9 +67,3 @@ Name            &nbs
 [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
-
-- [Writing Custom Rules](custom-rules.md)
-- [How the parser works?](parser.md)
-- [`parserOptions`](parser-options.md)

package/docs/deprecated-rules.md

@@ -0,0 +1,21 @@
+# Deprecated Rules
+
+## avoid-duplicate-fields
+
+This rule was renamed to [`no-duplicate-fields`](rules/no-duplicate-fields.md).
+
+## avoid-scalar-result-type-on-mutation
+
+This rule was renamed to [`no-scalar-result-type-on-mutation`](rules/no-scalar-result-type-on-mutation.md).
+
+## avoid-typename-prefix
+
+This rule was renamed to [`no-typename-prefix`](rules/no-typename-prefix.md).
+
+## avoid-operation-name-prefix
+
+This rule was removed because the same things can be validated using [`naming-convention`](rules/naming-convention.md).
+
+## no-operation-name-suffix
+
+This rule was removed because the same things can be validated using [`naming-convention`](rules/naming-convention.md).

package/docs/rules/alphabetize.md

@@ -1,6 +1,6 @@
 # `alphabetize`
 
-- Category: `Best Practices`
+- Category: `Schema & Operations`
 - Rule name: `@graphql-eslint/alphabetize`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)

package/docs/rules/description-style.md

@@ -1,6 +1,8 @@
 # `description-style`
 
-- Category: `Stylistic Issues`
+✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
+
+- Category: `Schema`
 - Rule name: `@graphql-eslint/description-style`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
@@ -35,14 +37,14 @@ type someTypeName {
 
 The schema defines the following properties:
 
-### `style` (string, enum)
+### `style` (enum)
 
 This element must be one of the following enum values:
 
 - `block`
 - `inline`
 
-Default: `"inline"`
+Default: `"block"`
 
 ## Resources
 

package/docs/rules/executable-definitions.md

@@ -1,8 +1,8 @@
 # `executable-definitions`
 
-✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
+✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
 
-- Category: `Validation`
+- Category: `Operations`
 - Rule name: `@graphql-eslint/executable-definitions`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)

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

@@ -1,8 +1,8 @@
 # `fields-on-correct-type`
 
-✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
+✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
 
-- Category: `Validation`
+- Category: `Operations`
 - Rule name: `@graphql-eslint/fields-on-correct-type`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)

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

@@ -1,8 +1,8 @@
 # `fragments-on-composite-type`
 
-✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
+✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
 
-- Category: `Validation`
+- Category: `Operations`
 - Rule name: `@graphql-eslint/fragments-on-composite-type`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)

package/docs/rules/input-name.md

@@ -1,6 +1,6 @@
 # `input-name`
 
-- Category: `Stylistic Issues`
+- Category: `Schema`
 - Rule name: `@graphql-eslint/input-name`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)

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

@@ -1,8 +1,8 @@
 # `known-argument-names`
 
-✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
+✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` and `"plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
 
-- Category: `Validation`
+- Category: `Schema & Operations`
 - Rule name: `@graphql-eslint/known-argument-names`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)