@graphql-eslint/eslint-plugin 3.0.1 → 3.1.0-alpha-878c908.0

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

@@ -54,10 +54,25 @@ query user {
 
 The schema defines the following properties:
 
-### `fieldName` (string)
+### `fieldName`
+
+The object must be one of the following types:
+
+* `asString`
+* `asArray`
 
 Default: `"id"`
 
+---
+
+# Sub Schemas
+
+The schema defines the following additional types:
+
+## `asString` (string)
+
+## `asArray` (array)
+
 ## Resources
 
 - [Rule source](../../packages/plugin/src/rules/require-id-when-available.ts)

package/index.js

@@ -2852,9 +2852,22 @@ const rule$j = {
             recommended: true,
         },
         messages: {
-            [REQUIRE_ID_WHEN_AVAILABLE]: `Field "{{ fieldName }}" must be selected when it's available on a type. Please make sure to include it in your selection set!\nIf you are using fragments, make sure that all used fragments {{ checkedFragments }} specifies the field "{{ fieldName }}".`,
+            [REQUIRE_ID_WHEN_AVAILABLE]: [
+                `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'),
         },
         schema: {
+            definitions: {
+                asString: {
+                    type: 'string',
+                },
+                asArray: {
+                    type: 'array',
+                    minItems: 1,
+                    uniqueItems: true,
+                },
+            },
             type: 'array',
             maxItems: 1,
             items: {
@@ -2862,7 +2875,7 @@ const rule$j = {
                 additionalProperties: false,
                 properties: {
                     fieldName: {
-                        type: 'string',
+                        oneOf: [{ $ref: '#/definitions/asString' }, { $ref: '#/definitions/asArray' }],
                         default: DEFAULT_ID_FIELD_NAME,
                     },
                 },
@@ -2870,69 +2883,64 @@ const rule$j = {
         },
     },
     create(context) {
+        requireGraphQLSchemaFromContext('require-id-when-available', context);
+        const siblings = requireSiblingsOperations('require-id-when-available', context);
+        const { fieldName = DEFAULT_ID_FIELD_NAME } = context.options[0] || {};
+        const idNames = Array.isArray(fieldName) ? fieldName : [fieldName];
+        const isFound = (s) => s.kind === graphql.Kind.FIELD && idNames.includes(s.name.value);
         return {
             SelectionSet(node) {
                 var _a, _b;
-                requireGraphQLSchemaFromContext('require-id-when-available', context);
-                const siblings = requireSiblingsOperations('require-id-when-available', context);
-                const fieldName = (context.options[0] || {}).fieldName || DEFAULT_ID_FIELD_NAME;
-                if (!node.selections || node.selections.length === 0) {
+                const typeInfo = node.typeInfo();
+                if (!typeInfo.gqlType) {
                     return;
                 }
-                const typeInfo = node.typeInfo();
-                if (typeInfo && typeInfo.gqlType) {
-                    const rawType = getBaseType(typeInfo.gqlType);
-                    if (rawType instanceof graphql.GraphQLObjectType || rawType instanceof graphql.GraphQLInterfaceType) {
-                        const fields = rawType.getFields();
-                        const hasIdFieldInType = !!fields[fieldName];
-                        const checkedFragmentSpreads = new Set();
-                        if (hasIdFieldInType) {
-                            let found = false;
-                            for (const selection of node.selections) {
-                                if (selection.kind === 'Field' && selection.name.value === fieldName) {
-                                    found = true;
-                                }
-                                else if (selection.kind === 'InlineFragment') {
-                                    found = (((_a = selection.selectionSet) === null || _a === void 0 ? void 0 : _a.selections) || []).some(s => s.kind === 'Field' && s.name.value === fieldName);
-                                }
-                                else if (selection.kind === 'FragmentSpread') {
-                                    const foundSpread = siblings.getFragment(selection.name.value);
-                                    if (foundSpread[0]) {
-                                        checkedFragmentSpreads.add(foundSpread[0].document.name.value);
-                                        found = (((_b = foundSpread[0].document.selectionSet) === null || _b === void 0 ? void 0 : _b.selections) || []).some(s => s.kind === 'Field' && s.name.value === fieldName);
-                                    }
-                                }
-                                if (found) {
-                                    break;
-                                }
-                            }
-                            const { parent } = node;
-                            const hasIdFieldInInterfaceSelectionSet = parent &&
-                                parent.kind === 'InlineFragment' &&
-                                parent.parent &&
-                                parent.parent.kind === 'SelectionSet' &&
-                                parent.parent.selections.some(s => s.kind === 'Field' && s.name.value === fieldName);
-                            if (!found && !hasIdFieldInInterfaceSelectionSet) {
-                                context.report({
-                                    loc: {
-                                        start: {
-                                            line: node.loc.start.line,
-                                            column: node.loc.start.column - 1,
-                                        },
-                                        end: {
-                                            line: node.loc.end.line,
-                                            column: node.loc.end.column - 1,
-                                        },
-                                    },
-                                    messageId: REQUIRE_ID_WHEN_AVAILABLE,
-                                    data: {
-                                        checkedFragments: checkedFragmentSpreads.size === 0 ? '' : `(${Array.from(checkedFragmentSpreads).join(', ')})`,
-                                        fieldName,
-                                    },
-                                });
-                            }
+                const rawType = getBaseType(typeInfo.gqlType);
+                const isObjectType = rawType instanceof graphql.GraphQLObjectType;
+                const isInterfaceType = rawType instanceof graphql.GraphQLInterfaceType;
+                if (!isObjectType && !isInterfaceType) {
+                    return;
+                }
+                const fields = rawType.getFields();
+                const hasIdFieldInType = idNames.some(name => fields[name]);
+                if (!hasIdFieldInType) {
+                    return;
+                }
+                const checkedFragmentSpreads = new Set();
+                let found = false;
+                for (const selection of node.selections) {
+                    if (isFound(selection)) {
+                        found = true;
+                    }
+                    else if (selection.kind === graphql.Kind.INLINE_FRAGMENT) {
+                        found = (_a = selection.selectionSet) === null || _a === void 0 ? void 0 : _a.selections.some(s => isFound(s));
+                    }
+                    else 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 (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 '),
+                        },
+                    });
                 }
             },
         };
@@ -3024,7 +3032,7 @@ const rule$k = {
             // eslint-disable-next-line no-console
             console.warn(`Rule "selection-set-depth" works best with siblings operations loaded. For more info: http://bit.ly/graphql-eslint-operations`);
         }
-        const maxDepth = context.options[0].maxDepth;
+        const { maxDepth } = context.options[0];
         const ignore = context.options[0].ignore || [];
         const checkFn = depthLimit(maxDepth, { ignore });
         return {

package/index.mjs

@@ -2846,9 +2846,22 @@ const rule$j = {
             recommended: true,
         },
         messages: {
-            [REQUIRE_ID_WHEN_AVAILABLE]: `Field "{{ fieldName }}" must be selected when it's available on a type. Please make sure to include it in your selection set!\nIf you are using fragments, make sure that all used fragments {{ checkedFragments }} specifies the field "{{ fieldName }}".`,
+            [REQUIRE_ID_WHEN_AVAILABLE]: [
+                `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'),
         },
         schema: {
+            definitions: {
+                asString: {
+                    type: 'string',
+                },
+                asArray: {
+                    type: 'array',
+                    minItems: 1,
+                    uniqueItems: true,
+                },
+            },
             type: 'array',
             maxItems: 1,
             items: {
@@ -2856,7 +2869,7 @@ const rule$j = {
                 additionalProperties: false,
                 properties: {
                     fieldName: {
-                        type: 'string',
+                        oneOf: [{ $ref: '#/definitions/asString' }, { $ref: '#/definitions/asArray' }],
                         default: DEFAULT_ID_FIELD_NAME,
                     },
                 },
@@ -2864,69 +2877,64 @@ const rule$j = {
         },
     },
     create(context) {
+        requireGraphQLSchemaFromContext('require-id-when-available', context);
+        const siblings = requireSiblingsOperations('require-id-when-available', context);
+        const { fieldName = DEFAULT_ID_FIELD_NAME } = context.options[0] || {};
+        const idNames = Array.isArray(fieldName) ? fieldName : [fieldName];
+        const isFound = (s) => s.kind === Kind.FIELD && idNames.includes(s.name.value);
         return {
             SelectionSet(node) {
                 var _a, _b;
-                requireGraphQLSchemaFromContext('require-id-when-available', context);
-                const siblings = requireSiblingsOperations('require-id-when-available', context);
-                const fieldName = (context.options[0] || {}).fieldName || DEFAULT_ID_FIELD_NAME;
-                if (!node.selections || node.selections.length === 0) {
+                const typeInfo = node.typeInfo();
+                if (!typeInfo.gqlType) {
                     return;
                 }
-                const typeInfo = node.typeInfo();
-                if (typeInfo && typeInfo.gqlType) {
-                    const rawType = getBaseType(typeInfo.gqlType);
-                    if (rawType instanceof GraphQLObjectType || rawType instanceof GraphQLInterfaceType) {
-                        const fields = rawType.getFields();
-                        const hasIdFieldInType = !!fields[fieldName];
-                        const checkedFragmentSpreads = new Set();
-                        if (hasIdFieldInType) {
-                            let found = false;
-                            for (const selection of node.selections) {
-                                if (selection.kind === 'Field' && selection.name.value === fieldName) {
-                                    found = true;
-                                }
-                                else if (selection.kind === 'InlineFragment') {
-                                    found = (((_a = selection.selectionSet) === null || _a === void 0 ? void 0 : _a.selections) || []).some(s => s.kind === 'Field' && s.name.value === fieldName);
-                                }
-                                else if (selection.kind === 'FragmentSpread') {
-                                    const foundSpread = siblings.getFragment(selection.name.value);
-                                    if (foundSpread[0]) {
-                                        checkedFragmentSpreads.add(foundSpread[0].document.name.value);
-                                        found = (((_b = foundSpread[0].document.selectionSet) === null || _b === void 0 ? void 0 : _b.selections) || []).some(s => s.kind === 'Field' && s.name.value === fieldName);
-                                    }
-                                }
-                                if (found) {
-                                    break;
-                                }
-                            }
-                            const { parent } = node;
-                            const hasIdFieldInInterfaceSelectionSet = parent &&
-                                parent.kind === 'InlineFragment' &&
-                                parent.parent &&
-                                parent.parent.kind === 'SelectionSet' &&
-                                parent.parent.selections.some(s => s.kind === 'Field' && s.name.value === fieldName);
-                            if (!found && !hasIdFieldInInterfaceSelectionSet) {
-                                context.report({
-                                    loc: {
-                                        start: {
-                                            line: node.loc.start.line,
-                                            column: node.loc.start.column - 1,
-                                        },
-                                        end: {
-                                            line: node.loc.end.line,
-                                            column: node.loc.end.column - 1,
-                                        },
-                                    },
-                                    messageId: REQUIRE_ID_WHEN_AVAILABLE,
-                                    data: {
-                                        checkedFragments: checkedFragmentSpreads.size === 0 ? '' : `(${Array.from(checkedFragmentSpreads).join(', ')})`,
-                                        fieldName,
-                                    },
-                                });
-                            }
+                const rawType = getBaseType(typeInfo.gqlType);
+                const isObjectType = rawType instanceof GraphQLObjectType;
+                const isInterfaceType = rawType instanceof GraphQLInterfaceType;
+                if (!isObjectType && !isInterfaceType) {
+                    return;
+                }
+                const fields = rawType.getFields();
+                const hasIdFieldInType = idNames.some(name => fields[name]);
+                if (!hasIdFieldInType) {
+                    return;
+                }
+                const checkedFragmentSpreads = new Set();
+                let found = false;
+                for (const selection of node.selections) {
+                    if (isFound(selection)) {
+                        found = true;
+                    }
+                    else if (selection.kind === Kind.INLINE_FRAGMENT) {
+                        found = (_a = selection.selectionSet) === null || _a === void 0 ? void 0 : _a.selections.some(s => isFound(s));
+                    }
+                    else 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 (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 '),
+                        },
+                    });
                 }
             },
         };
@@ -3018,7 +3026,7 @@ const rule$k = {
             // eslint-disable-next-line no-console
             console.warn(`Rule "selection-set-depth" works best with siblings operations loaded. For more info: http://bit.ly/graphql-eslint-operations`);
         }
-        const maxDepth = context.options[0].maxDepth;
+        const { maxDepth } = context.options[0];
         const ignore = context.options[0].ignore || [];
         const checkFn = depthLimit(maxDepth, { ignore });
         return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.0.1",
+  "version": "3.1.0-alpha-878c908.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 || ^16.0.0"