more

Author: dimaMachina

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

@@ -2,7 +2,13 @@ import { ASTKindToNode, Kind, TokenKind } from 'graphql';
 import { getRootTypeNames } from '@graphql-tools/utils';
 import { GraphQLESTreeNode } from '../../estree-converter/index.js';
 import { GraphQLESLintRule, ValueOf } from '../../types.js';
-import { getLocation, getNodeName, requireGraphQLSchema, TYPES_KINDS } from '../../utils.js';
+import {
+  ARRAY_DEFAULT_OPTIONS, eslintSelectorsTip,
+  getLocation,
+  getNodeName,
+  requireGraphQLSchema,
+  TYPES_KINDS
+} from "../../utils.js";
 
 export const RULE_ID = 'require-description';
 
@@ -30,18 +36,25 @@ const schema = {
     properties: {
       types: {
         type: 'boolean',
+        enum: [true],
         description: `Includes:\n${TYPES_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
       },
       rootField: {
         type: 'boolean',
+        enum: [true],
         description: 'Definitions within `Query`, `Mutation`, and `Subscription` root types.',
       },
+      ignoredSelectors: {
+        ...ARRAY_DEFAULT_OPTIONS,
+        description: ['Ignore specific selectors', eslintSelectorsTip].join('\n')
+      },
       ...Object.fromEntries(
         [...ALLOWED_KINDS].sort().map(kind => {
-          let description = `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${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 +=
-              '\n> You must use only comment syntax `#` and not description syntax `"""` or `"`.';
+            description += ['','','> [!WARNING]', '>', '> You must use only comment syntax `#` and not description syntax `"""` or `"`.'].join('\n')
           }
           return [kind, { type: 'boolean', description }];
         }),
@@ -55,8 +68,9 @@ export type RuleOptions = [
   {
     [key in AllowedKind]?: boolean;
   } & {
-    types?: boolean;
-    rootField?: boolean;
+    types?: true;
+    rootField?: true;
+    ignoredSelectors?: string[];
   },
 ];
 
@@ -132,7 +146,7 @@ export const rule: GraphQLESLintRule<RuleOptions> = {
     schema,
   },
   create(context) {
-    const { types, rootField, ...restOptions } = context.options[0] || {};
+    let { types, rootField, ignoredSelectors = [], ...restOptions } = context.options[0] || {};
 
     const kinds = new Set<string>(types ? TYPES_KINDS : []);
     for (const [kind, isEnabled] of Object.entries(restOptions)) {
@@ -152,13 +166,10 @@ export const rule: GraphQLESLintRule<RuleOptions> = {
         ].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})`
     }
-
-    const selector = [...kinds].join(',');
-
     return {
       [selector](node: SelectorNode) {
         let description = '';

website/content/rules/no-unused-fields.mdx

@@ -145,6 +145,8 @@ in the schema:
 ]
 ```
 
+> [!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

website/content/rules/require-description.mdx

@@ -74,7 +74,7 @@ type User {
 
 The schema defines the following properties:
 
-### `types` (boolean)
+### `types` (boolean, enum)
 
 Includes:
 
@@ -85,10 +85,36 @@ Includes:
 - `InputObjectTypeDefinition`
 - `UnionTypeDefinition`
 
-### `rootField` (boolean)
+This element must be one of the following enum values:
+
+- `true`
+
+### `rootField` (boolean, enum)
 
 Definitions within `Query`, `Mutation`, and `Subscription` root types.
 
+This element must be one of the following enum values:
+
+- `true`
+
+### `ignoredSelectors` (array)
+
+Ignore specific selectors
+
+> [!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.
+
+The object is an array with all elements of the type `string`.
+
+Additional restrictions:
+
+- Minimum items: `1`
+- Unique items: `true`
+
 ### `DirectiveDefinition` (boolean)
 
 > [!NOTE]
@@ -147,9 +173,13 @@ Definitions within `Query`, `Mutation`, and `Subscription` root types.
 
 ### `OperationDefinition` (boolean)
 
-Read more about this kind on
-[spec.graphql.org](https://spec.graphql.org/October2021/#OperationDefinition).
+> [!NOTE]
+>
+> Read more about this kind on
+> [spec.graphql.org](https://spec.graphql.org/October2021/#OperationDefinition).
 
+> [!WARNING]
+>
 > You must use only comment syntax `#` and not description syntax `"""` or `"`.
 
 ### `ScalarTypeDefinition` (boolean)