@graphql-eslint/eslint-plugin 4.1.0-alpha-20241129085030-b075ada387ad44de7944517af78877c45bc8fd3b → 4.1.1-alpha-20241129095718-0cc689c0eb8b65d162f4c6d87030879fe63a105b

package/cjs/index.d.cts

@@ -98,10 +98,10 @@ declare const _default: {
                 style?: ("camelCase" | "PascalCase" | "snake_case" | "UPPER_CASE") | undefined;
                 suffix?: string | undefined;
                 prefix?: string | undefined;
-                forbiddenPattern?: {
+                forbiddenPatterns?: {
                     [x: string]: unknown;
                 }[] | undefined;
-                requiredPattern?: {
+                requiredPatterns?: {
                     [x: string]: unknown;
                 }[] | undefined;
                 forbiddenPrefixes?: string[] | undefined;

package/cjs/meta.js

@@ -1,4 +1,4 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});const version = "4.1.0-alpha-20241129085030-b075ada387ad44de7944517af78877c45bc8fd3b";
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});const version = "4.1.1-alpha-20241129095718-0cc689c0eb8b65d162f4c6d87030879fe63a105b";
 
 
 exports.version = version;

package/cjs/rules/index.d.cts

@@ -61,10 +61,10 @@ declare const rules: {
             style?: ("camelCase" | "PascalCase" | "snake_case" | "UPPER_CASE") | undefined;
             suffix?: string | undefined;
             prefix?: string | undefined;
-            forbiddenPattern?: {
+            forbiddenPatterns?: {
                 [x: string]: unknown;
             }[] | undefined;
-            requiredPattern?: {
+            requiredPatterns?: {
                 [x: string]: unknown;
             }[] | undefined;
             forbiddenPrefixes?: string[] | undefined;

package/cjs/rules/naming-convention/index.d.cts

@@ -28,7 +28,7 @@ declare const schema: {
                 readonly suffix: {
                     readonly type: "string";
                 };
-                readonly forbiddenPattern: {
+                readonly forbiddenPatterns: {
                     readonly items: {
                         readonly type: "object";
                     };
@@ -37,7 +37,7 @@ declare const schema: {
                     readonly uniqueItems: true;
                     readonly minItems: 1;
                 };
-                readonly requiredPattern: {
+                readonly requiredPatterns: {
                     readonly items: {
                         readonly type: "object";
                     };

package/cjs/rules/naming-convention/index.js

@@ -47,14 +47,14 @@ const KindToDisplayName = {
         style: { enum: ALLOWED_STYLES },
         prefix: { type: "string" },
         suffix: { type: "string" },
-        forbiddenPattern: {
+        forbiddenPatterns: {
           ..._utilsjs.ARRAY_DEFAULT_OPTIONS,
           items: {
             type: "object"
           },
           description: "Should be of instance of `RegEx`"
         },
-        requiredPattern: {
+        requiredPatterns: {
           ..._utilsjs.ARRAY_DEFAULT_OPTIONS,
           items: {
             type: "object"
@@ -63,19 +63,19 @@ const KindToDisplayName = {
         },
         forbiddenPrefixes: {
           ..._utilsjs.ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("forbiddenPattern")
+          description: descriptionPrefixesSuffixes("forbiddenPatterns")
         },
         forbiddenSuffixes: {
           ..._utilsjs.ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("forbiddenPattern")
+          description: descriptionPrefixesSuffixes("forbiddenPatterns")
         },
         requiredPrefixes: {
           ..._utilsjs.ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("requiredPattern")
+          description: descriptionPrefixesSuffixes("requiredPatterns")
         },
         requiredSuffixes: {
           ..._utilsjs.ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("requiredPattern")
+          description: descriptionPrefixesSuffixes("requiredPatterns")
         },
         ignorePattern: {
           type: "string",
@@ -101,7 +101,9 @@ ${_utilsjs.TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
           kind,
           {
             ...schemaOption,
-            description: `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`
+            description: `> [!NOTE]
+>
+> Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`
           }
         ])
       ),
@@ -328,7 +330,7 @@ ${_utilsjs.TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
     schema
   },
   create(context) {
-    const options = context.options[0] || {}, { allowLeadingUnderscore, allowTrailingUnderscore, types, ...restOptions } = options;
+    const options = context.options[0] || {}, { allowLeadingUnderscore, allowTrailingUnderscore, types, ...restOptions } = options, ignoredNodes = /* @__PURE__ */ new Set();
     function normalisePropertyOption(kind) {
       const style = restOptions[kind] || types;
       return typeof style == "object" ? style : { style };
@@ -356,8 +358,8 @@ ${_utilsjs.TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
         ignorePattern,
         requiredPrefixes,
         requiredSuffixes,
-        forbiddenPattern,
-        requiredPattern
+        forbiddenPatterns,
+        requiredPatterns
       } = normalisePropertyOption(selector), nodeName = node.value, error = getError();
       if (error) {
         const { errorMessage, renameToNames } = error, [leadingUnderscores] = nodeName.match(/^_*/), [trailingUnderscores] = nodeName.match(/_*$/), suggestedNames = renameToNames.map(
@@ -371,8 +373,10 @@ ${_utilsjs.TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
       }
       function getError() {
         const name = nodeName.replace(/(^_+)|(_+$)/g, "");
-        if (ignorePattern && new RegExp(ignorePattern, "u").test(name))
+        if (ignorePattern && new RegExp(ignorePattern, "u").test(name)) {
+          "name" in n && ignoredNodes.add(n.name);
           return;
+        }
         if (prefix && !name.startsWith(prefix))
           return {
             errorMessage: `have "${prefix}" prefix`,
@@ -383,15 +387,15 @@ ${_utilsjs.TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
             errorMessage: `have "${suffix}" suffix`,
             renameToNames: [name + suffix]
           };
-        const forbidden = _optionalChain([forbiddenPattern, 'optionalAccess', _ => _.find, 'call', _2 => _2((pattern) => pattern.test(name))]);
+        const forbidden = _optionalChain([forbiddenPatterns, 'optionalAccess', _ => _.find, 'call', _2 => _2((pattern) => pattern.test(name))]);
         if (forbidden)
           return {
             errorMessage: `not contain the forbidden pattern "${forbidden}"`,
             renameToNames: [name.replace(forbidden, "")]
           };
-        if (requiredPattern && !requiredPattern.some((pattern) => pattern.test(name)))
+        if (requiredPatterns && !requiredPatterns.some((pattern) => pattern.test(name)))
           return {
-            errorMessage: `contain the required pattern: ${_utilsjs.englishJoinWords.call(void 0, requiredPattern.map((re) => re.source))}`,
+            errorMessage: `contain the required pattern: ${_utilsjs.englishJoinWords.call(void 0, requiredPatterns.map((re) => re.source))}`,
             renameToNames: []
           };
         const forbiddenPrefix = _optionalChain([forbiddenPrefixes, 'optionalAccess', _3 => _3.find, 'call', _4 => _4((prefix2) => name.startsWith(prefix2))]);
@@ -429,7 +433,7 @@ ${_utilsjs.TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
           };
       }
     }, checkUnderscore = (isLeading) => (node) => {
-      if (node.parent.kind === "Field" && node.parent.alias !== node)
+      if (ignoredNodes.has(node) || node.parent.kind === "Field" && node.parent.alias !== node)
         return;
       const suggestedName = node.value.replace(isLeading ? /^_+/ : /_+$/, "");
       report(node, `${isLeading ? "Leading" : "Trailing"} underscores are not allowed`, [

package/cjs/rules/no-unused-fields/index.js

@@ -82,9 +82,7 @@ const RULE_ID = "no-unused-fields", RELAY_SCHEMA = (
           "```json",
           JSON.stringify(RELAY_DEFAULT_IGNORED_FIELD_SELECTORS, null, 2),
           "```",
-          "",
-          "> These fields are defined by ESLint [`selectors`](https://eslint.org/docs/developer-guide/selectors).",
-          "> Paste or drop code into the editor in [ASTExplorer](https://astexplorer.net) and inspect the generated AST to compose your selector."
+          _utilsjs.eslintSelectorsTip
         ].join(`
 `),
         items: {

package/cjs/rules/require-description/index.d.cts

@@ -15,8 +15,9 @@ type RuleOptions = [
     {
         [key in AllowedKind]?: boolean;
     } & {
-        types?: boolean;
-        rootField?: boolean;
+        types?: true;
+        rootField?: true;
+        ignoredSelectors?: string[];
     }
 ];
 declare const rule: GraphQLESLintRule<RuleOptions>;

package/cjs/rules/require-description/index.js

@@ -1,5 +1,12 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }var _graphql = require('graphql');
 var _utils = require('@graphql-tools/utils');
+
+
+
+
+
+
+
 var _utilsjs = require('../../utils.js');
 const RULE_ID = "require-description", ALLOWED_KINDS = [
   ..._utilsjs.TYPES_KINDS,
@@ -19,18 +26,34 @@ const RULE_ID = "require-description", ALLOWED_KINDS = [
     properties: {
       types: {
         type: "boolean",
+        enum: [!0],
         description: `Includes:
 ${_utilsjs.TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
 `)}`
       },
       rootField: {
         type: "boolean",
+        enum: [!0],
         description: "Definitions within `Query`, `Mutation`, and `Subscription` root types."
       },
+      ignoredSelectors: {
+        ..._utilsjs.ARRAY_DEFAULT_OPTIONS,
+        description: ["Ignore specific selectors", _utilsjs.eslintSelectorsTip].join(`
+`)
+      },
       ...Object.fromEntries(
         [...ALLOWED_KINDS].sort().map((kind) => {
-          let description = `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
-          return kind === _graphql.Kind.OPERATION_DEFINITION && (description += '\n> You must use only comment syntax `#` and not description syntax `"""` or `"`.'), [kind, { type: "boolean", description }];
+          let description = `> [!NOTE]
+>
+> Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
+          return kind === _graphql.Kind.OPERATION_DEFINITION && (description += [
+            "",
+            "",
+            "> [!WARNING]",
+            ">",
+            '> You must use only comment syntax `#` and not description syntax `"""` or `"`.'
+          ].join(`
+`)), [kind, { type: "boolean", description }];
         })
       )
     }
@@ -101,6 +124,36 @@ ${_utilsjs.TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
             }
           `
           )
+        },
+        {
+          title: "Correct",
+          usage: [
+            {
+              ignoredSelectors: [
+                "[type=ObjectTypeDefinition][name.value=PageInfo]",
+                "[type=ObjectTypeDefinition][name.value=/(Connection|Edge)$/]"
+              ]
+            }
+          ],
+          code: (
+            /* GraphQL */
+            `
+            type FriendConnection {
+              edges: [FriendEdge]
+              pageInfo: PageInfo!
+            }
+            type FriendEdge {
+              cursor: String!
+              node: Friend!
+            }
+            type PageInfo {
+              hasPreviousPage: Boolean!
+              hasNextPage: Boolean!
+              startCursor: String
+              endCursor: String
+            }
+          `
+          )
         }
       ],
       configOptions: [
@@ -119,7 +172,7 @@ ${_utilsjs.TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
     schema
   },
   create(context) {
-    const { types, rootField, ...restOptions } = context.options[0] || {}, kinds = new Set(types ? _utilsjs.TYPES_KINDS : []);
+    const { types, rootField, ignoredSelectors = [], ...restOptions } = context.options[0] || {}, kinds = new Set(types ? _utilsjs.TYPES_KINDS : []);
     for (const [kind, isEnabled] of Object.entries(restOptions))
       isEnabled ? kinds.add(kind) : kinds.delete(kind);
     if (rootField) {
@@ -130,10 +183,11 @@ ${_utilsjs.TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
         ].join(",")})$/] > FieldDefinition`
       );
     }
-    if (!kinds.size)
-      throw new Error("At least one kind must be enabled");
+    let selector = `:matches(${[...kinds]})`;
+    for (const str of ignoredSelectors)
+      selector += `:not(${str})`;
     return {
-      [[...kinds].join(",")](node) {
+      [selector](node) {
         let description = "";
         const isOperation = node.kind === _graphql.Kind.OPERATION_DEFINITION;
         if (isOperation) {

package/cjs/utils.d.cts

@@ -41,5 +41,6 @@ type Truthy<T> = T extends '' | 0 | false | null | undefined ? never : T;
 declare function truthy<T>(value: T): value is Truthy<T>;
 declare function displayNodeName(node: GraphQLESTreeNode<ASTNode, boolean>): string;
 declare function getNodeName(node: GraphQLESTreeNode<ASTNode>): string;
+declare const eslintSelectorsTip = "> [!TIP]\n>\n> These fields are defined by ESLint [`selectors`](https://eslint.org/docs/developer-guide/selectors).\n> Paste or drop code into the editor in [ASTExplorer](https://astexplorer.net) and inspect the generated AST to compose your selector.";
 
-export { ARRAY_DEFAULT_OPTIONS, CWD, type CaseStyle, REPORT_ON_FIRST_CHARACTER, TYPES_KINDS, VIRTUAL_DOCUMENT_REGEX, camelCase, convertCase, displayNodeName, englishJoinWords, getLocation, getNodeName, getTypeName, logger, pascalCase, requireGraphQLOperations, requireGraphQLSchema, slash, truthy };
+export { ARRAY_DEFAULT_OPTIONS, CWD, type CaseStyle, REPORT_ON_FIRST_CHARACTER, TYPES_KINDS, VIRTUAL_DOCUMENT_REGEX, camelCase, convertCase, displayNodeName, englishJoinWords, eslintSelectorsTip, getLocation, getNodeName, getTypeName, logger, pascalCase, requireGraphQLOperations, requireGraphQLSchema, slash, truthy };

package/cjs/utils.js

@@ -144,6 +144,10 @@ function getNodeName(node) {
   }
   return "";
 }
+const eslintSelectorsTip = `> [!TIP]
+>
+> These fields are defined by ESLint [\`selectors\`](https://eslint.org/docs/developer-guide/selectors).
+> Paste or drop code into the editor in [ASTExplorer](https://astexplorer.net) and inspect the generated AST to compose your selector.`;
 
 
 
@@ -163,4 +167,5 @@ function getNodeName(node) {
 
 
 
-exports.ARRAY_DEFAULT_OPTIONS = ARRAY_DEFAULT_OPTIONS; exports.CWD = CWD; exports.REPORT_ON_FIRST_CHARACTER = REPORT_ON_FIRST_CHARACTER; exports.TYPES_KINDS = TYPES_KINDS; exports.VIRTUAL_DOCUMENT_REGEX = VIRTUAL_DOCUMENT_REGEX; exports.camelCase = camelCase; exports.convertCase = convertCase; exports.displayNodeName = displayNodeName; exports.englishJoinWords = englishJoinWords; exports.getLocation = getLocation; exports.getNodeName = getNodeName; exports.getTypeName = getTypeName; exports.logger = logger; exports.pascalCase = pascalCase; exports.requireGraphQLOperations = requireGraphQLOperations; exports.requireGraphQLSchema = requireGraphQLSchema; exports.slash = slash; exports.truthy = truthy;
+
+exports.ARRAY_DEFAULT_OPTIONS = ARRAY_DEFAULT_OPTIONS; exports.CWD = CWD; exports.REPORT_ON_FIRST_CHARACTER = REPORT_ON_FIRST_CHARACTER; exports.TYPES_KINDS = TYPES_KINDS; exports.VIRTUAL_DOCUMENT_REGEX = VIRTUAL_DOCUMENT_REGEX; exports.camelCase = camelCase; exports.convertCase = convertCase; exports.displayNodeName = displayNodeName; exports.englishJoinWords = englishJoinWords; exports.eslintSelectorsTip = eslintSelectorsTip; exports.getLocation = getLocation; exports.getNodeName = getNodeName; exports.getTypeName = getTypeName; exports.logger = logger; exports.pascalCase = pascalCase; exports.requireGraphQLOperations = requireGraphQLOperations; exports.requireGraphQLSchema = requireGraphQLSchema; exports.slash = slash; exports.truthy = truthy;

package/esm/index.d.ts

@@ -98,10 +98,10 @@ declare const _default: {
                 style?: ("camelCase" | "PascalCase" | "snake_case" | "UPPER_CASE") | undefined;
                 suffix?: string | undefined;
                 prefix?: string | undefined;
-                forbiddenPattern?: {
+                forbiddenPatterns?: {
                     [x: string]: unknown;
                 }[] | undefined;
-                requiredPattern?: {
+                requiredPatterns?: {
                     [x: string]: unknown;
                 }[] | undefined;
                 forbiddenPrefixes?: string[] | undefined;

package/esm/meta.js

@@ -1,4 +1,4 @@
-const version = "4.1.0-alpha-20241129085030-b075ada387ad44de7944517af78877c45bc8fd3b";
+const version = "4.1.1-alpha-20241129095718-0cc689c0eb8b65d162f4c6d87030879fe63a105b";
 export {
   version
 };

package/esm/rules/index.d.ts

@@ -61,10 +61,10 @@ declare const rules: {
             style?: ("camelCase" | "PascalCase" | "snake_case" | "UPPER_CASE") | undefined;
             suffix?: string | undefined;
             prefix?: string | undefined;
-            forbiddenPattern?: {
+            forbiddenPatterns?: {
                 [x: string]: unknown;
             }[] | undefined;
-            requiredPattern?: {
+            requiredPatterns?: {
                 [x: string]: unknown;
             }[] | undefined;
             forbiddenPrefixes?: string[] | undefined;

package/esm/rules/naming-convention/index.d.ts

@@ -28,7 +28,7 @@ declare const schema: {
                 readonly suffix: {
                     readonly type: "string";
                 };
-                readonly forbiddenPattern: {
+                readonly forbiddenPatterns: {
                     readonly items: {
                         readonly type: "object";
                     };
@@ -37,7 +37,7 @@ declare const schema: {
                     readonly uniqueItems: true;
                     readonly minItems: 1;
                 };
-                readonly requiredPattern: {
+                readonly requiredPatterns: {
                     readonly items: {
                         readonly type: "object";
                     };

package/esm/rules/naming-convention/index.js

@@ -47,14 +47,14 @@ const KindToDisplayName = {
         style: { enum: ALLOWED_STYLES },
         prefix: { type: "string" },
         suffix: { type: "string" },
-        forbiddenPattern: {
+        forbiddenPatterns: {
           ...ARRAY_DEFAULT_OPTIONS,
           items: {
             type: "object"
           },
           description: "Should be of instance of `RegEx`"
         },
-        requiredPattern: {
+        requiredPatterns: {
           ...ARRAY_DEFAULT_OPTIONS,
           items: {
             type: "object"
@@ -63,19 +63,19 @@ const KindToDisplayName = {
         },
         forbiddenPrefixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("forbiddenPattern")
+          description: descriptionPrefixesSuffixes("forbiddenPatterns")
         },
         forbiddenSuffixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("forbiddenPattern")
+          description: descriptionPrefixesSuffixes("forbiddenPatterns")
         },
         requiredPrefixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("requiredPattern")
+          description: descriptionPrefixesSuffixes("requiredPatterns")
         },
         requiredSuffixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("requiredPattern")
+          description: descriptionPrefixesSuffixes("requiredPatterns")
         },
         ignorePattern: {
           type: "string",
@@ -101,7 +101,9 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
           kind,
           {
             ...schemaOption,
-            description: `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`
+            description: `> [!NOTE]
+>
+> Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`
           }
         ])
       ),
@@ -328,7 +330,7 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
     schema
   },
   create(context) {
-    const options = context.options[0] || {}, { allowLeadingUnderscore, allowTrailingUnderscore, types, ...restOptions } = options;
+    const options = context.options[0] || {}, { allowLeadingUnderscore, allowTrailingUnderscore, types, ...restOptions } = options, ignoredNodes = /* @__PURE__ */ new Set();
     function normalisePropertyOption(kind) {
       const style = restOptions[kind] || types;
       return typeof style == "object" ? style : { style };
@@ -356,8 +358,8 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
         ignorePattern,
         requiredPrefixes,
         requiredSuffixes,
-        forbiddenPattern,
-        requiredPattern
+        forbiddenPatterns,
+        requiredPatterns
       } = normalisePropertyOption(selector), nodeName = node.value, error = getError();
       if (error) {
         const { errorMessage, renameToNames } = error, [leadingUnderscores] = nodeName.match(/^_*/), [trailingUnderscores] = nodeName.match(/_*$/), suggestedNames = renameToNames.map(
@@ -371,8 +373,10 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
       }
       function getError() {
         const name = nodeName.replace(/(^_+)|(_+$)/g, "");
-        if (ignorePattern && new RegExp(ignorePattern, "u").test(name))
+        if (ignorePattern && new RegExp(ignorePattern, "u").test(name)) {
+          "name" in n && ignoredNodes.add(n.name);
           return;
+        }
         if (prefix && !name.startsWith(prefix))
           return {
             errorMessage: `have "${prefix}" prefix`,
@@ -383,15 +387,15 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
             errorMessage: `have "${suffix}" suffix`,
             renameToNames: [name + suffix]
           };
-        const forbidden = forbiddenPattern?.find((pattern) => pattern.test(name));
+        const forbidden = forbiddenPatterns?.find((pattern) => pattern.test(name));
         if (forbidden)
           return {
             errorMessage: `not contain the forbidden pattern "${forbidden}"`,
             renameToNames: [name.replace(forbidden, "")]
           };
-        if (requiredPattern && !requiredPattern.some((pattern) => pattern.test(name)))
+        if (requiredPatterns && !requiredPatterns.some((pattern) => pattern.test(name)))
           return {
-            errorMessage: `contain the required pattern: ${englishJoinWords(requiredPattern.map((re) => re.source))}`,
+            errorMessage: `contain the required pattern: ${englishJoinWords(requiredPatterns.map((re) => re.source))}`,
             renameToNames: []
           };
         const forbiddenPrefix = forbiddenPrefixes?.find((prefix2) => name.startsWith(prefix2));
@@ -429,7 +433,7 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
           };
       }
     }, checkUnderscore = (isLeading) => (node) => {
-      if (node.parent.kind === "Field" && node.parent.alias !== node)
+      if (ignoredNodes.has(node) || node.parent.kind === "Field" && node.parent.alias !== node)
         return;
       const suggestedName = node.value.replace(isLeading ? /^_+/ : /_+$/, "");
       report(node, `${isLeading ? "Leading" : "Trailing"} underscores are not allowed`, [

package/esm/rules/no-unused-fields/index.js

@@ -1,6 +1,6 @@
 import { TypeInfo, visit, visitWithTypeInfo } from "graphql";
 import { ModuleCache } from "../../cache.js";
-import { requireGraphQLOperations, requireGraphQLSchema } from "../../utils.js";
+import { eslintSelectorsTip, requireGraphQLOperations, requireGraphQLSchema } from "../../utils.js";
 const RULE_ID = "no-unused-fields", RELAY_SCHEMA = (
   /* GraphQL */
   `
@@ -82,9 +82,7 @@ const RULE_ID = "no-unused-fields", RELAY_SCHEMA = (
           "```json",
           JSON.stringify(RELAY_DEFAULT_IGNORED_FIELD_SELECTORS, null, 2),
           "```",
-          "",
-          "> These fields are defined by ESLint [`selectors`](https://eslint.org/docs/developer-guide/selectors).",
-          "> Paste or drop code into the editor in [ASTExplorer](https://astexplorer.net) and inspect the generated AST to compose your selector."
+          eslintSelectorsTip
         ].join(`
 `),
         items: {

package/esm/rules/require-description/index.d.ts

@@ -15,8 +15,9 @@ type RuleOptions = [
     {
         [key in AllowedKind]?: boolean;
     } & {
-        types?: boolean;
-        rootField?: boolean;
+        types?: true;
+        rootField?: true;
+        ignoredSelectors?: string[];
     }
 ];
 declare const rule: GraphQLESLintRule<RuleOptions>;

package/esm/rules/require-description/index.js

@@ -1,6 +1,13 @@
 import { Kind, TokenKind } from "graphql";
 import { getRootTypeNames } from "@graphql-tools/utils";
-import { getLocation, getNodeName, requireGraphQLSchema, TYPES_KINDS } from "../../utils.js";
+import {
+  ARRAY_DEFAULT_OPTIONS,
+  eslintSelectorsTip,
+  getLocation,
+  getNodeName,
+  requireGraphQLSchema,
+  TYPES_KINDS
+} from "../../utils.js";
 const RULE_ID = "require-description", ALLOWED_KINDS = [
   ...TYPES_KINDS,
   Kind.DIRECTIVE_DEFINITION,
@@ -19,18 +26,34 @@ const RULE_ID = "require-description", ALLOWED_KINDS = [
     properties: {
       types: {
         type: "boolean",
+        enum: [!0],
         description: `Includes:
 ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
 `)}`
       },
       rootField: {
         type: "boolean",
+        enum: [!0],
         description: "Definitions within `Query`, `Mutation`, and `Subscription` root types."
       },
+      ignoredSelectors: {
+        ...ARRAY_DEFAULT_OPTIONS,
+        description: ["Ignore specific selectors", eslintSelectorsTip].join(`
+`)
+      },
       ...Object.fromEntries(
         [...ALLOWED_KINDS].sort().map((kind) => {
-          let description = `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
-          return kind === Kind.OPERATION_DEFINITION && (description += '\n> You must use only comment syntax `#` and not description syntax `"""` or `"`.'), [kind, { type: "boolean", description }];
+          let description = `> [!NOTE]
+>
+> Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
+          return kind === Kind.OPERATION_DEFINITION && (description += [
+            "",
+            "",
+            "> [!WARNING]",
+            ">",
+            '> You must use only comment syntax `#` and not description syntax `"""` or `"`.'
+          ].join(`
+`)), [kind, { type: "boolean", description }];
         })
       )
     }
@@ -101,6 +124,36 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
             }
           `
           )
+        },
+        {
+          title: "Correct",
+          usage: [
+            {
+              ignoredSelectors: [
+                "[type=ObjectTypeDefinition][name.value=PageInfo]",
+                "[type=ObjectTypeDefinition][name.value=/(Connection|Edge)$/]"
+              ]
+            }
+          ],
+          code: (
+            /* GraphQL */
+            `
+            type FriendConnection {
+              edges: [FriendEdge]
+              pageInfo: PageInfo!
+            }
+            type FriendEdge {
+              cursor: String!
+              node: Friend!
+            }
+            type PageInfo {
+              hasPreviousPage: Boolean!
+              hasNextPage: Boolean!
+              startCursor: String
+              endCursor: String
+            }
+          `
+          )
         }
       ],
       configOptions: [
@@ -119,7 +172,7 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
     schema
   },
   create(context) {
-    const { types, rootField, ...restOptions } = context.options[0] || {}, kinds = new Set(types ? TYPES_KINDS : []);
+    const { types, rootField, ignoredSelectors = [], ...restOptions } = context.options[0] || {}, kinds = new Set(types ? TYPES_KINDS : []);
     for (const [kind, isEnabled] of Object.entries(restOptions))
       isEnabled ? kinds.add(kind) : kinds.delete(kind);
     if (rootField) {
@@ -130,10 +183,11 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
         ].join(",")})$/] > FieldDefinition`
       );
     }
-    if (!kinds.size)
-      throw new Error("At least one kind must be enabled");
+    let selector = `:matches(${[...kinds]})`;
+    for (const str of ignoredSelectors)
+      selector += `:not(${str})`;
     return {
-      [[...kinds].join(",")](node) {
+      [selector](node) {
         let description = "";
         const isOperation = node.kind === Kind.OPERATION_DEFINITION;
         if (isOperation) {

package/esm/utils.d.ts

@@ -41,5 +41,6 @@ type Truthy<T> = T extends '' | 0 | false | null | undefined ? never : T;
 declare function truthy<T>(value: T): value is Truthy<T>;
 declare function displayNodeName(node: GraphQLESTreeNode<ASTNode, boolean>): string;
 declare function getNodeName(node: GraphQLESTreeNode<ASTNode>): string;
+declare const eslintSelectorsTip = "> [!TIP]\n>\n> These fields are defined by ESLint [`selectors`](https://eslint.org/docs/developer-guide/selectors).\n> Paste or drop code into the editor in [ASTExplorer](https://astexplorer.net) and inspect the generated AST to compose your selector.";
 
-export { ARRAY_DEFAULT_OPTIONS, CWD, type CaseStyle, REPORT_ON_FIRST_CHARACTER, TYPES_KINDS, VIRTUAL_DOCUMENT_REGEX, camelCase, convertCase, displayNodeName, englishJoinWords, getLocation, getNodeName, getTypeName, logger, pascalCase, requireGraphQLOperations, requireGraphQLSchema, slash, truthy };
+export { ARRAY_DEFAULT_OPTIONS, CWD, type CaseStyle, REPORT_ON_FIRST_CHARACTER, TYPES_KINDS, VIRTUAL_DOCUMENT_REGEX, camelCase, convertCase, displayNodeName, englishJoinWords, eslintSelectorsTip, getLocation, getNodeName, getTypeName, logger, pascalCase, requireGraphQLOperations, requireGraphQLSchema, slash, truthy };

package/esm/utils.js

@@ -144,6 +144,10 @@ function getNodeName(node) {
   }
   return "";
 }
+const eslintSelectorsTip = `> [!TIP]
+>
+> These fields are defined by ESLint [\`selectors\`](https://eslint.org/docs/developer-guide/selectors).
+> Paste or drop code into the editor in [ASTExplorer](https://astexplorer.net) and inspect the generated AST to compose your selector.`;
 export {
   ARRAY_DEFAULT_OPTIONS,
   CWD,
@@ -154,6 +158,7 @@ export {
   convertCase,
   displayNodeName,
   englishJoinWords,
+  eslintSelectorsTip,
   getLocation,
   getNodeName,
   getTypeName,

package/index.browser.js

@@ -150,7 +150,7 @@ function convertToESTree(node, schema16) {
 }
 
 // src/meta.ts
-var version = "4.1.0-alpha-20241129085030-b075ada387ad44de7944517af78877c45bc8fd3b";
+var version = "4.1.1-alpha-20241129095718-0cc689c0eb8b65d162f4c6d87030879fe63a105b";
 
 // src/siblings.ts
 import {
@@ -305,6 +305,10 @@ function getNodeName(node) {
   }
   return "";
 }
+var eslintSelectorsTip = `> [!TIP]
+>
+> These fields are defined by ESLint [\`selectors\`](https://eslint.org/docs/developer-guide/selectors).
+> Paste or drop code into the editor in [ASTExplorer](https://astexplorer.net) and inspect the generated AST to compose your selector.`;
 
 // src/siblings.ts
 var siblingOperationsCache = /* @__PURE__ */ new Map();
@@ -1934,14 +1938,14 @@ var KindToDisplayName = {
         style: { enum: ALLOWED_STYLES },
         prefix: { type: "string" },
         suffix: { type: "string" },
-        forbiddenPattern: {
+        forbiddenPatterns: {
           ...ARRAY_DEFAULT_OPTIONS,
           items: {
             type: "object"
           },
           description: "Should be of instance of `RegEx`"
         },
-        requiredPattern: {
+        requiredPatterns: {
           ...ARRAY_DEFAULT_OPTIONS,
           items: {
             type: "object"
@@ -1950,19 +1954,19 @@ var KindToDisplayName = {
         },
         forbiddenPrefixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("forbiddenPattern")
+          description: descriptionPrefixesSuffixes("forbiddenPatterns")
         },
         forbiddenSuffixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("forbiddenPattern")
+          description: descriptionPrefixesSuffixes("forbiddenPatterns")
         },
         requiredPrefixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("requiredPattern")
+          description: descriptionPrefixesSuffixes("requiredPatterns")
         },
         requiredSuffixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("requiredPattern")
+          description: descriptionPrefixesSuffixes("requiredPatterns")
         },
         ignorePattern: {
           type: "string",
@@ -1988,7 +1992,9 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
           kind,
           {
             ...schemaOption2,
-            description: `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`
+            description: `> [!NOTE]
+>
+> Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`
           }
         ])
       ),
@@ -2215,7 +2221,7 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
     schema: schema6
   },
   create(context) {
-    let options = context.options[0] || {}, { allowLeadingUnderscore, allowTrailingUnderscore, types, ...restOptions } = options;
+    let options = context.options[0] || {}, { allowLeadingUnderscore, allowTrailingUnderscore, types, ...restOptions } = options, ignoredNodes = /* @__PURE__ */ new Set();
     function normalisePropertyOption(kind) {
       let style = restOptions[kind] || types;
       return typeof style == "object" ? style : { style };
@@ -2243,8 +2249,8 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
         ignorePattern,
         requiredPrefixes,
         requiredSuffixes,
-        forbiddenPattern,
-        requiredPattern
+        forbiddenPatterns,
+        requiredPatterns
       } = normalisePropertyOption(selector), nodeName = node.value, error = getError();
       if (error) {
         let { errorMessage, renameToNames } = error, [leadingUnderscores] = nodeName.match(/^_*/), [trailingUnderscores] = nodeName.match(/_*$/), suggestedNames = renameToNames.map(
@@ -2258,8 +2264,10 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
       }
       function getError() {
         let name = nodeName.replace(/(^_+)|(_+$)/g, "");
-        if (ignorePattern && new RegExp(ignorePattern, "u").test(name))
+        if (ignorePattern && new RegExp(ignorePattern, "u").test(name)) {
+          "name" in n && ignoredNodes.add(n.name);
           return;
+        }
         if (prefix && !name.startsWith(prefix))
           return {
             errorMessage: `have "${prefix}" prefix`,
@@ -2270,15 +2278,15 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
             errorMessage: `have "${suffix}" suffix`,
             renameToNames: [name + suffix]
           };
-        let forbidden = forbiddenPattern?.find((pattern) => pattern.test(name));
+        let forbidden = forbiddenPatterns?.find((pattern) => pattern.test(name));
         if (forbidden)
           return {
             errorMessage: `not contain the forbidden pattern "${forbidden}"`,
             renameToNames: [name.replace(forbidden, "")]
           };
-        if (requiredPattern && !requiredPattern.some((pattern) => pattern.test(name)))
+        if (requiredPatterns && !requiredPatterns.some((pattern) => pattern.test(name)))
           return {
-            errorMessage: `contain the required pattern: ${englishJoinWords(requiredPattern.map((re) => re.source))}`,
+            errorMessage: `contain the required pattern: ${englishJoinWords(requiredPatterns.map((re) => re.source))}`,
             renameToNames: []
           };
         let forbiddenPrefix = forbiddenPrefixes?.find((prefix2) => name.startsWith(prefix2));
@@ -2316,7 +2324,7 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
           };
       }
     }, checkUnderscore = (isLeading) => (node) => {
-      if (node.parent.kind === "Field" && node.parent.alias !== node)
+      if (ignoredNodes.has(node) || node.parent.kind === "Field" && node.parent.alias !== node)
         return;
       let suggestedName = node.value.replace(isLeading ? /^_+/ : /_+$/, "");
       report(node, `${isLeading ? "Leading" : "Trailing"} underscores are not allowed`, [
@@ -3281,9 +3289,7 @@ var RULE_ID10 = "no-unused-fields", RELAY_SCHEMA = (
           "```json",
           JSON.stringify(RELAY_DEFAULT_IGNORED_FIELD_SELECTORS, null, 2),
           "```",
-          "",
-          "> These fields are defined by ESLint [`selectors`](https://eslint.org/docs/developer-guide/selectors).",
-          "> Paste or drop code into the editor in [ASTExplorer](https://astexplorer.net) and inspect the generated AST to compose your selector."
+          eslintSelectorsTip
         ].join(`
 `),
         items: {
@@ -4033,18 +4039,34 @@ var RULE_ID14 = "require-description", ALLOWED_KINDS2 = [
     properties: {
       types: {
         type: "boolean",
+        enum: [!0],
         description: `Includes:
 ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
 `)}`
       },
       rootField: {
         type: "boolean",
+        enum: [!0],
         description: "Definitions within `Query`, `Mutation`, and `Subscription` root types."
       },
+      ignoredSelectors: {
+        ...ARRAY_DEFAULT_OPTIONS,
+        description: ["Ignore specific selectors", eslintSelectorsTip].join(`
+`)
+      },
       ...Object.fromEntries(
         [...ALLOWED_KINDS2].sort().map((kind) => {
-          let description = `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
-          return kind === Kind17.OPERATION_DEFINITION && (description += '\n> You must use only comment syntax `#` and not description syntax `"""` or `"`.'), [kind, { type: "boolean", description }];
+          let description = `> [!NOTE]
+>
+> Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
+          return kind === Kind17.OPERATION_DEFINITION && (description += [
+            "",
+            "",
+            "> [!WARNING]",
+            ">",
+            '> You must use only comment syntax `#` and not description syntax `"""` or `"`.'
+          ].join(`
+`)), [kind, { type: "boolean", description }];
         })
       )
     }
@@ -4115,6 +4137,36 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
             }
           `
           )
+        },
+        {
+          title: "Correct",
+          usage: [
+            {
+              ignoredSelectors: [
+                "[type=ObjectTypeDefinition][name.value=PageInfo]",
+                "[type=ObjectTypeDefinition][name.value=/(Connection|Edge)$/]"
+              ]
+            }
+          ],
+          code: (
+            /* GraphQL */
+            `
+            type FriendConnection {
+              edges: [FriendEdge]
+              pageInfo: PageInfo!
+            }
+            type FriendEdge {
+              cursor: String!
+              node: Friend!
+            }
+            type PageInfo {
+              hasPreviousPage: Boolean!
+              hasNextPage: Boolean!
+              startCursor: String
+              endCursor: String
+            }
+          `
+          )
         }
       ],
       configOptions: [
@@ -4133,7 +4185,7 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
     schema: schema12
   },
   create(context) {
-    let { types, rootField, ...restOptions } = context.options[0] || {}, kinds = new Set(types ? TYPES_KINDS : []);
+    let { types, rootField, ignoredSelectors = [], ...restOptions } = context.options[0] || {}, kinds = new Set(types ? TYPES_KINDS : []);
     for (let [kind, isEnabled] of Object.entries(restOptions))
       isEnabled ? kinds.add(kind) : kinds.delete(kind);
     if (rootField) {
@@ -4144,10 +4196,11 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
         ].join(",")})$/] > FieldDefinition`
       );
     }
-    if (!kinds.size)
-      throw new Error("At least one kind must be enabled");
+    let selector = `:matches(${[...kinds]})`;
+    for (let str of ignoredSelectors)
+      selector += `:not(${str})`;
     return {
-      [[...kinds].join(",")](node) {
+      [selector](node) {
         let description = "", isOperation = node.kind === Kind17.OPERATION_DEFINITION;
         if (isOperation) {
           let rawNode = node.rawNode(), { prev, line } = rawNode.loc.startToken;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "4.1.0-alpha-20241129085030-b075ada387ad44de7944517af78877c45bc8fd3b",
+  "version": "4.1.1-alpha-20241129095718-0cc689c0eb8b65d162f4c6d87030879fe63a105b",
   "type": "module",
   "description": "GraphQL plugin for ESLint",
   "repository": "https://github.com/dimaMachina/graphql-eslint",