@graphql-eslint/eslint-plugin 3.3.0-alpha-db2c2cb.0 → 3.3.0-alpha-0df1b98.0

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

@@ -23,7 +23,7 @@ type User {
 }
 
 # Query
-query user {
+query {
   user {
     name
   }
@@ -42,7 +42,7 @@ type User {
 }
 
 # Query
-query user {
+query {
   user {
     id
     name

package/index.js

@@ -2866,7 +2866,8 @@ const convertNode = (typeInfo) => (node, key, parent) => {
     }
 };
 
-const REQUIRE_ID_WHEN_AVAILABLE = 'REQUIRE_ID_WHEN_AVAILABLE';
+const RULE_ID$2 = 'require-id-when-available';
+const MESSAGE_ID = 'REQUIRE_ID_WHEN_AVAILABLE';
 const DEFAULT_ID_FIELD_NAME = 'id';
 const rule$j = {
     meta: {
@@ -2874,7 +2875,7 @@ const rule$j = {
         docs: {
             category: 'Operations',
             description: 'Enforce selecting specific fields when they are available on the GraphQL type.',
-            url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/require-id-when-available.md',
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$2}.md`,
             requiresSchema: true,
             requiresSiblings: true,
             examples: [
@@ -2888,7 +2889,7 @@ const rule$j = {
             }
 
             # Query
-            query user {
+            query {
               user {
                 name
               }
@@ -2905,7 +2906,7 @@ const rule$j = {
             }
 
             # Query
-            query user {
+            query {
               user {
                 id
                 name
@@ -2917,7 +2918,7 @@ const rule$j = {
             recommended: true,
         },
         messages: {
-            [REQUIRE_ID_WHEN_AVAILABLE]: [
+            [MESSAGE_ID]: [
                 `Field {{ fieldName }} must be selected when it's available on a type. Please make sure to include it in your selection set!`,
                 `If you are using fragments, make sure that all used fragments {{ checkedFragments }}specifies the field {{ fieldName }}.`,
             ].join('\n'),
@@ -2948,14 +2949,16 @@ const rule$j = {
         },
     },
     create(context) {
-        requireGraphQLSchemaFromContext('require-id-when-available', context);
-        const siblings = requireSiblingsOperations('require-id-when-available', context);
+        requireGraphQLSchemaFromContext(RULE_ID$2, context);
+        const siblings = requireSiblingsOperations(RULE_ID$2, context);
         const { fieldName = DEFAULT_ID_FIELD_NAME } = context.options[0] || {};
-        const idNames = Array.isArray(fieldName) ? fieldName : [fieldName];
+        const idNames = utils.asArray(fieldName);
         const isFound = (s) => s.kind === graphql.Kind.FIELD && idNames.includes(s.name.value);
+        // Skip check selections in FragmentDefinition
+        const selector = 'OperationDefinition SelectionSet[parent.kind!=OperationDefinition]';
         return {
-            SelectionSet(node) {
-                var _a, _b;
+            [selector](node) {
+                var _a;
                 const typeInfo = node.typeInfo();
                 if (!typeInfo.gqlType) {
                     return;
@@ -2972,41 +2975,38 @@ const rule$j = {
                     return;
                 }
                 const checkedFragmentSpreads = new Set();
-                let found = false;
                 for (const selection of node.selections) {
                     if (isFound(selection)) {
-                        found = true;
+                        return;
                     }
-                    else if (selection.kind === graphql.Kind.INLINE_FRAGMENT) {
-                        found = (_a = selection.selectionSet) === null || _a === void 0 ? void 0 : _a.selections.some(s => isFound(s));
+                    if (selection.kind === graphql.Kind.INLINE_FRAGMENT && selection.selectionSet.selections.some(isFound)) {
+                        return;
                     }
-                    else if (selection.kind === graphql.Kind.FRAGMENT_SPREAD) {
+                    if (selection.kind === graphql.Kind.FRAGMENT_SPREAD) {
                         const [foundSpread] = siblings.getFragment(selection.name.value);
                         if (foundSpread) {
                             checkedFragmentSpreads.add(foundSpread.document.name.value);
-                            found = (_b = foundSpread.document.selectionSet) === null || _b === void 0 ? void 0 : _b.selections.some(s => isFound(s));
+                            if (foundSpread.document.selectionSet.selections.some(isFound)) {
+                                return;
+                            }
                         }
                     }
-                    if (found) {
-                        break;
-                    }
                 }
                 const { parent } = node;
-                const hasIdFieldInInterfaceSelectionSet = parent &&
-                    parent.kind === graphql.Kind.INLINE_FRAGMENT &&
-                    parent.parent &&
-                    parent.parent.kind === graphql.Kind.SELECTION_SET &&
-                    parent.parent.selections.some(s => isFound(s));
-                if (!found && !hasIdFieldInInterfaceSelectionSet) {
-                    context.report({
-                        loc: getLocation(node.loc),
-                        messageId: REQUIRE_ID_WHEN_AVAILABLE,
-                        data: {
-                            checkedFragments: checkedFragmentSpreads.size === 0 ? '' : `(${[...checkedFragmentSpreads].join(', ')}) `,
-                            fieldName: idNames.map(name => `"${name}"`).join(' or '),
-                        },
-                    });
+                const hasIdFieldInInterfaceSelectionSet = (parent === null || parent === void 0 ? void 0 : parent.kind) === graphql.Kind.INLINE_FRAGMENT &&
+                    ((_a = parent.parent) === null || _a === void 0 ? void 0 : _a.kind) === graphql.Kind.SELECTION_SET &&
+                    parent.parent.selections.some(isFound);
+                if (hasIdFieldInInterfaceSelectionSet) {
+                    return;
                 }
+                context.report({
+                    loc: getLocation(node.loc),
+                    messageId: MESSAGE_ID,
+                    data: {
+                        checkedFragments: checkedFragmentSpreads.size === 0 ? '' : `(${[...checkedFragmentSpreads].join(', ')}) `,
+                        fieldName: idNames.map(name => `"${name}"`).join(' or '),
+                    },
+                });
             },
         };
     },

package/index.mjs

@@ -2860,7 +2860,8 @@ const convertNode = (typeInfo) => (node, key, parent) => {
     }
 };
 
-const REQUIRE_ID_WHEN_AVAILABLE = 'REQUIRE_ID_WHEN_AVAILABLE';
+const RULE_ID$2 = 'require-id-when-available';
+const MESSAGE_ID = 'REQUIRE_ID_WHEN_AVAILABLE';
 const DEFAULT_ID_FIELD_NAME = 'id';
 const rule$j = {
     meta: {
@@ -2868,7 +2869,7 @@ const rule$j = {
         docs: {
             category: 'Operations',
             description: 'Enforce selecting specific fields when they are available on the GraphQL type.',
-            url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/require-id-when-available.md',
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$2}.md`,
             requiresSchema: true,
             requiresSiblings: true,
             examples: [
@@ -2882,7 +2883,7 @@ const rule$j = {
             }
 
             # Query
-            query user {
+            query {
               user {
                 name
               }
@@ -2899,7 +2900,7 @@ const rule$j = {
             }
 
             # Query
-            query user {
+            query {
               user {
                 id
                 name
@@ -2911,7 +2912,7 @@ const rule$j = {
             recommended: true,
         },
         messages: {
-            [REQUIRE_ID_WHEN_AVAILABLE]: [
+            [MESSAGE_ID]: [
                 `Field {{ fieldName }} must be selected when it's available on a type. Please make sure to include it in your selection set!`,
                 `If you are using fragments, make sure that all used fragments {{ checkedFragments }}specifies the field {{ fieldName }}.`,
             ].join('\n'),
@@ -2942,14 +2943,16 @@ const rule$j = {
         },
     },
     create(context) {
-        requireGraphQLSchemaFromContext('require-id-when-available', context);
-        const siblings = requireSiblingsOperations('require-id-when-available', context);
+        requireGraphQLSchemaFromContext(RULE_ID$2, context);
+        const siblings = requireSiblingsOperations(RULE_ID$2, context);
         const { fieldName = DEFAULT_ID_FIELD_NAME } = context.options[0] || {};
-        const idNames = Array.isArray(fieldName) ? fieldName : [fieldName];
+        const idNames = asArray(fieldName);
         const isFound = (s) => s.kind === Kind.FIELD && idNames.includes(s.name.value);
+        // Skip check selections in FragmentDefinition
+        const selector = 'OperationDefinition SelectionSet[parent.kind!=OperationDefinition]';
         return {
-            SelectionSet(node) {
-                var _a, _b;
+            [selector](node) {
+                var _a;
                 const typeInfo = node.typeInfo();
                 if (!typeInfo.gqlType) {
                     return;
@@ -2966,41 +2969,38 @@ const rule$j = {
                     return;
                 }
                 const checkedFragmentSpreads = new Set();
-                let found = false;
                 for (const selection of node.selections) {
                     if (isFound(selection)) {
-                        found = true;
+                        return;
                     }
-                    else if (selection.kind === Kind.INLINE_FRAGMENT) {
-                        found = (_a = selection.selectionSet) === null || _a === void 0 ? void 0 : _a.selections.some(s => isFound(s));
+                    if (selection.kind === Kind.INLINE_FRAGMENT && selection.selectionSet.selections.some(isFound)) {
+                        return;
                     }
-                    else if (selection.kind === Kind.FRAGMENT_SPREAD) {
+                    if (selection.kind === Kind.FRAGMENT_SPREAD) {
                         const [foundSpread] = siblings.getFragment(selection.name.value);
                         if (foundSpread) {
                             checkedFragmentSpreads.add(foundSpread.document.name.value);
-                            found = (_b = foundSpread.document.selectionSet) === null || _b === void 0 ? void 0 : _b.selections.some(s => isFound(s));
+                            if (foundSpread.document.selectionSet.selections.some(isFound)) {
+                                return;
+                            }
                         }
                     }
-                    if (found) {
-                        break;
-                    }
                 }
                 const { parent } = node;
-                const hasIdFieldInInterfaceSelectionSet = parent &&
-                    parent.kind === Kind.INLINE_FRAGMENT &&
-                    parent.parent &&
-                    parent.parent.kind === Kind.SELECTION_SET &&
-                    parent.parent.selections.some(s => isFound(s));
-                if (!found && !hasIdFieldInInterfaceSelectionSet) {
-                    context.report({
-                        loc: getLocation(node.loc),
-                        messageId: REQUIRE_ID_WHEN_AVAILABLE,
-                        data: {
-                            checkedFragments: checkedFragmentSpreads.size === 0 ? '' : `(${[...checkedFragmentSpreads].join(', ')}) `,
-                            fieldName: idNames.map(name => `"${name}"`).join(' or '),
-                        },
-                    });
+                const hasIdFieldInInterfaceSelectionSet = (parent === null || parent === void 0 ? void 0 : parent.kind) === Kind.INLINE_FRAGMENT &&
+                    ((_a = parent.parent) === null || _a === void 0 ? void 0 : _a.kind) === Kind.SELECTION_SET &&
+                    parent.parent.selections.some(isFound);
+                if (hasIdFieldInInterfaceSelectionSet) {
+                    return;
                 }
+                context.report({
+                    loc: getLocation(node.loc),
+                    messageId: MESSAGE_ID,
+                    data: {
+                        checkedFragments: checkedFragmentSpreads.size === 0 ? '' : `(${[...checkedFragmentSpreads].join(', ')}) `,
+                        fieldName: idNames.map(name => `"${name}"`).join(' or '),
+                    },
+                });
             },
         };
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.3.0-alpha-db2c2cb.0",
+  "version": "3.3.0-alpha-0df1b98.0",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {
@@ -10,7 +10,7 @@
     "@babel/code-frame": "7.16.0",
     "@graphql-tools/code-file-loader": "7.2.3",
     "@graphql-tools/graphql-tag-pluck": "7.1.4",
-    "@graphql-tools/utils": "8.5.4",
+    "@graphql-tools/utils": "8.5.5",
     "graphql-config": "4.1.0",
     "graphql-depth-limit": "1.1.0",
     "lodash.lowercase": "4.3.0"
@@ -31,6 +31,7 @@
     "definition": "index.d.ts"
   },
   "exports": {
+    "./package.json": "./package.json",
     ".": {
       "require": "./index.js",
       "import": "./index.mjs"

package/rules/index.d.ts

@@ -48,9 +48,7 @@ export declare const rules: {
         DirectiveDefinition?: boolean;
     }], false>;
     'require-field-of-type-query-in-mutation-result': import("..").GraphQLESLintRule<any[], false>;
-    'require-id-when-available': import("..").GraphQLESLintRule<[{
-        fieldName: string;
-    }], true>;
+    'require-id-when-available': import("..").GraphQLESLintRule<[import("./require-id-when-available").RequireIdWhenAvailableRuleConfig], true>;
     'selection-set-depth': import("..").GraphQLESLintRule<[{
         maxDepth: number;
         ignore?: string[];

package/rules/require-id-when-available.d.ts

@@ -1,6 +1,6 @@
 import { GraphQLESLintRule } from '../types';
-declare type RequireIdWhenAvailableRuleConfig = {
-    fieldName: string;
+export declare type RequireIdWhenAvailableRuleConfig = {
+    fieldName: string | string[];
 };
 declare const rule: GraphQLESLintRule<[RequireIdWhenAvailableRuleConfig], true>;
 export default rule;