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

package/docs/rules/lone-schema-definition.md

@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if it contains only one schema 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/LoneSchemaDefinitionRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/naming-convention.md

@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` and `"plugin:@graphql-eslint/operations-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 & Operations`
 - Rule name: `@graphql-eslint/naming-convention`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

package/docs/rules/no-anonymous-operations.md

@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/operations-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: `Operations`
 - Rule name: `@graphql-eslint/no-anonymous-operations`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

package/docs/rules/no-case-insensitive-enum-values-duplicates.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/no-case-insensitive-enum-values-duplicates`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

package/docs/rules/no-deprecated.md

@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/operations-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: `Operations`
 - Rule name: `@graphql-eslint/no-deprecated`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

package/docs/rules/no-duplicate-fields.md

@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/operations-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: `Operations`
 - Rule name: `@graphql-eslint/no-duplicate-fields`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

package/docs/rules/no-fragment-cycles.md

@@ -9,7 +9,7 @@
 
 A GraphQL fragment is only valid when it does not have cycles in fragments usage.
 
-> 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/NoFragmentCyclesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/no-hashtag-description.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/no-hashtag-description`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

package/docs/rules/no-root-type.md

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

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

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

package/docs/rules/no-typename-prefix.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/no-typename-prefix`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

package/docs/rules/no-undefined-variables.md

@@ -9,7 +9,7 @@
 
 A GraphQL operation is only valid if all variables encountered, both directly and via fragment spreads, are defined by that operation.
 
-> 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/NoUndefinedVariablesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/no-unreachable-types.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/no-unreachable-types`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

package/docs/rules/no-unused-fields.md

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

package/docs/rules/no-unused-fragments.md

@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if all fragment definitions are spread within operations, or spread within other fragments spread within operations.
 
-> 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/NoUnusedFragmentsRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/no-unused-variables.md

@@ -9,7 +9,7 @@
 
 A GraphQL operation is only valid if all variables defined by an operation are used, either directly or within a spread fragment.
 
-> 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/NoUnusedVariablesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/one-field-subscriptions.md

@@ -9,7 +9,7 @@
 
 A GraphQL subscription is valid only if it contains a single root 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/SingleFieldSubscriptionsRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/overlapping-fields-can-be-merged.md

@@ -9,7 +9,7 @@
 
 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.
 
-> 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/OverlappingFieldsCanBeMergedRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/possible-fragment-spread.md

@@ -9,7 +9,7 @@
 
 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.
 
-> 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/PossibleFragmentSpreadsRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/possible-type-extension.md

@@ -7,7 +7,7 @@
 
 A type extension is only valid if the type is defined and has the same kind.
 
-> 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/PossibleTypeExtensionsRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/provided-required-arguments.md

@@ -9,7 +9,7 @@
 
 A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.
 
-> 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/ProvidedRequiredArgumentsRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/require-deprecation-date.md

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

package/docs/rules/require-id-when-available.md

@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/operations-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: `Operations`
 - Rule name: `@graphql-eslint/require-id-when-available`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

package/docs/rules/scalar-leafs.md

@@ -9,7 +9,7 @@
 
 A GraphQL document is valid only if all leaf fields (fields without sub selections) are of scalar or enum types.
 
-> 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/ScalarLeafsRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/selection-set-depth.md

@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/operations-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: `Operations`
 - Rule name: `@graphql-eslint/selection-set-depth`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

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

@@ -9,7 +9,7 @@
 
 A GraphQL field or directive is only valid if all supplied arguments are uniquely named.
 
-> 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/UniqueArgumentNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/unique-directive-names-per-location.md

@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if all non-repeatable directives at a given location are uniquely named.
 
-> 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/UniqueDirectivesPerLocationRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/unique-directive-names.md

@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if all defined directives have unique names.
 
-> 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/UniqueDirectiveNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/unique-enum-value-names.md

@@ -7,7 +7,7 @@
 
 A GraphQL enum type is only valid if all its values are uniquely named.
 
-> 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/UniqueEnumValueNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/unique-field-definition-names.md

@@ -9,7 +9,7 @@
 
 A GraphQL complex type is only valid if all its fields are uniquely named.
 
-> 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/UniqueFieldDefinitionNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/unique-input-field-names.md

@@ -9,7 +9,7 @@
 
 A GraphQL input object value is only valid if all supplied fields are uniquely named.
 
-> 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/UniqueInputFieldNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/unique-operation-types.md

@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if it has only one type per operation.
 
-> 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/UniqueOperationTypesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

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

@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if all defined types have unique names.
 
-> 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/UniqueTypeNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/unique-variable-names.md

@@ -9,7 +9,7 @@
 
 A GraphQL operation is only valid if all its variables are uniquely named.
 
-> 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/UniqueVariableNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/value-literals-of-correct-type.md

@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if all value literals are of the type expected at their position.
 
-> 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/ValuesOfCorrectTypeRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/variables-are-input-types.md

@@ -9,7 +9,7 @@
 
 A GraphQL operation is only valid if all the variables it defines are of input types (scalar, enum, or input object).
 
-> 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/VariablesAreInputTypesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/docs/rules/variables-in-allowed-position.md

@@ -9,7 +9,7 @@
 
 Variables passed to field arguments conform to 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/VariablesInAllowedPositionRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 

package/estree-parser/converter.d.ts

@@ -1,6 +1,7 @@
-import { GraphQLESTreeNode } from './estree-ast';
 import { ASTNode, TypeInfo } from 'graphql';
+import { Comment } from 'estree';
+import { GraphQLESTreeNode } from './estree-ast';
 export declare function convertToESTree<T extends ASTNode>(node: T, typeInfo?: TypeInfo): {
     rootTree: GraphQLESTreeNode<T, false>;
-    comments: import("estree").Comment[];
+    comments: Comment[];
 };

package/estree-parser/estree-ast.d.ts

@@ -1,27 +1,27 @@
 import { ASTNode, TypeInfo, TypeNode, ValueNode } from 'graphql';
 import { BaseNode } from 'estree';
-export declare type SafeGraphQLType<T extends ASTNode | ValueNode> = Omit<T extends {
+declare type SafeGraphQLType<T extends ASTNode | ValueNode> = Omit<T extends {
     readonly type: TypeNode;
 } ? Omit<T, 'type'> & {
     readonly gqlType: TypeNode;
 } : T, 'loc'>;
-export declare type SingleESTreeNode<T, WithTypeInfo extends boolean> = T extends ASTNode | ValueNode ? SafeGraphQLType<T> & Pick<BaseNode, 'leadingComments' | 'loc' | 'range'> & {
+export declare type TypeInformation = {
+    argument: ReturnType<TypeInfo['getArgument']>;
+    defaultValue: ReturnType<TypeInfo['getDefaultValue']>;
+    directive: ReturnType<TypeInfo['getDirective']>;
+    enumValue: ReturnType<TypeInfo['getEnumValue']>;
+    fieldDef: ReturnType<TypeInfo['getFieldDef']>;
+    inputType: ReturnType<TypeInfo['getInputType']>;
+    parentInputType: ReturnType<TypeInfo['getParentInputType']>;
+    parentType: ReturnType<TypeInfo['getParentType']>;
+    gqlType: ReturnType<TypeInfo['getType']>;
+};
+declare type SingleESTreeNode<T extends ASTNode | ValueNode, WithTypeInfo extends boolean> = SafeGraphQLType<T> & Pick<BaseNode, 'leadingComments' | 'loc' | 'range'> & {
     type: T['kind'];
-} & (WithTypeInfo extends true ? {
-    typeInfo?: () => {
-        argument?: ReturnType<TypeInfo['getArgument']>;
-        defaultValue?: ReturnType<TypeInfo['getDefaultValue']>;
-        directive?: ReturnType<TypeInfo['getDirective']>;
-        enumValue?: ReturnType<TypeInfo['getEnumValue']>;
-        fieldDef?: ReturnType<TypeInfo['getFieldDef']>;
-        inputType?: ReturnType<TypeInfo['getInputType']>;
-        parentInputType?: ReturnType<TypeInfo['getParentInputType']>;
-        parentType?: ReturnType<TypeInfo['getParentType']>;
-        gqlType?: ReturnType<TypeInfo['getType']>;
-    };
-} : {}) : T;
-export declare type GraphQLESTreeNode<T, WithTypeInfo extends boolean = false> = T extends ASTNode | ValueNode ? {
+    typeInfo: () => WithTypeInfo extends true ? TypeInformation : {};
     rawNode: () => T;
-} & {
+};
+export declare type GraphQLESTreeNode<T, WithTypeInfo extends boolean = false> = {} & (T extends ASTNode | ValueNode ? {
     [K in keyof SingleESTreeNode<T, WithTypeInfo>]: SingleESTreeNode<T, WithTypeInfo>[K] extends ReadonlyArray<infer Nested> ? GraphQLESTreeNode<Nested, WithTypeInfo>[] : SingleESTreeNode<T, WithTypeInfo>[K] extends ASTNode ? GraphQLESTreeNode<SingleESTreeNode<T, WithTypeInfo>[K], WithTypeInfo> : SingleESTreeNode<T, WithTypeInfo>[K];
-} : T;
+} : T);
+export {};

package/estree-parser/utils.d.ts

@@ -1,16 +1,12 @@
-import { Location, ValueNode, StringValueNode, ASTNode, TokenKind, GraphQLOutputType, GraphQLNamedType, Token, Source } from 'graphql';
+import { Location, GraphQLOutputType, GraphQLNamedType, Token, Source } from 'graphql';
 import type { Comment } from 'estree';
 import type { AST } from 'eslint';
-import type { GraphQLESTreeNode } from './estree-ast';
-export default function keyValMap<T, V>(list: ReadonlyArray<T>, keyFn: (item: T) => string, valFn: (item: T) => V): Record<string, V>;
-export declare function valueFromNode(valueNode: GraphQLESTreeNode<ValueNode>, variables?: Record<string, any>): any;
+export declare const valueFromNode: (valueNode: import("graphql").ValueNode, variables?: import("graphql/jsutils/ObjMap").ObjMap<unknown>) => any;
 export declare function getBaseType(type: GraphQLOutputType): GraphQLNamedType;
-export declare function convertToken<T extends 'Line' | 'Block' | TokenKind>(token: Token, type: T): Omit<AST.Token, 'type'> & {
+declare type TokenKindValue = '<SOF>' | '!' | '$' | '&' | '(' | ')' | '...' | ':' | '=' | '@' | '[' | ']' | '{' | '|' | '}' | 'Name' | 'Int' | 'Float' | 'String' | 'BlockString' | 'Comment';
+export declare function convertToken<T extends 'Line' | 'Block' | TokenKindValue>(token: Token, type: T): Omit<AST.Token, 'type'> & {
     type: T;
 };
 export declare function extractTokens(source: Source): AST.Token[];
 export declare function extractCommentsFromAst(loc: Location): Comment[];
-export declare function isNodeWithDescription<T extends ASTNode>(obj: T): obj is T & {
-    readonly description?: StringValueNode;
-};
-export declare function convertDescription<T extends ASTNode>(node: T): Comment[];
+export {};

package/index.d.ts

@@ -1,7 +1,11 @@
-export { configs } from './configs';
 export { rules } from './rules';
 export { processors } from './processors';
 export * from './parser';
 export * from './types';
-export * from './estree-parser';
 export * from './testkit';
+export { requireGraphQLSchemaFromContext, requireSiblingsOperations } from './utils';
+export declare const configs: {
+    [k: string]: {
+        extends: string;
+    };
+};