@graphql-eslint/eslint-plugin 2.3.0-alpha-4c161e5.0 → 2.4.0-alpha-e5163e1.0

package/README.md

@@ -46,7 +46,7 @@ npm install --save-dev @graphql-eslint/eslint-plugin
 
 ### Configuration
 
-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):
+To get started, create an override configuration for your ESLint, while applying it to `.graphql` files (do that even if you are declaring your operations in code files):
 
 ```json
 {

package/docs/custom-rules.md

@@ -38,7 +38,7 @@ const rule: GraphQLESLintRule = {
 So what happens here?
 
 1. `@graphql-eslint/eslint-plugin` handles the parsing process for your GraphQL content. It will load the GraphQL files (either from code files or from `.graphql` files with SDL), parse it using GraphQL parser, converts it to ESTree structure and let ESLint do the rest.
-1. You rule is being loaded by ESLint, and executes just like any other ESLint rule.
+1. Your rule is being loaded by ESLint, and executes just like any other ESLint rule.
 1. Our custom rule asks ESLint to run our function for every `OperationDefinition` found.
 1. If the `OperationDefinition` node doesn't have a valid `name` - we report an error to ESLint.
 
@@ -49,7 +49,7 @@ You can scan the `packages/plugin/src/rules` directory in this repo for referenc
 ## Accessing original GraphQL AST nodes
 
 Since our parser converts GraphQL AST to ESTree structure, there are some minor differences in the structure of the objects.
-If you are using TypeScript, and you typed your rule with `GraphQLESLintRule` - you'll see that each `node` is a bit different from from the AST nodes of GraphQL (you can read more about that in [graphql-eslint parser documentation](./parser.md)).
+If you are using TypeScript, and you typed your rule with `GraphQLESLintRule` - you'll see that each `node` is a bit different from the AST nodes of GraphQL (you can read more about that in [graphql-eslint parser documentation](./parser.md)).
 
 If you need access to the original GraphQL AST `node`, you can use `.rawNode()` method on each node you get from the AST structure of ESLint.
 

package/estree-parser/converter.d.ts

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

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

@@ -5,7 +5,7 @@ export declare type SafeGraphQLType<T extends ASTNode | ValueNode> = Omit<T exte
 } ? Omit<T, 'type'> & {
     readonly gqlType: TypeNode;
 } : T, 'loc'>;
-export declare type SingleESTreeNode<T extends any, WithTypeInfo extends boolean> = T extends ASTNode | ValueNode ? SafeGraphQLType<T> & Pick<BaseNode, 'leadingComments' | 'loc' | 'range'> & {
+export declare type SingleESTreeNode<T, WithTypeInfo extends boolean> = T extends ASTNode | ValueNode ? SafeGraphQLType<T> & Pick<BaseNode, 'leadingComments' | 'loc' | 'range'> & {
     type: T['kind'];
     gqlLocation: Location;
 } & (WithTypeInfo extends true ? {
@@ -21,7 +21,7 @@ export declare type SingleESTreeNode<T extends any, WithTypeInfo extends boolean
         gqlType?: ReturnType<TypeInfo['getType']>;
     };
 } : {}) : T;
-export declare type GraphQLESTreeNode<T extends any, WithTypeInfo extends boolean = false> = T extends ASTNode | ValueNode ? {
+export declare type GraphQLESTreeNode<T, WithTypeInfo extends boolean = false> = T extends ASTNode | ValueNode ? {
     rawNode: () => T;
 } & {
     [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];

package/index.js

@@ -320,6 +320,14 @@ const validationToRule = (name, ruleName, docs, getDocumentNode) => {
         },
     };
 };
+const importFiles = (context) => {
+    const code = context.getSourceCode().text;
+    if (!isGraphQLImportFile(code)) {
+        return null;
+    }
+    // Import documents because file contains '#import' comments
+    return _import.processImport(context.getFilename());
+};
 const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-definitions', 'ExecutableDefinitions', {
     description: `A GraphQL document is only valid for execution if all definitions are either operation or fragment definitions.`,
 }), validationToRule('fields-on-correct-type', 'FieldsOnCorrectType', {
@@ -396,14 +404,7 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
             \``,
         },
     ],
-}, context => {
-    const code = context.getSourceCode().text;
-    if (!isGraphQLImportFile(code)) {
-        return null;
-    }
-    // Import documents because file contains '#import' comments
-    return _import.processImport(context.getFilename());
-}), validationToRule('known-type-names', 'KnownTypeNames', {
+}, importFiles), validationToRule('known-type-names', 'KnownTypeNames', {
     description: `A GraphQL document is only valid if referenced types (specifically variable definitions and fragment conditions) are defined by the type schema.`,
 }), validationToRule('lone-anonymous-operation', 'LoneAnonymousOperation', {
     description: `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.`,
@@ -414,7 +415,7 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
     description: `A GraphQL fragment is only valid when it does not have cycles in fragments usage.`,
 }), validationToRule('no-undefined-variables', 'NoUndefinedVariables', {
     description: `A GraphQL operation is only valid if all variables encountered, both directly and via fragment spreads, are defined by that operation.`,
-}), validationToRule('no-unused-fragments', 'NoUnusedFragments', {
+}, importFiles), validationToRule('no-unused-fragments', 'NoUnusedFragments', {
     description: `A GraphQL document is only valid if all fragment definitions are spread within operations, or spread within other fragments spread within operations.`,
     requiresSiblings: true,
 }, context => {
@@ -445,7 +446,7 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
     return getParentNode(context.getFilename());
 }), validationToRule('no-unused-variables', 'NoUnusedVariables', {
     description: `A GraphQL operation is only valid if all variables defined by an operation are used, either directly or within a spread fragment.`,
-}), validationToRule('overlapping-fields-can-be-merged', 'OverlappingFieldsCanBeMerged', {
+}, importFiles), validationToRule('overlapping-fields-can-be-merged', 'OverlappingFieldsCanBeMerged', {
     description: `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.`,
 }), validationToRule('possible-fragment-spread', 'PossibleFragmentSpreads', {
     description: `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.`,
@@ -789,6 +790,7 @@ const rule$1 = {
         messages: {
             [AVOID_DUPLICATE_FIELDS]: `{{ type }} "{{ fieldName }}" defined multiple times.`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -959,6 +961,7 @@ const rule$3 = {
                 },
             ],
         },
+        schema: [],
     },
     create(context) {
         const schema = requireGraphQLSchemaFromContext('avoid-scalar-result-type-on-mutation', context);
@@ -1014,6 +1017,7 @@ const rule$4 = {
         messages: {
             [AVOID_TYPENAME_PREFIX]: `Field "{{ fieldName }}" starts with the name of the parent type "{{ typeName }}"`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -1727,6 +1731,7 @@ const rule$9 = {
         messages: {
             [NO_ANONYMOUS_OPERATIONS]: `Anonymous GraphQL operations are forbidden. Please make sure to name your {{ operation }}!`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -1790,6 +1795,7 @@ const rule$a = {
         messages: {
             [ERROR_MESSAGE_ID]: `Case-insensitive enum values duplicates are not allowed! Found: "{{ found }}"`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -1884,6 +1890,7 @@ const rule$b = {
         messages: {
             [NO_DEPRECATED]: `This {{ type }} is marked as deprecated in your GraphQL schema {{ reason }}`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -1891,7 +1898,7 @@ const rule$b = {
                 requireGraphQLSchemaFromContext('no-deprecated', context);
                 const typeInfo = node.typeInfo();
                 if (typeInfo && typeInfo.enumValue) {
-                    if (typeInfo.enumValue.isDeprecated) {
+                    if (typeInfo.enumValue.deprecationReason) {
                         context.report({
                             loc: node.loc,
                             messageId: NO_DEPRECATED,
@@ -1907,7 +1914,7 @@ const rule$b = {
                 requireGraphQLSchemaFromContext('no-deprecated', context);
                 const typeInfo = node.typeInfo();
                 if (typeInfo && typeInfo.fieldDef) {
-                    if (typeInfo.fieldDef.isDeprecated) {
+                    if (typeInfo.fieldDef.deprecationReason) {
                         context.report({
                             loc: node.loc,
                             messageId: NO_DEPRECATED,
@@ -1970,6 +1977,7 @@ const rule$c = {
             ],
         },
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         return {
@@ -2030,6 +2038,7 @@ const rule$d = {
         messages: {
             [NO_OPERATION_NAME_SUFFIX]: `Unnecessary "{{ invalidSuffix }}" suffix in your operation name!`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -2095,6 +2104,7 @@ const rule$e = {
         },
         fixable: 'code',
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         const reachableTypes = requireReachableTypesFromContext(RULE_NAME, context);
@@ -2186,6 +2196,7 @@ const rule$f = {
         },
         fixable: 'code',
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         const usedFields = requireUsedFieldsFromContext(RULE_NAME$1, context);
@@ -2451,6 +2462,7 @@ const rule$h = {
             ],
         },
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         return {
@@ -2515,7 +2527,7 @@ const rule$i = {
             examples: [
                 {
                     title: 'Incorrect',
-                    usage: [{ on: ['ObjectTypeDefinition', 'FieldDefinition'] }],
+                    usage: [{ on: [graphql.Kind.OBJECT_TYPE_DEFINITION, graphql.Kind.FIELD_DEFINITION] }],
                     code: /* GraphQL */ `
             type someTypeName {
               name: String
@@ -2524,7 +2536,7 @@ const rule$i = {
                 },
                 {
                     title: 'Correct',
-                    usage: [{ on: ['ObjectTypeDefinition', 'FieldDefinition'] }],
+                    usage: [{ on: [graphql.Kind.OBJECT_TYPE_DEFINITION, graphql.Kind.FIELD_DEFINITION] }],
                     code: /* GraphQL */ `
             """
             Some type description
@@ -2609,6 +2621,7 @@ const rule$j = {
                 },
             ],
         },
+        schema: [],
     },
     create(context) {
         const schema = requireGraphQLSchemaFromContext(RULE_NAME$2, context);
@@ -3228,6 +3241,7 @@ const rule$n = {
         messages: {
             [UNIQUE_FRAGMENT_NAME]: 'Fragment named "{{ documentName }}" already defined in:\n{{ summary }}',
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -3290,6 +3304,7 @@ const rule$o = {
         messages: {
             [UNIQUE_OPERATION_NAME]: 'Operation named "{{ documentName }}" already defined in:\n{{ summary }}',
         },
+        schema: [],
     },
     create(context) {
         return {

package/index.mjs

@@ -314,6 +314,14 @@ const validationToRule = (name, ruleName, docs, getDocumentNode) => {
         },
     };
 };
+const importFiles = (context) => {
+    const code = context.getSourceCode().text;
+    if (!isGraphQLImportFile(code)) {
+        return null;
+    }
+    // Import documents because file contains '#import' comments
+    return processImport(context.getFilename());
+};
 const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-definitions', 'ExecutableDefinitions', {
     description: `A GraphQL document is only valid for execution if all definitions are either operation or fragment definitions.`,
 }), validationToRule('fields-on-correct-type', 'FieldsOnCorrectType', {
@@ -390,14 +398,7 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
             \``,
         },
     ],
-}, context => {
-    const code = context.getSourceCode().text;
-    if (!isGraphQLImportFile(code)) {
-        return null;
-    }
-    // Import documents because file contains '#import' comments
-    return processImport(context.getFilename());
-}), validationToRule('known-type-names', 'KnownTypeNames', {
+}, importFiles), validationToRule('known-type-names', 'KnownTypeNames', {
     description: `A GraphQL document is only valid if referenced types (specifically variable definitions and fragment conditions) are defined by the type schema.`,
 }), validationToRule('lone-anonymous-operation', 'LoneAnonymousOperation', {
     description: `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.`,
@@ -408,7 +409,7 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
     description: `A GraphQL fragment is only valid when it does not have cycles in fragments usage.`,
 }), validationToRule('no-undefined-variables', 'NoUndefinedVariables', {
     description: `A GraphQL operation is only valid if all variables encountered, both directly and via fragment spreads, are defined by that operation.`,
-}), validationToRule('no-unused-fragments', 'NoUnusedFragments', {
+}, importFiles), validationToRule('no-unused-fragments', 'NoUnusedFragments', {
     description: `A GraphQL document is only valid if all fragment definitions are spread within operations, or spread within other fragments spread within operations.`,
     requiresSiblings: true,
 }, context => {
@@ -439,7 +440,7 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
     return getParentNode(context.getFilename());
 }), validationToRule('no-unused-variables', 'NoUnusedVariables', {
     description: `A GraphQL operation is only valid if all variables defined by an operation are used, either directly or within a spread fragment.`,
-}), validationToRule('overlapping-fields-can-be-merged', 'OverlappingFieldsCanBeMerged', {
+}, importFiles), validationToRule('overlapping-fields-can-be-merged', 'OverlappingFieldsCanBeMerged', {
     description: `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.`,
 }), validationToRule('possible-fragment-spread', 'PossibleFragmentSpreads', {
     description: `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.`,
@@ -783,6 +784,7 @@ const rule$1 = {
         messages: {
             [AVOID_DUPLICATE_FIELDS]: `{{ type }} "{{ fieldName }}" defined multiple times.`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -953,6 +955,7 @@ const rule$3 = {
                 },
             ],
         },
+        schema: [],
     },
     create(context) {
         const schema = requireGraphQLSchemaFromContext('avoid-scalar-result-type-on-mutation', context);
@@ -1008,6 +1011,7 @@ const rule$4 = {
         messages: {
             [AVOID_TYPENAME_PREFIX]: `Field "{{ fieldName }}" starts with the name of the parent type "{{ typeName }}"`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -1721,6 +1725,7 @@ const rule$9 = {
         messages: {
             [NO_ANONYMOUS_OPERATIONS]: `Anonymous GraphQL operations are forbidden. Please make sure to name your {{ operation }}!`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -1784,6 +1789,7 @@ const rule$a = {
         messages: {
             [ERROR_MESSAGE_ID]: `Case-insensitive enum values duplicates are not allowed! Found: "{{ found }}"`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -1878,6 +1884,7 @@ const rule$b = {
         messages: {
             [NO_DEPRECATED]: `This {{ type }} is marked as deprecated in your GraphQL schema {{ reason }}`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -1885,7 +1892,7 @@ const rule$b = {
                 requireGraphQLSchemaFromContext('no-deprecated', context);
                 const typeInfo = node.typeInfo();
                 if (typeInfo && typeInfo.enumValue) {
-                    if (typeInfo.enumValue.isDeprecated) {
+                    if (typeInfo.enumValue.deprecationReason) {
                         context.report({
                             loc: node.loc,
                             messageId: NO_DEPRECATED,
@@ -1901,7 +1908,7 @@ const rule$b = {
                 requireGraphQLSchemaFromContext('no-deprecated', context);
                 const typeInfo = node.typeInfo();
                 if (typeInfo && typeInfo.fieldDef) {
-                    if (typeInfo.fieldDef.isDeprecated) {
+                    if (typeInfo.fieldDef.deprecationReason) {
                         context.report({
                             loc: node.loc,
                             messageId: NO_DEPRECATED,
@@ -1964,6 +1971,7 @@ const rule$c = {
             ],
         },
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         return {
@@ -2024,6 +2032,7 @@ const rule$d = {
         messages: {
             [NO_OPERATION_NAME_SUFFIX]: `Unnecessary "{{ invalidSuffix }}" suffix in your operation name!`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -2089,6 +2098,7 @@ const rule$e = {
         },
         fixable: 'code',
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         const reachableTypes = requireReachableTypesFromContext(RULE_NAME, context);
@@ -2180,6 +2190,7 @@ const rule$f = {
         },
         fixable: 'code',
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         const usedFields = requireUsedFieldsFromContext(RULE_NAME$1, context);
@@ -2445,6 +2456,7 @@ const rule$h = {
             ],
         },
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         return {
@@ -2509,7 +2521,7 @@ const rule$i = {
             examples: [
                 {
                     title: 'Incorrect',
-                    usage: [{ on: ['ObjectTypeDefinition', 'FieldDefinition'] }],
+                    usage: [{ on: [Kind.OBJECT_TYPE_DEFINITION, Kind.FIELD_DEFINITION] }],
                     code: /* GraphQL */ `
             type someTypeName {
               name: String
@@ -2518,7 +2530,7 @@ const rule$i = {
                 },
                 {
                     title: 'Correct',
-                    usage: [{ on: ['ObjectTypeDefinition', 'FieldDefinition'] }],
+                    usage: [{ on: [Kind.OBJECT_TYPE_DEFINITION, Kind.FIELD_DEFINITION] }],
                     code: /* GraphQL */ `
             """
             Some type description
@@ -2603,6 +2615,7 @@ const rule$j = {
                 },
             ],
         },
+        schema: [],
     },
     create(context) {
         const schema = requireGraphQLSchemaFromContext(RULE_NAME$2, context);
@@ -3222,6 +3235,7 @@ const rule$n = {
         messages: {
             [UNIQUE_FRAGMENT_NAME]: 'Fragment named "{{ documentName }}" already defined in:\n{{ summary }}',
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -3284,6 +3298,7 @@ const rule$o = {
         messages: {
             [UNIQUE_OPERATION_NAME]: 'Operation named "{{ documentName }}" already defined in:\n{{ summary }}',
         },
+        schema: [],
     },
     create(context) {
         return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "2.3.0-alpha-4c161e5.0",
+  "version": "2.4.0-alpha-e5163e1.0",
   "sideEffects": false,
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0"

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

@@ -1,5 +1,6 @@
-import { GraphQLSchema, DocumentNode, ASTNode, ValidationRule } from 'graphql';
+import { GraphQLSchema, DocumentNode, ASTNode } from 'graphql';
 import { GraphQLESLintRule, GraphQLESLintRuleContext } from '../types';
 import { GraphQLESTreeNode } from '../estree-parser';
-export declare function validateDoc(sourceNode: GraphQLESTreeNode<ASTNode>, context: GraphQLESLintRuleContext, schema: GraphQLSchema | null, documentNode: DocumentNode, rules: ReadonlyArray<ValidationRule>, ruleName?: string | null): void;
+import { SDLValidationRule } from 'graphql/validation/ValidationContext';
+export declare function validateDoc(sourceNode: GraphQLESTreeNode<ASTNode>, context: GraphQLESLintRuleContext, schema: GraphQLSchema | null, documentNode: DocumentNode, rules: ReadonlyArray<SDLValidationRule>, ruleName?: string | null): void;
 export declare const GRAPHQL_JS_VALIDATIONS: Record<string, GraphQLESLintRule<any[], false>>;