npm - @graphql-eslint/eslint-plugin - Versions diffs - 3.4.0 → 3.5.0 - Mend

@graphql-eslint/eslint-plugin 3.4.0 → 3.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/docs/rules/require-id-when-available.md +2 -2
package/index.js +38 -38
package/index.mjs +38 -38
package/package.json +1 -1
package/rules/index.d.ts +1 -3
package/rules/require-id-when-available.d.ts +2 -2

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

@@ -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 CHANGED Viewed

@@ -2896,7 +2896,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: {
@@ -2904,7 +2905,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: [
@@ -2918,7 +2919,7 @@ const rule$j = {
             }
             # Query
-            query user {
+            query {
               user {
                 name
               }
@@ -2935,7 +2936,7 @@ const rule$j = {
             }
             # Query
-            query user {
+            query {
               user {
                 id
                 name
@@ -2947,7 +2948,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'),
@@ -2978,14 +2979,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;
@@ -3002,53 +3005,50 @@ 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 '),
+                    },
+                });
             },
         };
     },
 };
-const RULE_ID$2 = 'selection-set-depth';
+const RULE_ID$3 = 'selection-set-depth';
 const rule$k = {
     meta: {
         docs: {
             category: 'Operations',
             description: `Limit the complexity of the GraphQL operations solely by their depth. Based on [graphql-depth-limit](https://github.com/stems/graphql-depth-limit).`,
-            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$2}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$3}.md`,
             requiresSiblings: true,
             examples: [
                 {
@@ -3122,10 +3122,10 @@ const rule$k = {
     create(context) {
         let siblings = null;
         try {
-            siblings = requireSiblingsOperations(RULE_ID$2, context);
+            siblings = requireSiblingsOperations(RULE_ID$3, context);
         }
         catch (e) {
-            logger.warn(`Rule "${RULE_ID$2}" works best with siblings operations loaded. For more info: http://bit.ly/graphql-eslint-operations`);
+            logger.warn(`Rule "${RULE_ID$3}" works best with siblings operations loaded. For more info: http://bit.ly/graphql-eslint-operations`);
         }
         const { maxDepth } = context.options[0];
         const ignore = context.options[0].ignore || [];
@@ -3150,7 +3150,7 @@ const rule$k = {
                     });
                 }
                 catch (e) {
-                    logger.warn(`Rule "${RULE_ID$2}" check failed due to a missing siblings operations. For more info: http://bit.ly/graphql-eslint-operations`, e);
+                    logger.warn(`Rule "${RULE_ID$3}" check failed due to a missing siblings operations. For more info: http://bit.ly/graphql-eslint-operations`, e);
                 }
             },
         };

package/index.mjs CHANGED Viewed

@@ -2890,7 +2890,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: {
@@ -2898,7 +2899,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: [
@@ -2912,7 +2913,7 @@ const rule$j = {
             }
             # Query
-            query user {
+            query {
               user {
                 name
               }
@@ -2929,7 +2930,7 @@ const rule$j = {
             }
             # Query
-            query user {
+            query {
               user {
                 id
                 name
@@ -2941,7 +2942,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'),
@@ -2972,14 +2973,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;
@@ -2996,53 +2999,50 @@ 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 '),
+                    },
+                });
             },
         };
     },
 };
-const RULE_ID$2 = 'selection-set-depth';
+const RULE_ID$3 = 'selection-set-depth';
 const rule$k = {
     meta: {
         docs: {
             category: 'Operations',
             description: `Limit the complexity of the GraphQL operations solely by their depth. Based on [graphql-depth-limit](https://github.com/stems/graphql-depth-limit).`,
-            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$2}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$3}.md`,
             requiresSiblings: true,
             examples: [
                 {
@@ -3116,10 +3116,10 @@ const rule$k = {
     create(context) {
         let siblings = null;
         try {
-            siblings = requireSiblingsOperations(RULE_ID$2, context);
+            siblings = requireSiblingsOperations(RULE_ID$3, context);
         }
         catch (e) {
-            logger.warn(`Rule "${RULE_ID$2}" works best with siblings operations loaded. For more info: http://bit.ly/graphql-eslint-operations`);
+            logger.warn(`Rule "${RULE_ID$3}" works best with siblings operations loaded. For more info: http://bit.ly/graphql-eslint-operations`);
         }
         const { maxDepth } = context.options[0];
         const ignore = context.options[0].ignore || [];
@@ -3144,7 +3144,7 @@ const rule$k = {
                     });
                 }
                 catch (e) {
-                    logger.warn(`Rule "${RULE_ID$2}" check failed due to a missing siblings operations. For more info: http://bit.ly/graphql-eslint-operations`, e);
+                    logger.warn(`Rule "${RULE_ID$3}" check failed due to a missing siblings operations. For more info: http://bit.ly/graphql-eslint-operations`, e);
                 }
             },
         };

package/package.json CHANGED Viewed

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

package/rules/index.d.ts CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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;