@graphql-eslint/eslint-plugin 3.8.0 → 3.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.8.0",
+  "version": "3.9.0",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {

package/rules/alphabetize.d.ts

@@ -10,6 +10,7 @@ export declare type AlphabetizeConfig = {
     selections?: typeof selectionsEnum;
     variables?: typeof variablesEnum;
     arguments?: typeof argumentsEnum;
+    definitions?: boolean;
 };
 declare const rule: GraphQLESLintRule<[AlphabetizeConfig]>;
 export default rule;

package/rules/graphql-js-validation.d.ts

@@ -1,2 +1,2 @@
-import { GraphQLESLintRule } from '../types';
+import type { GraphQLESLintRule } from '../types';
 export declare const GRAPHQL_JS_VALIDATIONS: Record<string, GraphQLESLintRule>;

package/rules/index.d.ts

@@ -30,10 +30,7 @@ export declare const rules: {
     'require-description': import("..").GraphQLESLintRule<[import("./require-description").RequireDescriptionRuleConfig], false>;
     'require-field-of-type-query-in-mutation-result': import("..").GraphQLESLintRule<any[], false>;
     'require-id-when-available': import("..").GraphQLESLintRule<[import("./require-id-when-available").RequireIdWhenAvailableRuleConfig], true>;
-    'selection-set-depth': import("..").GraphQLESLintRule<[{
-        maxDepth: number;
-        ignore?: string[];
-    }], false>;
+    'selection-set-depth': import("..").GraphQLESLintRule<[import("./selection-set-depth").SelectionSetDepthRuleConfig], false>;
     'strict-id-in-types': import("..").GraphQLESLintRule<[import("./strict-id-in-types").StrictIdInTypesRuleConfig], false>;
     'unique-fragment-name': import("..").GraphQLESLintRule<any[], false>;
     'unique-operation-name': import("..").GraphQLESLintRule<any[], false>;

package/rules/selection-set-depth.d.ts

@@ -1,5 +1,5 @@
 import { GraphQLESLintRule } from '../types';
-declare type SelectionSetDepthRuleConfig = {
+export declare type SelectionSetDepthRuleConfig = {
     maxDepth: number;
     ignore?: string[];
 };

package/sibling-operations.d.ts

@@ -11,12 +11,12 @@ export declare type OperationSource = {
 };
 export declare type SiblingOperations = {
     available: boolean;
-    getOperations(): OperationSource[];
-    getFragments(): FragmentSource[];
     getFragment(fragmentName: string): FragmentSource[];
+    getFragments(): FragmentSource[];
     getFragmentByType(typeName: string): FragmentSource[];
-    getFragmentsInUse(baseOperation: OperationDefinitionNode | FragmentDefinitionNode | SelectionSetNode, recursive: boolean): FragmentDefinitionNode[];
+    getFragmentsInUse(baseOperation: OperationDefinitionNode | FragmentDefinitionNode | SelectionSetNode, recursive?: boolean): FragmentDefinitionNode[];
     getOperation(operationName: string): OperationSource[];
+    getOperations(): OperationSource[];
     getOperationByType(operationType: OperationTypeNode): OperationSource[];
 };
 export declare function getSiblingOperations(options: ParserOptions, gqlConfig: GraphQLConfig): SiblingOperations;

package/testkit.d.ts

@@ -20,8 +20,8 @@ export declare class GraphQLRuleTester extends RuleTester {
     };
     constructor(parserOptions?: ParserOptions);
     fromMockFile(path: string): string;
-    runGraphQLTests<Config>(name: string, rule: GraphQLESLintRule, tests: {
-        valid: (string | GraphQLValidTestCase<Config>)[];
-        invalid: GraphQLInvalidTestCase<Config>[];
+    runGraphQLTests<Options, WithTypeInfo extends boolean = false>(name: string, rule: GraphQLESLintRule<Options, WithTypeInfo>, tests: {
+        valid: (string | GraphQLValidTestCase<Options>)[];
+        invalid: GraphQLInvalidTestCase<Options>[];
     }): void;
 }

package/types.d.ts

@@ -1,11 +1,11 @@
-import { Rule, AST, Linter } from 'eslint';
-import { ASTNode, GraphQLSchema } from 'graphql';
-import { GraphQLParseOptions } from '@graphql-tools/utils';
-import { IExtensions, IGraphQLProject, DocumentPointer, SchemaPointer } from 'graphql-config';
-import { GraphQLESLintRuleListener } from './testkit';
-import { GraphQLESTreeNode } from './estree-parser';
-import { SiblingOperations } from './sibling-operations';
-import { getReachableTypes, getUsedFields } from './graphql-ast';
+import type { Rule, AST, Linter } from 'eslint';
+import type * as ESTree from 'estree';
+import type { ASTNode, GraphQLSchema } from 'graphql';
+import type { IExtensions, IGraphQLProject, DocumentPointer, SchemaPointer } from 'graphql-config';
+import type { GraphQLParseOptions } from '@graphql-tools/utils';
+import type { GraphQLESLintRuleListener } from './testkit';
+import type { GraphQLESTreeNode } from './estree-parser';
+import type { SiblingOperations } from './sibling-operations';
 export interface ParserOptions {
     schema?: SchemaPointer | Record<string, {
         headers: Record<string, string>;
@@ -27,22 +27,19 @@ export declare type ParserServices = {
     hasTypeInfo: boolean;
     schema: GraphQLSchema | null;
     siblingOperations: SiblingOperations;
-    reachableTypes: typeof getReachableTypes;
-    usedFields: typeof getUsedFields;
 };
 export declare type GraphQLESLintParseResult = Linter.ESLintParseResult & {
     services: ParserServices;
 };
+declare type ReportDescriptorLocation = {
+    node: GraphQLESTreeNode<ASTNode>;
+} | {
+    loc: AST.SourceLocation | ESTree.Position;
+};
+export declare type ReportDescriptor = Rule.ReportDescriptorMessage & Rule.ReportDescriptorOptions & ReportDescriptorLocation;
 export declare type GraphQLESLintRuleContext<Options = any[]> = Omit<Rule.RuleContext, 'parserServices' | 'report' | 'options'> & {
     options: Options;
-    report(descriptor: Rule.ReportDescriptorMessage & Rule.ReportDescriptorOptions & ({
-        node: GraphQLESTreeNode<ASTNode>;
-    } | {
-        loc: AST.SourceLocation | {
-            line: number;
-            column: number;
-        };
-    })): void;
+    report(descriptor: ReportDescriptor): void;
     parserServices?: ParserServices;
 };
 export declare type CategoryType = 'Schema' | 'Operations';
@@ -61,6 +58,7 @@ export declare type RuleDocsInfo<T> = {
             operations?: T;
         };
         graphQLJSRuleName?: string;
+        isDisabledForAllConfig?: true;
     };
 };
 export declare type GraphQLESLintRule<Options = any[], WithTypeInfo extends boolean = false> = {
@@ -68,3 +66,11 @@ export declare type GraphQLESLintRule<Options = any[], WithTypeInfo extends bool
     meta: Omit<Rule.RuleMetaData, 'docs'> & RuleDocsInfo<Options>;
 };
 export declare type ValueOf<T> = T[keyof T];
+declare type Id<T> = {} & {
+    [P in keyof T]: T[P];
+};
+declare type OmitDistributive<T, K extends PropertyKey> = T extends object ? Id<OmitRecursively<T, K>> : T;
+export declare type OmitRecursively<T extends object, K extends PropertyKey> = Omit<{
+    [P in keyof T]: OmitDistributive<T[P], K>;
+}, K>;
+export {};

package/utils.d.ts

@@ -3,15 +3,13 @@ import type { AST } from 'eslint';
 import { Source as LoaderSource } from '@graphql-tools/utils';
 import { GraphQLESLintRuleContext } from './types';
 import { SiblingOperations } from './sibling-operations';
-import { ReachableTypes, UsedFields } from './graphql-ast';
+import type * as ESTree from 'estree';
 export declare function requireSiblingsOperations(ruleName: string, context: GraphQLESLintRuleContext): SiblingOperations | never;
 export declare function requireGraphQLSchemaFromContext(ruleName: string, context: GraphQLESLintRuleContext): GraphQLSchema | never;
 export declare const logger: {
     error: (...args: any[]) => void;
     warn: (...args: any[]) => void;
 };
-export declare function requireReachableTypesFromContext(ruleName: string, context: GraphQLESLintRuleContext): ReachableTypes | never;
-export declare function requireUsedFieldsFromContext(ruleName: string, context: GraphQLESLintRuleContext): UsedFields | never;
 export declare const normalizePath: (path: string) => string;
 /**
  * https://github.com/prettier/eslint-plugin-prettier/blob/76bd45ece6d56eb52f75db6b4a1efdd2efb56392/eslint-plugin-prettier.js#L71
@@ -26,4 +24,16 @@ export declare const TYPES_KINDS: readonly [Kind.OBJECT_TYPE_DEFINITION, Kind.IN
 export declare type CaseStyle = 'camelCase' | 'PascalCase' | 'snake_case' | 'UPPER_CASE' | 'kebab-case';
 export declare const camelCase: (str: string) => string;
 export declare const convertCase: (style: CaseStyle, str: string) => string;
-export declare function getLocation(loc: Partial<AST.SourceLocation>, fieldName?: string): AST.SourceLocation;
+export declare function getLocation(start: ESTree.Position, fieldName?: string): AST.SourceLocation;
+export declare const REPORT_ON_FIRST_CHARACTER: {
+    column: number;
+    line: number;
+};
+export declare const ARRAY_DEFAULT_OPTIONS: {
+    readonly type: "array";
+    readonly uniqueItems: true;
+    readonly minItems: 1;
+    readonly items: {
+        readonly type: "string";
+    };
+};

package/configs/base.d.ts

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

package/configs/index.d.ts

@@ -1,133 +0,0 @@
-export declare const configs: {
-    base: {
-        parser: string;
-        plugins: string[];
-    };
-    'schema-recommended': {
-        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;
-                FieldDefinition: string;
-                InputValueDefinition: string;
-                Argument: string;
-                DirectiveDefinition: 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/provided-required-arguments': string;
-            '@graphql-eslint/require-deprecation-reason': string;
-            '@graphql-eslint/require-description': (string | {
-                types: boolean;
-                DirectiveDefinition: boolean;
-            })[];
-            '@graphql-eslint/strict-id-in-types': string;
-            '@graphql-eslint/unique-directive-names': string;
-            '@graphql-eslint/unique-directive-names-per-location': string;
-            '@graphql-eslint/unique-field-definition-names': string;
-            '@graphql-eslint/unique-operation-types': string;
-            '@graphql-eslint/unique-type-names': string;
-        };
-    };
-    'schema-all': {
-        extends: string[];
-        rules: {
-            '@graphql-eslint/alphabetize': (string | {
-                fields: string[];
-                values: string[];
-                arguments: string[];
-            })[];
-            '@graphql-eslint/input-name': string;
-            '@graphql-eslint/no-scalar-result-type-on-mutation': string;
-            '@graphql-eslint/require-deprecation-date': string;
-            '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
-        };
-    };
-    'operations-recommended': {
-        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 | {
-                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;
-        };
-    };
-    '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

@@ -1,19 +0,0 @@
-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

@@ -1,50 +0,0 @@
-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 | {
-            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

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

package/configs/schema-recommended.d.ts

@@ -1,47 +0,0 @@
-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;
-            FieldDefinition: string;
-            InputValueDefinition: string;
-            Argument: string;
-            DirectiveDefinition: 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/provided-required-arguments': string;
-        '@graphql-eslint/require-deprecation-reason': string;
-        '@graphql-eslint/require-description': (string | {
-            types: boolean;
-            DirectiveDefinition: boolean;
-        })[];
-        '@graphql-eslint/strict-id-in-types': string;
-        '@graphql-eslint/unique-directive-names': string;
-        '@graphql-eslint/unique-directive-names-per-location': string;
-        '@graphql-eslint/unique-field-definition-names': string;
-        '@graphql-eslint/unique-operation-types': string;
-        '@graphql-eslint/unique-type-names': string;
-    };
-};
-export default _default;

package/graphql-ast.d.ts

@@ -1,6 +0,0 @@
-import { GraphQLSchema } from 'graphql';
-import { SiblingOperations } from './sibling-operations';
-export declare type ReachableTypes = Set<string>;
-export declare function getReachableTypes(schema: GraphQLSchema): ReachableTypes;
-export declare type UsedFields = Record<string, Set<string>>;
-export declare function getUsedFields(schema: GraphQLSchema, operations: SiblingOperations): UsedFields;