more

Author: dimaMachina

.changeset/long-chicken-press.md

@@ -0,0 +1,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`

packages/plugin/src/rules/no-unused-fields/index.ts

@@ -4,7 +4,7 @@ import { FromSchema } from 'json-schema-to-ts';
 import { ModuleCache } from '../../cache.js';
 import { SiblingOperations } from '../../siblings.js';
 import { GraphQLESLintRule, GraphQLESTreeNode } from '../../types.js';
-import { eslintSelectorsTip, requireGraphQLOperations, requireGraphQLSchema } from "../../utils.js";
+import { eslintSelectorsTip, requireGraphQLOperations, requireGraphQLSchema } from '../../utils.js';
 
 const RULE_ID = 'no-unused-fields';
 
@@ -89,7 +89,7 @@ const schema = {
           '```json',
           JSON.stringify(RELAY_DEFAULT_IGNORED_FIELD_SELECTORS, null, 2),
           '```',
-          eslintSelectorsTip
+          eslintSelectorsTip,
         ].join('\n'),
         items: {
           type: 'string',

packages/plugin/src/rules/require-description/index.test.ts

@@ -229,14 +229,16 @@ ruleTester.run<RuleOptions>('require-description', rule, {
       errors: [{ messageId: RULE_ID }],
     },
     {
-      only: true,
       name: 'ignoredSelectors',
-      options: [{ types: true,
-       ignoredSelectors: [
-         '[type=ObjectTypeDefinition][name.value=PageInfo]',
-         '[type=ObjectTypeDefinition][name.value=/(Connection|Edge)$/]',
-       ]
-      }],
+      options: [
+        {
+          types: true,
+          ignoredSelectors: [
+            '[type=ObjectTypeDefinition][name.value=PageInfo]',
+            '[type=ObjectTypeDefinition][name.value=/(Connection|Edge)$/]',
+          ],
+        },
+      ],
       code: /* GraphQL */ `
         type Query {
           user: User
@@ -266,7 +268,7 @@ ruleTester.run<RuleOptions>('require-description', rule, {
         }
       `,
       errors: 3,
-    }
+    },
   ],
 });
 

packages/plugin/src/rules/require-description/index.ts

@@ -3,12 +3,13 @@ import { getRootTypeNames } from '@graphql-tools/utils';
 import { GraphQLESTreeNode } from '../../estree-converter/index.js';
 import { GraphQLESLintRule, ValueOf } from '../../types.js';
 import {
-  ARRAY_DEFAULT_OPTIONS, eslintSelectorsTip,
+  ARRAY_DEFAULT_OPTIONS,
+  eslintSelectorsTip,
   getLocation,
   getNodeName,
   requireGraphQLSchema,
-  TYPES_KINDS
-} from "../../utils.js";
+  TYPES_KINDS,
+} from '../../utils.js';
 
 export const RULE_ID = 'require-description';
 
@@ -46,15 +47,21 @@ const schema = {
       },
       ignoredSelectors: {
         ...ARRAY_DEFAULT_OPTIONS,
-        description: ['Ignore specific selectors', eslintSelectorsTip].join('\n')
+        description: ['Ignore specific selectors', eslintSelectorsTip].join('\n'),
       },
       ...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')
+            description += [
+              '',
+              '',
+              '> [!WARNING]',
+              '>',
+              '> You must use only comment syntax `#` and not description syntax `"""` or `"`.',
+            ].join('\n');
           }
           return [kind, { type: 'boolean', description }];
         }),
@@ -129,6 +136,33 @@ export const rule: GraphQLESLintRule<RuleOptions> = {
             }
           `,
         },
+        {
+          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: [
         {
@@ -168,7 +202,7 @@ export const rule: GraphQLESLintRule<RuleOptions> = {
     }
     let selector = `:matches(${[...kinds]})`;
     for (const str of ignoredSelectors) {
-      selector += `:not(${str})`
+      selector += `:not(${str})`;
     }
     return {
       [selector](node: SelectorNode) {

packages/plugin/src/utils.ts

@@ -204,4 +204,4 @@ export function getNodeName(node: GraphQLESTreeNode<ASTNode>): string {
 export 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.`
+> Paste or drop code into the editor in [ASTExplorer](https://astexplorer.net) and inspect the generated AST to compose your selector.`;

packages/rule-tester/src/index.ts

@@ -26,8 +26,8 @@ function applyFix(code: string, { range, text }: Rule.Fix): string {
 }
 
 // @ts-expect-error -- Extend RegExp with a custom toJSON method
-RegExp.prototype.toJSON = function() {
-  return `/${this.source}/${this.flags}`
+RegExp.prototype.toJSON = function () {
+  return `/${this.source}/${this.flags}`;
 };
 
 export class RuleTester<ParserOptions> extends ESLintRuleTester {