@graphql-eslint/eslint-plugin 4.3.1-alpha-20241207204625-6a4230707a78900a6339b03afe904b9dd6c31561 → 4.3.1-alpha-20241209185034-de2d7397da8c26620a8930dd12b6dff42e43f537

package/{index.browser.js → browser.js}

@@ -408,7 +408,7 @@ function convertToESTree(node, schema16) {
 }
 
 // src/meta.ts
-var version = "4.3.1-alpha-20241207204625-6a4230707a78900a6339b03afe904b9dd6c31561";
+var version = "4.3.1-alpha-20241209185034-de2d7397da8c26620a8930dd12b6dff42e43f537";
 
 // src/siblings.ts
 import {
@@ -2124,19 +2124,18 @@ var CASE_STYLES = [
 var schemaOption = {
   oneOf: [{ $ref: "#/definitions/asString" }, { $ref: "#/definitions/asObject" }]
 };
-var caseSchema = {
-  enum: CASE_STYLES,
-  description: `One of: ${CASE_STYLES.map((t) => `\`${t}\``).join(", ")}`
-};
 var schema5 = {
   definitions: {
-    asString: caseSchema,
+    asString: {
+      enum: CASE_STYLES,
+      description: `One of: ${CASE_STYLES.map((t) => `\`${t}\``).join(", ")}`
+    },
     asObject: {
       type: "object",
       additionalProperties: false,
       minProperties: 1,
       properties: {
-        style: caseSchema,
+        style: { enum: CASE_STYLES },
         suffix: { type: "string" },
         prefix: { type: "string" }
       }
@@ -2396,21 +2395,20 @@ var ALLOWED_STYLES = Object.keys(StyleToRegex);
 var schemaOption2 = {
   oneOf: [{ $ref: "#/definitions/asString" }, { $ref: "#/definitions/asObject" }]
 };
-var descriptionPrefixesSuffixes = (name, id) => `> [!WARNING]
+var descriptionPrefixesSuffixes = (name) => `> [!WARNING]
 >
-> This option is deprecated and will be removed in the next major release. Use [\`${name}\`](#${id}) instead.`;
-var caseSchema2 = {
-  enum: ALLOWED_STYLES,
-  description: `One of: ${ALLOWED_STYLES.map((t) => `\`${t}\``).join(", ")}`
-};
+> This option is deprecated and will be removed in the next major release. Use [\`${name}\`](#${name.toLowerCase()}-array) instead.`;
 var schema6 = {
   definitions: {
-    asString: caseSchema2,
+    asString: {
+      enum: ALLOWED_STYLES,
+      description: `One of: ${ALLOWED_STYLES.map((t) => `\`${t}\``).join(", ")}`
+    },
     asObject: {
       type: "object",
       additionalProperties: false,
       properties: {
-        style: caseSchema2,
+        style: { enum: ALLOWED_STYLES },
         prefix: { type: "string" },
         suffix: { type: "string" },
         forbiddenPatterns: {
@@ -2420,25 +2418,28 @@ var schema6 = {
           },
           description: "Should be of instance of `RegEx`"
         },
-        requiredPattern: {
-          type: "object",
+        requiredPatterns: {
+          ...ARRAY_DEFAULT_OPTIONS,
+          items: {
+            type: "object"
+          },
           description: "Should be of instance of `RegEx`"
         },
         forbiddenPrefixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("forbiddenPatterns", "forbiddenpatterns-array")
+          description: descriptionPrefixesSuffixes("forbiddenPatterns")
         },
         forbiddenSuffixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("forbiddenPatterns", "forbiddenpatterns-array")
+          description: descriptionPrefixesSuffixes("forbiddenPatterns")
         },
         requiredPrefixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("requiredPattern", "requiredpattern-object")
+          description: descriptionPrefixesSuffixes("requiredPatterns")
         },
         requiredSuffixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("requiredPattern", "requiredpattern-object")
+          description: descriptionPrefixesSuffixes("requiredPatterns")
         },
         ignorePattern: {
           type: "string",
@@ -2630,30 +2631,6 @@ var rule6 = {
             }
           `
           )
-        },
-        {
-          title: "Correct (Relay fragment convention `<module_name>_<property_name>`)",
-          usage: [
-            {
-              FragmentDefinition: {
-                style: "PascalCase",
-                requiredPattern: /_(?<camelCase>.+?)$/
-              }
-            }
-          ],
-          code: (
-            /* GraphQL */
-            `
-            # schema
-            type User {
-              # ...
-            }
-            # operations
-            fragment UserFields_data on User {
-              # ...
-            }
-          `
-          )
         }
       ],
       configOptions: {
@@ -2748,7 +2725,7 @@ var rule6 = {
         requiredPrefixes,
         requiredSuffixes,
         forbiddenPatterns,
-        requiredPattern
+        requiredPatterns
       } = normalisePropertyOption(selector);
       const nodeName = node.value;
       const error = getError();
@@ -2767,9 +2744,7 @@ var rule6 = {
         );
       }
       function getError() {
-        let name = nodeName;
-        if (allowLeadingUnderscore) name = name.replace(/^_+/, "");
-        if (allowTrailingUnderscore) name = name.replace(/_+$/, "");
+        const name = nodeName.replace(/(^_+)|(_+$)/g, "");
         if (ignorePattern && new RegExp(ignorePattern, "u").test(name)) {
           if ("name" in n) {
             ignoredNodes.add(n.name);
@@ -2788,38 +2763,6 @@ var rule6 = {
             renameToNames: [name + suffix]
           };
         }
-        if (requiredPattern) {
-          if (requiredPattern.source.includes("(?<")) {
-            try {
-              name = name.replace(requiredPattern, (originalString, ...args) => {
-                const groups = args.at(-1);
-                for (const [styleName, value] of Object.entries(groups)) {
-                  if (!(styleName in StyleToRegex)) {
-                    throw new Error("Invalid case style in `requiredPatterns` option");
-                  }
-                  if (value === convertCase(styleName, value)) {
-                    return "";
-                  }
-                  throw new Error(`contain the required pattern: ${requiredPattern}`);
-                }
-                return originalString;
-              });
-              if (name === nodeName) {
-                throw new Error(`contain the required pattern: ${requiredPattern}`);
-              }
-            } catch (error2) {
-              return {
-                errorMessage: error2.message,
-                renameToNames: []
-              };
-            }
-          } else if (!requiredPattern.test(name)) {
-            return {
-              errorMessage: `contain the required pattern: ${requiredPattern}`,
-              renameToNames: []
-            };
-          }
-        }
         const forbidden = forbiddenPatterns?.find((pattern) => pattern.test(name));
         if (forbidden) {
           return {
@@ -2827,6 +2770,12 @@ var rule6 = {
             renameToNames: [name.replace(forbidden, "")]
           };
         }
+        if (requiredPatterns && !requiredPatterns.some((pattern) => pattern.test(name))) {
+          return {
+            errorMessage: `contain the required pattern: ${englishJoinWords(requiredPatterns.map((re) => re.source))}`,
+            renameToNames: []
+          };
+        }
         const forbiddenPrefix = forbiddenPrefixes?.find((prefix2) => name.startsWith(prefix2));
         if (forbiddenPrefix) {
           return {
@@ -4807,22 +4756,6 @@ var ALLOWED_KINDS2 = [
   Kind17.ENUM_VALUE_DEFINITION,
   Kind17.OPERATION_DEFINITION
 ];
-var entries = /* @__PURE__ */ Object.create(null);
-for (const kind of [...ALLOWED_KINDS2].sort()) {
-  let description = `> [!NOTE]
->
-> Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
-  if (kind === Kind17.OPERATION_DEFINITION) {
-    description += [
-      "",
-      "",
-      "> [!WARNING]",
-      ">",
-      '> You must use only comment syntax `#` and not description syntax `"""` or `"`.'
-    ].join("\n");
-  }
-  entries[kind] = { type: "boolean", description };
-}
 var schema12 = {
   type: "array",
   minItems: 1,
@@ -4847,7 +4780,23 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join("\n")}`
         ...ARRAY_DEFAULT_OPTIONS,
         description: ["Ignore specific selectors", eslintSelectorsTip].join("\n")
       },
-      ...entries
+      ...Object.fromEntries(
+        [...ALLOWED_KINDS2].sort().map((kind) => {
+          let description = `> [!NOTE]
+>
+> Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
+          if (kind === Kind17.OPERATION_DEFINITION) {
+            description += [
+              "",
+              "",
+              "> [!WARNING]",
+              ">",
+              '> You must use only comment syntax `#` and not description syntax `"""` or `"`.'
+            ].join("\n");
+          }
+          return [kind, { type: "boolean", description }];
+        })
+      )
     }
   }
 };

package/cjs/index.d.cts

@@ -1,3 +1,4 @@
+import { RuleOptions } from './rules/require-description/index.cjs';
 import { CaseStyle } from './utils.cjs';
 export { requireGraphQLOperations, requireGraphQLSchema } from './utils.cjs';
 import * as graphql from 'graphql';
@@ -100,9 +101,9 @@ declare const _default: {
                 forbiddenPatterns?: {
                     [x: string]: unknown;
                 }[] | undefined;
-                requiredPattern?: {
+                requiredPatterns?: {
                     [x: string]: unknown;
-                } | undefined;
+                }[] | undefined;
                 forbiddenPrefixes?: string[] | undefined;
                 forbiddenSuffixes?: string[] | undefined;
                 requiredPrefixes?: string[] | undefined;
@@ -140,22 +141,7 @@ declare const _default: {
             argumentName?: string | undefined;
         }[]>;
         'require-deprecation-reason': GraphQLESLintRule;
-        'require-description': GraphQLESLintRule<{
-            types?: true | undefined;
-            OperationDefinition?: boolean | undefined;
-            ScalarTypeDefinition?: boolean | undefined;
-            ObjectTypeDefinition?: boolean | undefined;
-            FieldDefinition?: boolean | undefined;
-            InputValueDefinition?: boolean | undefined;
-            InterfaceTypeDefinition?: boolean | undefined;
-            UnionTypeDefinition?: boolean | undefined;
-            EnumTypeDefinition?: boolean | undefined;
-            EnumValueDefinition?: boolean | undefined;
-            InputObjectTypeDefinition?: boolean | undefined;
-            DirectiveDefinition?: boolean | undefined;
-            rootField?: true | undefined;
-            ignoredSelectors?: string[] | undefined;
-        }[]>;
+        'require-description': GraphQLESLintRule<RuleOptions>;
         'require-field-of-type-query-in-mutation-result': GraphQLESLintRule;
         'require-import-fragment': GraphQLESLintRule;
         'require-nullable-fields-with-oneof': GraphQLESLintRule;

package/cjs/meta.js

@@ -1,4 +1,4 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});const version = "4.3.1-alpha-20241207204625-6a4230707a78900a6339b03afe904b9dd6c31561";
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});const version = "4.3.1-alpha-20241209185034-de2d7397da8c26620a8930dd12b6dff42e43f537";
 
 
 exports.version = version;

package/cjs/rules/index.d.cts

@@ -1,3 +1,4 @@
+import { RuleOptions } from './require-description/index.cjs';
 import { CaseStyle } from '../utils.cjs';
 import * as graphql from 'graphql';
 import { GraphQLESLintRule } from '../types.cjs';
@@ -63,9 +64,9 @@ declare const rules: {
             forbiddenPatterns?: {
                 [x: string]: unknown;
             }[] | undefined;
-            requiredPattern?: {
+            requiredPatterns?: {
                 [x: string]: unknown;
-            } | undefined;
+            }[] | undefined;
             forbiddenPrefixes?: string[] | undefined;
             forbiddenSuffixes?: string[] | undefined;
             requiredPrefixes?: string[] | undefined;
@@ -103,22 +104,7 @@ declare const rules: {
         argumentName?: string | undefined;
     }[]>;
     'require-deprecation-reason': GraphQLESLintRule;
-    'require-description': GraphQLESLintRule<{
-        types?: true | undefined;
-        OperationDefinition?: boolean | undefined;
-        ScalarTypeDefinition?: boolean | undefined;
-        ObjectTypeDefinition?: boolean | undefined;
-        FieldDefinition?: boolean | undefined;
-        InputValueDefinition?: boolean | undefined;
-        InterfaceTypeDefinition?: boolean | undefined;
-        UnionTypeDefinition?: boolean | undefined;
-        EnumTypeDefinition?: boolean | undefined;
-        EnumValueDefinition?: boolean | undefined;
-        InputObjectTypeDefinition?: boolean | undefined;
-        DirectiveDefinition?: boolean | undefined;
-        rootField?: true | undefined;
-        ignoredSelectors?: string[] | undefined;
-    }[]>;
+    'require-description': GraphQLESLintRule<RuleOptions>;
     'require-field-of-type-query-in-mutation-result': GraphQLESLintRule;
     'require-import-fragment': GraphQLESLintRule;
     'require-nullable-fields-with-oneof': GraphQLESLintRule;

package/cjs/rules/match-document-filename/index.d.cts

@@ -13,8 +13,8 @@ type CaseStyle = CaseStyle$1 | 'matchDocumentStyle';
 declare const schema: {
     readonly definitions: {
         readonly asString: {
-            enum: CaseStyle[];
-            description: string;
+            readonly enum: CaseStyle[];
+            readonly description: `One of: ${string}`;
         };
         readonly asObject: {
             readonly type: "object";
@@ -22,8 +22,7 @@ declare const schema: {
             readonly minProperties: 1;
             readonly properties: {
                 readonly style: {
-                    enum: CaseStyle[];
-                    description: string;
+                    readonly enum: CaseStyle[];
                 };
                 readonly suffix: {
                     readonly type: "string";

package/cjs/rules/match-document-filename/index.js

@@ -18,19 +18,18 @@ const CASE_STYLES = [
 const schemaOption = {
   oneOf: [{ $ref: "#/definitions/asString" }, { $ref: "#/definitions/asObject" }]
 };
-const caseSchema = {
-  enum: CASE_STYLES,
-  description: `One of: ${CASE_STYLES.map((t) => `\`${t}\``).join(", ")}`
-};
 const schema = {
   definitions: {
-    asString: caseSchema,
+    asString: {
+      enum: CASE_STYLES,
+      description: `One of: ${CASE_STYLES.map((t) => `\`${t}\``).join(", ")}`
+    },
     asObject: {
       type: "object",
       additionalProperties: false,
       minProperties: 1,
       properties: {
-        style: caseSchema,
+        style: { enum: CASE_STYLES },
         suffix: { type: "string" },
         prefix: { type: "string" }
       }

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

@@ -12,16 +12,15 @@ type AllowedStyle = 'camelCase' | 'PascalCase' | 'snake_case' | 'UPPER_CASE';
 declare const schema: {
     readonly definitions: {
         readonly asString: {
-            enum: AllowedStyle[];
-            description: string;
+            readonly enum: AllowedStyle[];
+            readonly description: `One of: ${string}`;
         };
         readonly asObject: {
             readonly type: "object";
             readonly additionalProperties: false;
             readonly properties: {
                 readonly style: {
-                    enum: AllowedStyle[];
-                    description: string;
+                    readonly enum: AllowedStyle[];
                 };
                 readonly prefix: {
                     readonly type: "string";
@@ -38,9 +37,14 @@ declare const schema: {
                     readonly uniqueItems: true;
                     readonly minItems: 1;
                 };
-                readonly requiredPattern: {
-                    readonly type: "object";
+                readonly requiredPatterns: {
+                    readonly items: {
+                        readonly type: "object";
+                    };
                     readonly description: "Should be of instance of `RegEx`";
+                    readonly type: "array";
+                    readonly uniqueItems: true;
+                    readonly minItems: 1;
                 };
                 readonly forbiddenPrefixes: {
                     readonly description: string;

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

@@ -36,21 +36,20 @@ const ALLOWED_STYLES = Object.keys(StyleToRegex);
 const schemaOption = {
   oneOf: [{ $ref: "#/definitions/asString" }, { $ref: "#/definitions/asObject" }]
 };
-const descriptionPrefixesSuffixes = (name, id) => `> [!WARNING]
+const descriptionPrefixesSuffixes = (name) => `> [!WARNING]
 >
-> This option is deprecated and will be removed in the next major release. Use [\`${name}\`](#${id}) instead.`;
-const caseSchema = {
-  enum: ALLOWED_STYLES,
-  description: `One of: ${ALLOWED_STYLES.map((t) => `\`${t}\``).join(", ")}`
-};
+> This option is deprecated and will be removed in the next major release. Use [\`${name}\`](#${name.toLowerCase()}-array) instead.`;
 const schema = {
   definitions: {
-    asString: caseSchema,
+    asString: {
+      enum: ALLOWED_STYLES,
+      description: `One of: ${ALLOWED_STYLES.map((t) => `\`${t}\``).join(", ")}`
+    },
     asObject: {
       type: "object",
       additionalProperties: false,
       properties: {
-        style: caseSchema,
+        style: { enum: ALLOWED_STYLES },
         prefix: { type: "string" },
         suffix: { type: "string" },
         forbiddenPatterns: {
@@ -60,25 +59,28 @@ const schema = {
           },
           description: "Should be of instance of `RegEx`"
         },
-        requiredPattern: {
-          type: "object",
+        requiredPatterns: {
+          ..._utilsjs.ARRAY_DEFAULT_OPTIONS,
+          items: {
+            type: "object"
+          },
           description: "Should be of instance of `RegEx`"
         },
         forbiddenPrefixes: {
           ..._utilsjs.ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("forbiddenPatterns", "forbiddenpatterns-array")
+          description: descriptionPrefixesSuffixes("forbiddenPatterns")
         },
         forbiddenSuffixes: {
           ..._utilsjs.ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("forbiddenPatterns", "forbiddenpatterns-array")
+          description: descriptionPrefixesSuffixes("forbiddenPatterns")
         },
         requiredPrefixes: {
           ..._utilsjs.ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("requiredPattern", "requiredpattern-object")
+          description: descriptionPrefixesSuffixes("requiredPatterns")
         },
         requiredSuffixes: {
           ..._utilsjs.ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("requiredPattern", "requiredpattern-object")
+          description: descriptionPrefixesSuffixes("requiredPatterns")
         },
         ignorePattern: {
           type: "string",
@@ -270,30 +272,6 @@ const rule = {
             }
           `
           )
-        },
-        {
-          title: "Correct (Relay fragment convention `<module_name>_<property_name>`)",
-          usage: [
-            {
-              FragmentDefinition: {
-                style: "PascalCase",
-                requiredPattern: /_(?<camelCase>.+?)$/
-              }
-            }
-          ],
-          code: (
-            /* GraphQL */
-            `
-            # schema
-            type User {
-              # ...
-            }
-            # operations
-            fragment UserFields_data on User {
-              # ...
-            }
-          `
-          )
         }
       ],
       configOptions: {
@@ -388,7 +366,7 @@ const rule = {
         requiredPrefixes,
         requiredSuffixes,
         forbiddenPatterns,
-        requiredPattern
+        requiredPatterns
       } = normalisePropertyOption(selector);
       const nodeName = node.value;
       const error = getError();
@@ -407,9 +385,7 @@ const rule = {
         );
       }
       function getError() {
-        let name = nodeName;
-        if (allowLeadingUnderscore) name = name.replace(/^_+/, "");
-        if (allowTrailingUnderscore) name = name.replace(/_+$/, "");
+        const name = nodeName.replace(/(^_+)|(_+$)/g, "");
         if (ignorePattern && new RegExp(ignorePattern, "u").test(name)) {
           if ("name" in n) {
             ignoredNodes.add(n.name);
@@ -428,38 +404,6 @@ const rule = {
             renameToNames: [name + suffix]
           };
         }
-        if (requiredPattern) {
-          if (requiredPattern.source.includes("(?<")) {
-            try {
-              name = name.replace(requiredPattern, (originalString, ...args) => {
-                const groups = args.at(-1);
-                for (const [styleName, value] of Object.entries(groups)) {
-                  if (!(styleName in StyleToRegex)) {
-                    throw new Error("Invalid case style in `requiredPatterns` option");
-                  }
-                  if (value === _utilsjs.convertCase.call(void 0, styleName, value)) {
-                    return "";
-                  }
-                  throw new Error(`contain the required pattern: ${requiredPattern}`);
-                }
-                return originalString;
-              });
-              if (name === nodeName) {
-                throw new Error(`contain the required pattern: ${requiredPattern}`);
-              }
-            } catch (error2) {
-              return {
-                errorMessage: error2.message,
-                renameToNames: []
-              };
-            }
-          } else if (!requiredPattern.test(name)) {
-            return {
-              errorMessage: `contain the required pattern: ${requiredPattern}`,
-              renameToNames: []
-            };
-          }
-        }
         const forbidden = _optionalChain([forbiddenPatterns, 'optionalAccess', _ => _.find, 'call', _2 => _2((pattern) => pattern.test(name))]);
         if (forbidden) {
           return {
@@ -467,6 +411,12 @@ const rule = {
             renameToNames: [name.replace(forbidden, "")]
           };
         }
+        if (requiredPatterns && !requiredPatterns.some((pattern) => pattern.test(name))) {
+          return {
+            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))]);
         if (forbiddenPrefix) {
           return {

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

@@ -1,91 +1,25 @@
-import { FromSchema } from 'json-schema-to-ts';
+import { Kind } from 'graphql';
 import { GraphQLESLintRule } from '../../types.cjs';
 import 'eslint';
 import 'estree';
-import 'graphql';
 import 'graphql-config';
+import 'json-schema-to-ts';
 import '../../estree-converter/types.cjs';
 import '../../siblings.cjs';
 import '@graphql-tools/utils';
 
 declare const RULE_ID = "require-description";
-declare const schema: {
-    readonly type: "array";
-    readonly minItems: 1;
-    readonly maxItems: 1;
-    readonly items: {
-        readonly type: "object";
-        readonly additionalProperties: false;
-        readonly minProperties: 1;
-        readonly properties: {
-            readonly OperationDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly ScalarTypeDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly ObjectTypeDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly FieldDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly InputValueDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly InterfaceTypeDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly UnionTypeDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly EnumTypeDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly EnumValueDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly InputObjectTypeDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly DirectiveDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly types: {
-                readonly type: "boolean";
-                readonly enum: readonly [true];
-                readonly description: `Includes:
-${string}`;
-            };
-            readonly rootField: {
-                readonly type: "boolean";
-                readonly enum: readonly [true];
-                readonly description: "Definitions within `Query`, `Mutation`, and `Subscription` root types.";
-            };
-            readonly ignoredSelectors: {
-                readonly description: string;
-                readonly type: "array";
-                readonly uniqueItems: true;
-                readonly minItems: 1;
-                readonly items: {
-                    readonly type: "string";
-                };
-            };
-        };
-    };
-};
-type RuleOptions = FromSchema<typeof schema>;
+declare const ALLOWED_KINDS: readonly [Kind.OBJECT_TYPE_DEFINITION, Kind.INTERFACE_TYPE_DEFINITION, Kind.ENUM_TYPE_DEFINITION, Kind.SCALAR_TYPE_DEFINITION, Kind.INPUT_OBJECT_TYPE_DEFINITION, Kind.UNION_TYPE_DEFINITION, Kind.DIRECTIVE_DEFINITION, Kind.FIELD_DEFINITION, Kind.INPUT_VALUE_DEFINITION, Kind.ENUM_VALUE_DEFINITION, Kind.OPERATION_DEFINITION];
+type AllowedKind = (typeof ALLOWED_KINDS)[number];
+type RuleOptions = [
+    {
+        [key in AllowedKind]?: boolean;
+    } & {
+        types?: true;
+        rootField?: true;
+        ignoredSelectors?: string[];
+    }
+];
 declare const rule: GraphQLESLintRule<RuleOptions>;
 
 export { RULE_ID, type RuleOptions, rule };

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

@@ -17,22 +17,6 @@ const ALLOWED_KINDS = [
   _graphql.Kind.ENUM_VALUE_DEFINITION,
   _graphql.Kind.OPERATION_DEFINITION
 ];
-const entries = /* @__PURE__ */ Object.create(null);
-for (const kind of [...ALLOWED_KINDS].sort()) {
-  let description = `> [!NOTE]
->
-> Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
-  if (kind === _graphql.Kind.OPERATION_DEFINITION) {
-    description += [
-      "",
-      "",
-      "> [!WARNING]",
-      ">",
-      '> You must use only comment syntax `#` and not description syntax `"""` or `"`.'
-    ].join("\n");
-  }
-  entries[kind] = { type: "boolean", description };
-}
 const schema = {
   type: "array",
   minItems: 1,
@@ -57,7 +41,23 @@ ${_utilsjs.TYPES_KINDS.map((kind) => `- \`${kind}\``).join("\n")}`
         ..._utilsjs.ARRAY_DEFAULT_OPTIONS,
         description: ["Ignore specific selectors", _utilsjs.eslintSelectorsTip].join("\n")
       },
-      ...entries
+      ...Object.fromEntries(
+        [...ALLOWED_KINDS].sort().map((kind) => {
+          let description = `> [!NOTE]
+>
+> Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
+          if (kind === _graphql.Kind.OPERATION_DEFINITION) {
+            description += [
+              "",
+              "",
+              "> [!WARNING]",
+              ">",
+              '> You must use only comment syntax `#` and not description syntax `"""` or `"`.'
+            ].join("\n");
+          }
+          return [kind, { type: "boolean", description }];
+        })
+      )
     }
   }
 };

package/esm/index.d.ts

@@ -1,3 +1,4 @@
+import { RuleOptions } from './rules/require-description/index.js';
 import { CaseStyle } from './utils.js';
 export { requireGraphQLOperations, requireGraphQLSchema } from './utils.js';
 import * as graphql from 'graphql';
@@ -48,10 +49,10 @@ declare const _default: {
     };
     rules: {
         alphabetize: GraphQLESLintRule<{
-            values?: boolean | undefined;
             definitions?: boolean | undefined;
             selections?: ("OperationDefinition" | "FragmentDefinition")[] | undefined;
             arguments?: ("Field" | "Directive" | "FieldDefinition" | "DirectiveDefinition")[] | undefined;
+            values?: boolean | undefined;
             fields?: ("ObjectTypeDefinition" | "InterfaceTypeDefinition" | "InputObjectTypeDefinition")[] | undefined;
             variables?: boolean | undefined;
             groups?: string[] | undefined;
@@ -100,9 +101,9 @@ declare const _default: {
                 forbiddenPatterns?: {
                     [x: string]: unknown;
                 }[] | undefined;
-                requiredPattern?: {
+                requiredPatterns?: {
                     [x: string]: unknown;
-                } | undefined;
+                }[] | undefined;
                 forbiddenPrefixes?: string[] | undefined;
                 forbiddenSuffixes?: string[] | undefined;
                 requiredPrefixes?: string[] | undefined;
@@ -140,22 +141,7 @@ declare const _default: {
             argumentName?: string | undefined;
         }[]>;
         'require-deprecation-reason': GraphQLESLintRule;
-        'require-description': GraphQLESLintRule<{
-            types?: true | undefined;
-            OperationDefinition?: boolean | undefined;
-            ScalarTypeDefinition?: boolean | undefined;
-            ObjectTypeDefinition?: boolean | undefined;
-            FieldDefinition?: boolean | undefined;
-            InputValueDefinition?: boolean | undefined;
-            InterfaceTypeDefinition?: boolean | undefined;
-            UnionTypeDefinition?: boolean | undefined;
-            EnumTypeDefinition?: boolean | undefined;
-            EnumValueDefinition?: boolean | undefined;
-            InputObjectTypeDefinition?: boolean | undefined;
-            DirectiveDefinition?: boolean | undefined;
-            rootField?: true | undefined;
-            ignoredSelectors?: string[] | undefined;
-        }[]>;
+        'require-description': GraphQLESLintRule<RuleOptions>;
         'require-field-of-type-query-in-mutation-result': GraphQLESLintRule;
         'require-import-fragment': GraphQLESLintRule;
         'require-nullable-fields-with-oneof': GraphQLESLintRule;

package/esm/meta.js

@@ -1,4 +1,4 @@
-const version = "4.3.1-alpha-20241207204625-6a4230707a78900a6339b03afe904b9dd6c31561";
+const version = "4.3.1-alpha-20241209185034-de2d7397da8c26620a8930dd12b6dff42e43f537";
 export {
   version
 };

package/esm/rules/index.d.ts

@@ -1,3 +1,4 @@
+import { RuleOptions } from './require-description/index.js';
 import { CaseStyle } from '../utils.js';
 import * as graphql from 'graphql';
 import { GraphQLESLintRule } from '../types.js';
@@ -11,10 +12,10 @@ import 'json-schema-to-ts';
 
 declare const rules: {
     alphabetize: GraphQLESLintRule<{
-        values?: boolean | undefined;
         definitions?: boolean | undefined;
         selections?: ("OperationDefinition" | "FragmentDefinition")[] | undefined;
         arguments?: ("Field" | "Directive" | "FieldDefinition" | "DirectiveDefinition")[] | undefined;
+        values?: boolean | undefined;
         fields?: ("ObjectTypeDefinition" | "InterfaceTypeDefinition" | "InputObjectTypeDefinition")[] | undefined;
         variables?: boolean | undefined;
         groups?: string[] | undefined;
@@ -63,9 +64,9 @@ declare const rules: {
             forbiddenPatterns?: {
                 [x: string]: unknown;
             }[] | undefined;
-            requiredPattern?: {
+            requiredPatterns?: {
                 [x: string]: unknown;
-            } | undefined;
+            }[] | undefined;
             forbiddenPrefixes?: string[] | undefined;
             forbiddenSuffixes?: string[] | undefined;
             requiredPrefixes?: string[] | undefined;
@@ -103,22 +104,7 @@ declare const rules: {
         argumentName?: string | undefined;
     }[]>;
     'require-deprecation-reason': GraphQLESLintRule;
-    'require-description': GraphQLESLintRule<{
-        types?: true | undefined;
-        OperationDefinition?: boolean | undefined;
-        ScalarTypeDefinition?: boolean | undefined;
-        ObjectTypeDefinition?: boolean | undefined;
-        FieldDefinition?: boolean | undefined;
-        InputValueDefinition?: boolean | undefined;
-        InterfaceTypeDefinition?: boolean | undefined;
-        UnionTypeDefinition?: boolean | undefined;
-        EnumTypeDefinition?: boolean | undefined;
-        EnumValueDefinition?: boolean | undefined;
-        InputObjectTypeDefinition?: boolean | undefined;
-        DirectiveDefinition?: boolean | undefined;
-        rootField?: true | undefined;
-        ignoredSelectors?: string[] | undefined;
-    }[]>;
+    'require-description': GraphQLESLintRule<RuleOptions>;
     'require-field-of-type-query-in-mutation-result': GraphQLESLintRule;
     'require-import-fragment': GraphQLESLintRule;
     'require-nullable-fields-with-oneof': GraphQLESLintRule;

package/esm/rules/match-document-filename/index.d.ts

@@ -13,8 +13,8 @@ type CaseStyle = CaseStyle$1 | 'matchDocumentStyle';
 declare const schema: {
     readonly definitions: {
         readonly asString: {
-            enum: CaseStyle[];
-            description: string;
+            readonly enum: CaseStyle[];
+            readonly description: `One of: ${string}`;
         };
         readonly asObject: {
             readonly type: "object";
@@ -22,8 +22,7 @@ declare const schema: {
             readonly minProperties: 1;
             readonly properties: {
                 readonly style: {
-                    enum: CaseStyle[];
-                    description: string;
+                    readonly enum: CaseStyle[];
                 };
                 readonly suffix: {
                     readonly type: "string";

package/esm/rules/match-document-filename/index.js

@@ -18,19 +18,18 @@ const CASE_STYLES = [
 const schemaOption = {
   oneOf: [{ $ref: "#/definitions/asString" }, { $ref: "#/definitions/asObject" }]
 };
-const caseSchema = {
-  enum: CASE_STYLES,
-  description: `One of: ${CASE_STYLES.map((t) => `\`${t}\``).join(", ")}`
-};
 const schema = {
   definitions: {
-    asString: caseSchema,
+    asString: {
+      enum: CASE_STYLES,
+      description: `One of: ${CASE_STYLES.map((t) => `\`${t}\``).join(", ")}`
+    },
     asObject: {
       type: "object",
       additionalProperties: false,
       minProperties: 1,
       properties: {
-        style: caseSchema,
+        style: { enum: CASE_STYLES },
         suffix: { type: "string" },
         prefix: { type: "string" }
       }

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

@@ -12,16 +12,15 @@ type AllowedStyle = 'camelCase' | 'PascalCase' | 'snake_case' | 'UPPER_CASE';
 declare const schema: {
     readonly definitions: {
         readonly asString: {
-            enum: AllowedStyle[];
-            description: string;
+            readonly enum: AllowedStyle[];
+            readonly description: `One of: ${string}`;
         };
         readonly asObject: {
             readonly type: "object";
             readonly additionalProperties: false;
             readonly properties: {
                 readonly style: {
-                    enum: AllowedStyle[];
-                    description: string;
+                    readonly enum: AllowedStyle[];
                 };
                 readonly prefix: {
                     readonly type: "string";
@@ -38,9 +37,14 @@ declare const schema: {
                     readonly uniqueItems: true;
                     readonly minItems: 1;
                 };
-                readonly requiredPattern: {
-                    readonly type: "object";
+                readonly requiredPatterns: {
+                    readonly items: {
+                        readonly type: "object";
+                    };
                     readonly description: "Should be of instance of `RegEx`";
+                    readonly type: "array";
+                    readonly uniqueItems: true;
+                    readonly minItems: 1;
                 };
                 readonly forbiddenPrefixes: {
                     readonly description: string;

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

@@ -36,21 +36,20 @@ const ALLOWED_STYLES = Object.keys(StyleToRegex);
 const schemaOption = {
   oneOf: [{ $ref: "#/definitions/asString" }, { $ref: "#/definitions/asObject" }]
 };
-const descriptionPrefixesSuffixes = (name, id) => `> [!WARNING]
+const descriptionPrefixesSuffixes = (name) => `> [!WARNING]
 >
-> This option is deprecated and will be removed in the next major release. Use [\`${name}\`](#${id}) instead.`;
-const caseSchema = {
-  enum: ALLOWED_STYLES,
-  description: `One of: ${ALLOWED_STYLES.map((t) => `\`${t}\``).join(", ")}`
-};
+> This option is deprecated and will be removed in the next major release. Use [\`${name}\`](#${name.toLowerCase()}-array) instead.`;
 const schema = {
   definitions: {
-    asString: caseSchema,
+    asString: {
+      enum: ALLOWED_STYLES,
+      description: `One of: ${ALLOWED_STYLES.map((t) => `\`${t}\``).join(", ")}`
+    },
     asObject: {
       type: "object",
       additionalProperties: false,
       properties: {
-        style: caseSchema,
+        style: { enum: ALLOWED_STYLES },
         prefix: { type: "string" },
         suffix: { type: "string" },
         forbiddenPatterns: {
@@ -60,25 +59,28 @@ const schema = {
           },
           description: "Should be of instance of `RegEx`"
         },
-        requiredPattern: {
-          type: "object",
+        requiredPatterns: {
+          ...ARRAY_DEFAULT_OPTIONS,
+          items: {
+            type: "object"
+          },
           description: "Should be of instance of `RegEx`"
         },
         forbiddenPrefixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("forbiddenPatterns", "forbiddenpatterns-array")
+          description: descriptionPrefixesSuffixes("forbiddenPatterns")
         },
         forbiddenSuffixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("forbiddenPatterns", "forbiddenpatterns-array")
+          description: descriptionPrefixesSuffixes("forbiddenPatterns")
         },
         requiredPrefixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("requiredPattern", "requiredpattern-object")
+          description: descriptionPrefixesSuffixes("requiredPatterns")
         },
         requiredSuffixes: {
           ...ARRAY_DEFAULT_OPTIONS,
-          description: descriptionPrefixesSuffixes("requiredPattern", "requiredpattern-object")
+          description: descriptionPrefixesSuffixes("requiredPatterns")
         },
         ignorePattern: {
           type: "string",
@@ -270,30 +272,6 @@ const rule = {
             }
           `
           )
-        },
-        {
-          title: "Correct (Relay fragment convention `<module_name>_<property_name>`)",
-          usage: [
-            {
-              FragmentDefinition: {
-                style: "PascalCase",
-                requiredPattern: /_(?<camelCase>.+?)$/
-              }
-            }
-          ],
-          code: (
-            /* GraphQL */
-            `
-            # schema
-            type User {
-              # ...
-            }
-            # operations
-            fragment UserFields_data on User {
-              # ...
-            }
-          `
-          )
         }
       ],
       configOptions: {
@@ -388,7 +366,7 @@ const rule = {
         requiredPrefixes,
         requiredSuffixes,
         forbiddenPatterns,
-        requiredPattern
+        requiredPatterns
       } = normalisePropertyOption(selector);
       const nodeName = node.value;
       const error = getError();
@@ -407,9 +385,7 @@ const rule = {
         );
       }
       function getError() {
-        let name = nodeName;
-        if (allowLeadingUnderscore) name = name.replace(/^_+/, "");
-        if (allowTrailingUnderscore) name = name.replace(/_+$/, "");
+        const name = nodeName.replace(/(^_+)|(_+$)/g, "");
         if (ignorePattern && new RegExp(ignorePattern, "u").test(name)) {
           if ("name" in n) {
             ignoredNodes.add(n.name);
@@ -428,38 +404,6 @@ const rule = {
             renameToNames: [name + suffix]
           };
         }
-        if (requiredPattern) {
-          if (requiredPattern.source.includes("(?<")) {
-            try {
-              name = name.replace(requiredPattern, (originalString, ...args) => {
-                const groups = args.at(-1);
-                for (const [styleName, value] of Object.entries(groups)) {
-                  if (!(styleName in StyleToRegex)) {
-                    throw new Error("Invalid case style in `requiredPatterns` option");
-                  }
-                  if (value === convertCase(styleName, value)) {
-                    return "";
-                  }
-                  throw new Error(`contain the required pattern: ${requiredPattern}`);
-                }
-                return originalString;
-              });
-              if (name === nodeName) {
-                throw new Error(`contain the required pattern: ${requiredPattern}`);
-              }
-            } catch (error2) {
-              return {
-                errorMessage: error2.message,
-                renameToNames: []
-              };
-            }
-          } else if (!requiredPattern.test(name)) {
-            return {
-              errorMessage: `contain the required pattern: ${requiredPattern}`,
-              renameToNames: []
-            };
-          }
-        }
         const forbidden = forbiddenPatterns?.find((pattern) => pattern.test(name));
         if (forbidden) {
           return {
@@ -467,6 +411,12 @@ const rule = {
             renameToNames: [name.replace(forbidden, "")]
           };
         }
+        if (requiredPatterns && !requiredPatterns.some((pattern) => pattern.test(name))) {
+          return {
+            errorMessage: `contain the required pattern: ${englishJoinWords(requiredPatterns.map((re) => re.source))}`,
+            renameToNames: []
+          };
+        }
         const forbiddenPrefix = forbiddenPrefixes?.find((prefix2) => name.startsWith(prefix2));
         if (forbiddenPrefix) {
           return {

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

@@ -1,91 +1,25 @@
-import { FromSchema } from 'json-schema-to-ts';
+import { Kind } from 'graphql';
 import { GraphQLESLintRule } from '../../types.js';
 import 'eslint';
 import 'estree';
-import 'graphql';
 import 'graphql-config';
+import 'json-schema-to-ts';
 import '../../estree-converter/types.js';
 import '../../siblings.js';
 import '@graphql-tools/utils';
 
 declare const RULE_ID = "require-description";
-declare const schema: {
-    readonly type: "array";
-    readonly minItems: 1;
-    readonly maxItems: 1;
-    readonly items: {
-        readonly type: "object";
-        readonly additionalProperties: false;
-        readonly minProperties: 1;
-        readonly properties: {
-            readonly OperationDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly ScalarTypeDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly ObjectTypeDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly FieldDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly InputValueDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly InterfaceTypeDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly UnionTypeDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly EnumTypeDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly EnumValueDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly InputObjectTypeDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly DirectiveDefinition: {
-                type: "boolean";
-                description: string;
-            };
-            readonly types: {
-                readonly type: "boolean";
-                readonly enum: readonly [true];
-                readonly description: `Includes:
-${string}`;
-            };
-            readonly rootField: {
-                readonly type: "boolean";
-                readonly enum: readonly [true];
-                readonly description: "Definitions within `Query`, `Mutation`, and `Subscription` root types.";
-            };
-            readonly ignoredSelectors: {
-                readonly description: string;
-                readonly type: "array";
-                readonly uniqueItems: true;
-                readonly minItems: 1;
-                readonly items: {
-                    readonly type: "string";
-                };
-            };
-        };
-    };
-};
-type RuleOptions = FromSchema<typeof schema>;
+declare const ALLOWED_KINDS: readonly [Kind.OBJECT_TYPE_DEFINITION, Kind.INTERFACE_TYPE_DEFINITION, Kind.ENUM_TYPE_DEFINITION, Kind.SCALAR_TYPE_DEFINITION, Kind.INPUT_OBJECT_TYPE_DEFINITION, Kind.UNION_TYPE_DEFINITION, Kind.DIRECTIVE_DEFINITION, Kind.FIELD_DEFINITION, Kind.INPUT_VALUE_DEFINITION, Kind.ENUM_VALUE_DEFINITION, Kind.OPERATION_DEFINITION];
+type AllowedKind = (typeof ALLOWED_KINDS)[number];
+type RuleOptions = [
+    {
+        [key in AllowedKind]?: boolean;
+    } & {
+        types?: true;
+        rootField?: true;
+        ignoredSelectors?: string[];
+    }
+];
 declare const rule: GraphQLESLintRule<RuleOptions>;
 
 export { RULE_ID, type RuleOptions, rule };

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

@@ -17,22 +17,6 @@ const ALLOWED_KINDS = [
   Kind.ENUM_VALUE_DEFINITION,
   Kind.OPERATION_DEFINITION
 ];
-const entries = /* @__PURE__ */ Object.create(null);
-for (const kind of [...ALLOWED_KINDS].sort()) {
-  let description = `> [!NOTE]
->
-> Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
-  if (kind === Kind.OPERATION_DEFINITION) {
-    description += [
-      "",
-      "",
-      "> [!WARNING]",
-      ">",
-      '> You must use only comment syntax `#` and not description syntax `"""` or `"`.'
-    ].join("\n");
-  }
-  entries[kind] = { type: "boolean", description };
-}
 const schema = {
   type: "array",
   minItems: 1,
@@ -57,7 +41,23 @@ ${TYPES_KINDS.map((kind) => `- \`${kind}\``).join("\n")}`
         ...ARRAY_DEFAULT_OPTIONS,
         description: ["Ignore specific selectors", eslintSelectorsTip].join("\n")
       },
-      ...entries
+      ...Object.fromEntries(
+        [...ALLOWED_KINDS].sort().map((kind) => {
+          let description = `> [!NOTE]
+>
+> Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
+          if (kind === Kind.OPERATION_DEFINITION) {
+            description += [
+              "",
+              "",
+              "> [!WARNING]",
+              ">",
+              '> You must use only comment syntax `#` and not description syntax `"""` or `"`.'
+            ].join("\n");
+          }
+          return [kind, { type: "boolean", description }];
+        })
+      )
     }
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "4.3.1-alpha-20241207204625-6a4230707a78900a6339b03afe904b9dd6c31561",
+  "version": "4.3.1-alpha-20241209185034-de2d7397da8c26620a8930dd12b6dff42e43f537",
   "type": "module",
   "description": "GraphQL plugin for ESLint",
   "repository": "https://github.com/dimaMachina/graphql-eslint",
@@ -20,6 +20,16 @@
         "types": "./esm/index.d.ts",
         "default": "./esm/index.js"
       }
+    },
+    "./*": {
+      "require": {
+        "types": "./cjs/*.d.cts",
+        "default": "./cjs/*.js"
+      },
+      "import": {
+        "types": "./esm/*.d.ts",
+        "default": "./esm/*.js"
+      }
     }
   },
   "types": "esm/index.d.ts",