more

Author: dimaMachina

.changeset/happy-bottles-warn.md

@@ -2,5 +2,5 @@
 '@graphql-eslint/eslint-plugin': minor
 ---
 
-introduce `forbiddenPattern` and `requiredPattern` options for `naming-convention` rule and
+introduce `forbiddenPatterns` and `requiredPatterns` options for `naming-convention` rule and
 deprecate `forbiddenPrefixes`, `forbiddenSuffixes` and `requiredPrefixes` and `requiredSuffixes`

.changeset/long-chicken-press.md

@@ -2,4 +2,5 @@
 '@graphql-eslint/eslint-plugin': minor
 ---
 
-add new option `ignoredSelectors` for `require-description` rule, to ignore eslint selectors, e.g. types which ends with `Connection` or `Edge`
+add new option `ignoredSelectors` for `require-description` rule, to ignore eslint selectors, e.g.
+types which ends with `Connection` or `Edge`

packages/plugin/src/rules/naming-convention/index.test.ts

@@ -527,19 +527,19 @@ ruleTester.run<RuleOptions>('naming-convention', rule, {
       errors: 2,
     },
     {
-      name: 'forbiddenPattern',
+      name: 'forbiddenPatterns',
       code: 'query queryFoo { foo } query getBar { bar }',
-      options: [{ OperationDefinition: { forbiddenPattern: [/^(get|query)/] } }],
+      options: [{ OperationDefinition: { forbiddenPatterns: [/^(get|query)/] } }],
       errors: 2,
     },
     {
-      name: 'requiredPattern',
+      name: 'requiredPatterns',
       code: 'type Test { enabled: Boolean! }',
       options: [
         {
           'FieldDefinition[gqlType.gqlType.name.value=Boolean]': {
             style: 'camelCase',
-            requiredPattern: [/^(is|has)/],
+            requiredPatterns: [/^(is|has)/],
           },
         },
       ],

packages/plugin/src/rules/naming-convention/index.ts

@@ -48,7 +48,7 @@ const schemaOption = {
   oneOf: [{ $ref: '#/definitions/asString' }, { $ref: '#/definitions/asObject' }],
 } as const;
 
-const descriptionPrefixesSuffixes = (name: 'forbiddenPattern' | 'requiredPattern') =>
+const descriptionPrefixesSuffixes = (name: 'forbiddenPatterns' | 'requiredPatterns') =>
   `> [!WARNING]
 >
 > This option is deprecated and will be removed in the next major release. Use [\`${name}\`](#${name.toLowerCase()}-array) instead.`;
@@ -66,14 +66,14 @@ const schema = {
         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',
@@ -82,19 +82,19 @@ const schema = {
         },
         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',
@@ -152,8 +152,8 @@ type PropertySchema = {
   style?: AllowedStyle;
   suffix?: string;
   prefix?: string;
-  forbiddenPattern?: RegExp[];
-  requiredPattern?: RegExp[];
+  forbiddenPatterns?: RegExp[];
+  requiredPatterns?: RegExp[];
   forbiddenPrefixes?: string[];
   forbiddenSuffixes?: string[];
   requiredPrefixes?: string[];
@@ -377,8 +377,8 @@ export const rule: GraphQLESLintRule<RuleOptions> = {
         ignorePattern,
         requiredPrefixes,
         requiredSuffixes,
-        forbiddenPattern,
-        requiredPattern,
+        forbiddenPatterns,
+        requiredPatterns,
       } = normalisePropertyOption(selector);
       const nodeName = node.value;
       const error = getError();
@@ -417,16 +417,16 @@ export const rule: GraphQLESLintRule<RuleOptions> = {
             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: [],
           };
         }

packages/plugin/src/rules/naming-convention/snapshot.md

@@ -409,6 +409,40 @@ exports[`naming-convention > invalid > forbiddenPattern 1`] = `
     1 | query queryFoo { foo } query Bar { bar }
 `;
 
+exports[`naming-convention > invalid > forbiddenPatterns 1`] = `
+#### ⌨️ Code
+
+      1 | query queryFoo { foo } query getBar { bar }
+
+#### ⚙️ Options
+
+    {
+      "OperationDefinition": {
+        "forbiddenPatterns": [
+          "/^(get|query)/"
+        ]
+      }
+    }
+
+#### ❌ Error 1/2
+
+    > 1 | query queryFoo { foo } query getBar { bar }
+        |       ^^^^^^^^ Query "queryFoo" should not contain the forbidden pattern "/^(get|query)/"
+
+#### 💡 Suggestion: Rename to \`Foo\`
+
+    1 | query Foo { foo } query getBar { bar }
+
+#### ❌ Error 2/2
+
+    > 1 | query queryFoo { foo } query getBar { bar }
+        |                              ^^^^^^ Query "getBar" should not contain the forbidden pattern "/^(get|query)/"
+
+#### 💡 Suggestion: Rename to \`Bar\`
+
+    1 | query queryFoo { foo } query Bar { bar }
+`;
+
 exports[`naming-convention > invalid > large graphql file 1`] = `
 #### ⌨️ Code
 
@@ -1995,6 +2029,28 @@ exports[`naming-convention > invalid > requiredPattern 1`] = `
         |             ^^^^^^^ Field "enabled" should contain the required pattern: ^(is|has)
 `;
 
+exports[`naming-convention > invalid > requiredPatterns 1`] = `
+#### ⌨️ Code
+
+      1 | type Test { enabled: Boolean! }
+
+#### ⚙️ Options
+
+    {
+      "FieldDefinition[gqlType.gqlType.name.value=Boolean]": {
+        "style": "camelCase",
+        "requiredPatterns": [
+          "/^(is|has)/"
+        ]
+      }
+    }
+
+#### ❌ Error
+
+    > 1 | type Test { enabled: Boolean! }
+        |             ^^^^^^^ Field "enabled" should contain the required pattern: ^(is|has)
+`;
+
 exports[`naming-convention > invalid > schema-recommended config 1`] = `
 #### ⌨️ Code
 

website/content/rules/naming-convention.mdx

@@ -349,7 +349,7 @@ This element must be one of the following enum values:
 
 ### `suffix` (string)
 
-### `forbiddenPattern` (array)
+### `forbiddenPatterns` (array)
 
 Should be of instance of `RegEx`
 
@@ -362,7 +362,7 @@ Additional restrictions:
 - Minimum items: `1`
 - Unique items: `true`
 
-### `requiredPattern` (array)
+### `requiredPatterns` (array)
 
 Should be of instance of `RegEx`
 
@@ -380,7 +380,7 @@ Additional restrictions:
 > [!WARNING]
 >
 > This option is deprecated and will be removed in the next major release. Use
-> [`forbiddenPattern`](#forbiddenpattern-array) instead.
+> [`forbiddenPatterns`](#forbiddenpatterns-array) instead.
 
 The object is an array with all elements of the type `string`.
 
@@ -394,7 +394,7 @@ Additional restrictions:
 > [!WARNING]
 >
 > This option is deprecated and will be removed in the next major release. Use
-> [`forbiddenPattern`](#forbiddenpattern-array) instead.
+> [`forbiddenPatterns`](#forbiddenpatterns-array) instead.
 
 The object is an array with all elements of the type `string`.
 
@@ -408,7 +408,7 @@ Additional restrictions:
 > [!WARNING]
 >
 > This option is deprecated and will be removed in the next major release. Use
-> [`requiredPattern`](#requiredpattern-array) instead.
+> [`requiredPatterns`](#requiredpatterns-array) instead.
 
 The object is an array with all elements of the type `string`.
 
@@ -422,7 +422,7 @@ Additional restrictions:
 > [!WARNING]
 >
 > This option is deprecated and will be removed in the next major release. Use
-> [`requiredPattern`](#requiredpattern-array) instead.
+> [`requiredPatterns`](#requiredpatterns-array) instead.
 
 The object is an array with all elements of the type `string`.
 

website/content/rules/require-description.mdx

@@ -70,6 +70,27 @@ type User {
 }
 ```
 
+### Correct
+
+```graphql
+# eslint @graphql-eslint/require-description: ['error', { ignoredSelectors: ['[type=ObjectTypeDefinition][name.value=PageInfo]', '[type=ObjectTypeDefinition][name.value=/(Connection|Edge)$/]'] }]
+
+type FriendConnection {
+  edges: [FriendEdge]
+  pageInfo: PageInfo!
+}
+type FriendEdge {
+  cursor: String!
+  node: Friend!
+}
+type PageInfo {
+  hasPreviousPage: Boolean!
+  hasNextPage: Boolean!
+  startCursor: String
+  endCursor: String
+}
+```
+
 ## Config Schema
 
 The schema defines the following properties: