@graphql-eslint/eslint-plugin 3.19.3 → 3.20.0-alpha-20230703154330-0d51273

package/esm/rules/require-description.js

@@ -1,63 +1,75 @@
-import { getRootTypeNames } from '@graphql-tools/utils';
-import { Kind, TokenKind } from 'graphql';
-import { getLocation, getNodeName, requireGraphQLSchemaFromContext, TYPES_KINDS, } from '../utils.js';
-export const RULE_ID = 'require-description';
+import { getRootTypeNames } from "@graphql-tools/utils";
+import { Kind, TokenKind } from "graphql";
+import {
+  getLocation,
+  getNodeName,
+  requireGraphQLSchemaFromContext,
+  TYPES_KINDS
+} from "../utils.js";
+const RULE_ID = "require-description";
 const ALLOWED_KINDS = [
-    ...TYPES_KINDS,
-    Kind.DIRECTIVE_DEFINITION,
-    Kind.FIELD_DEFINITION,
-    Kind.INPUT_VALUE_DEFINITION,
-    Kind.ENUM_VALUE_DEFINITION,
-    Kind.OPERATION_DEFINITION,
+  ...TYPES_KINDS,
+  Kind.DIRECTIVE_DEFINITION,
+  Kind.FIELD_DEFINITION,
+  Kind.INPUT_VALUE_DEFINITION,
+  Kind.ENUM_VALUE_DEFINITION,
+  Kind.OPERATION_DEFINITION
 ];
 const schema = {
-    type: 'array',
-    minItems: 1,
-    maxItems: 1,
-    items: {
-        type: 'object',
-        additionalProperties: false,
-        minProperties: 1,
-        properties: {
-            types: {
-                type: 'boolean',
-                description: `Includes:\n${TYPES_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
-            },
-            rootField: {
-                type: 'boolean',
-                description: 'Definitions within `Query`, `Mutation`, and `Subscription` root types.',
-            },
-            ...Object.fromEntries([...ALLOWED_KINDS].sort().map(kind => {
-                let description = `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 `"`.';
-                }
-                return [kind, { type: 'boolean', description }];
-            })),
-        },
-    },
+  type: "array",
+  minItems: 1,
+  maxItems: 1,
+  items: {
+    type: "object",
+    additionalProperties: false,
+    minProperties: 1,
+    properties: {
+      types: {
+        type: "boolean",
+        description: `Includes:
+${TYPES_KINDS.map((kind) => `- \`${kind}\``).join("\n")}`
+      },
+      rootField: {
+        type: "boolean",
+        description: "Definitions within `Query`, `Mutation`, and `Subscription` root types."
+      },
+      ...Object.fromEntries(
+        [...ALLOWED_KINDS].sort().map((kind) => {
+          let description = `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 `"`.';
+          }
+          return [kind, { type: "boolean", description }];
+        })
+      )
+    }
+  }
 };
-export const rule = {
-    meta: {
-        docs: {
-            category: 'Schema',
-            description: 'Enforce descriptions in type definitions and operations.',
-            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
-            examples: [
-                {
-                    title: 'Incorrect',
-                    usage: [{ types: true, FieldDefinition: true }],
-                    code: /* GraphQL */ `
+const rule = {
+  meta: {
+    docs: {
+      category: "Schema",
+      description: "Enforce descriptions in type definitions and operations.",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      examples: [
+        {
+          title: "Incorrect",
+          usage: [{ types: true, FieldDefinition: true }],
+          code: (
+            /* GraphQL */
+            `
             type someTypeName {
               name: String
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    usage: [{ types: true, FieldDefinition: true }],
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ types: true, FieldDefinition: true }],
+          code: (
+            /* GraphQL */
+            `
             """
             Some type description
             """
@@ -67,22 +79,28 @@ export const rule = {
               """
               name: String
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    usage: [{ OperationDefinition: true }],
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ OperationDefinition: true }],
+          code: (
+            /* GraphQL */
+            `
             # Create a new user
             mutation createUser {
               # ...
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    usage: [{ rootField: true }],
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ rootField: true }],
+          code: (
+            /* GraphQL */
+            `
             type Mutation {
               "Create a new user"
               createUser: User
@@ -91,73 +109,76 @@ export const rule = {
             type User {
               name: String
             }
-          `,
-                },
-            ],
-            configOptions: [
-                {
-                    types: true,
-                    [Kind.DIRECTIVE_DEFINITION]: true,
-                    // rootField: true TODO enable in graphql-eslint v4
-                },
-            ],
-            recommended: true,
-        },
-        type: 'suggestion',
-        messages: {
-            [RULE_ID]: 'Description is required for {{ nodeName }}',
-        },
-        schema,
+          `
+          )
+        }
+      ],
+      configOptions: [
+        {
+          types: true,
+          [Kind.DIRECTIVE_DEFINITION]: true
+          // rootField: true TODO enable in graphql-eslint v4
+        }
+      ],
+      recommended: true
     },
-    create(context) {
-        const { types, rootField, ...restOptions } = context.options[0] || {};
-        const kinds = new Set(types ? TYPES_KINDS : []);
-        for (const [kind, isEnabled] of Object.entries(restOptions)) {
-            if (isEnabled) {
-                kinds.add(kind);
-            }
-            else {
-                kinds.delete(kind);
+    type: "suggestion",
+    messages: {
+      [RULE_ID]: "Description is required for {{ nodeName }}"
+    },
+    schema
+  },
+  create(context) {
+    const { types, rootField, ...restOptions } = context.options[0] || {};
+    const kinds = new Set(types ? TYPES_KINDS : []);
+    for (const [kind, isEnabled] of Object.entries(restOptions)) {
+      if (isEnabled) {
+        kinds.add(kind);
+      } else {
+        kinds.delete(kind);
+      }
+    }
+    if (rootField) {
+      const schema2 = requireGraphQLSchemaFromContext(RULE_ID, context);
+      const rootTypeNames = getRootTypeNames(schema2);
+      kinds.add(
+        `:matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=/^(${[
+          ...rootTypeNames
+        ].join(",")})$/] > FieldDefinition`
+      );
+    }
+    const selector = [...kinds].join(",");
+    return {
+      [selector](node) {
+        let description = "";
+        const isOperation = node.kind === Kind.OPERATION_DEFINITION;
+        if (isOperation) {
+          const rawNode = node.rawNode();
+          const { prev, line } = rawNode.loc.startToken;
+          if (prev?.kind === TokenKind.COMMENT) {
+            const value = prev.value.trim();
+            const linesBefore = line - prev.line;
+            if (!value.startsWith("eslint") && linesBefore === 1) {
+              description = value;
             }
+          }
+        } else {
+          description = node.description?.value.trim() || "";
         }
-        if (rootField) {
-            const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
-            const rootTypeNames = getRootTypeNames(schema);
-            kinds.add(`:matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=/^(${[
-                ...rootTypeNames,
-            ].join(',')})$/] > FieldDefinition`);
+        if (description.length === 0) {
+          context.report({
+            loc: isOperation ? getLocation(node.loc.start, node.operation) : node.name.loc,
+            messageId: RULE_ID,
+            data: {
+              nodeName: getNodeName(node)
+            }
+          });
         }
-        const selector = [...kinds].join(',');
-        return {
-            [selector](node) {
-                var _a;
-                let description = '';
-                const isOperation = node.kind === Kind.OPERATION_DEFINITION;
-                if (isOperation) {
-                    const rawNode = node.rawNode();
-                    const { prev, line } = rawNode.loc.startToken;
-                    if ((prev === null || prev === void 0 ? void 0 : prev.kind) === TokenKind.COMMENT) {
-                        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion -- TODO: remove `!` when drop support of graphql@15
-                        const value = prev.value.trim();
-                        const linesBefore = line - prev.line;
-                        if (!value.startsWith('eslint') && linesBefore === 1) {
-                            description = value;
-                        }
-                    }
-                }
-                else {
-                    description = ((_a = node.description) === null || _a === void 0 ? void 0 : _a.value.trim()) || '';
-                }
-                if (description.length === 0) {
-                    context.report({
-                        loc: isOperation ? getLocation(node.loc.start, node.operation) : node.name.loc,
-                        messageId: RULE_ID,
-                        data: {
-                            nodeName: getNodeName(node),
-                        },
-                    });
-                }
-            },
-        };
-    },
+      }
+    };
+  }
+};
+export {
+  RULE_ID,
+  rule
 };

package/esm/rules/require-field-of-type-query-in-mutation-result.d.mts

@@ -0,0 +1,12 @@
+import { i as GraphQLESLintRule } from '../types-2e1afd7c.js';
+import '@graphql-tools/utils';
+import 'eslint';
+import 'estree';
+import 'graphql';
+import 'graphql-config';
+import 'json-schema-to-ts';
+import '../estree-converter/types.mjs';
+
+declare const rule: GraphQLESLintRule;
+
+export { rule };

package/esm/rules/require-field-of-type-query-in-mutation-result.js

@@ -1,28 +1,33 @@
-import { isObjectType } from 'graphql';
-import { getTypeName, requireGraphQLSchemaFromContext } from '../utils.js';
-const RULE_ID = 'require-field-of-type-query-in-mutation-result';
-export const rule = {
-    meta: {
-        type: 'suggestion',
-        docs: {
-            category: 'Schema',
-            description: 'Allow the client in one round-trip not only to call mutation but also to get a wagon of data to update their application.\n> Currently, no errors are reported for result type `union`, `interface` and `scalar`.',
-            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
-            requiresSchema: true,
-            examples: [
-                {
-                    title: 'Incorrect',
-                    code: /* GraphQL */ `
+import { isObjectType } from "graphql";
+import { getTypeName, requireGraphQLSchemaFromContext } from "../utils.js";
+const RULE_ID = "require-field-of-type-query-in-mutation-result";
+const rule = {
+  meta: {
+    type: "suggestion",
+    docs: {
+      category: "Schema",
+      description: "Allow the client in one round-trip not only to call mutation but also to get a wagon of data to update their application.\n> Currently, no errors are reported for result type `union`, `interface` and `scalar`.",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      requiresSchema: true,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
             type User { ... }
 
             type Mutation {
               createUser: User!
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
             type User { ... }
 
             type Query { ... }
@@ -35,35 +40,39 @@ export const rule = {
             type Mutation {
               createUser: CreateUserPayload!
             }
-          `,
-                },
-            ],
-        },
-        schema: [],
-    },
-    create(context) {
-        const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
-        const mutationType = schema.getMutationType();
-        const queryType = schema.getQueryType();
-        if (!mutationType || !queryType) {
-            return {};
+          `
+          )
         }
-        const selector = `:matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=${mutationType.name}] > FieldDefinition > .gqlType Name`;
-        return {
-            [selector](node) {
-                const typeName = node.value;
-                const graphQLType = schema.getType(typeName);
-                if (isObjectType(graphQLType)) {
-                    const { fields } = graphQLType.astNode;
-                    const hasQueryType = fields === null || fields === void 0 ? void 0 : fields.some(field => getTypeName(field) === queryType.name);
-                    if (!hasQueryType) {
-                        context.report({
-                            node,
-                            message: `Mutation result type "${graphQLType.name}" must contain field of type "${queryType.name}"`,
-                        });
-                    }
-                }
-            },
-        };
+      ]
     },
+    schema: []
+  },
+  create(context) {
+    const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
+    const mutationType = schema.getMutationType();
+    const queryType = schema.getQueryType();
+    if (!mutationType || !queryType) {
+      return {};
+    }
+    const selector = `:matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=${mutationType.name}] > FieldDefinition > .gqlType Name`;
+    return {
+      [selector](node) {
+        const typeName = node.value;
+        const graphQLType = schema.getType(typeName);
+        if (isObjectType(graphQLType)) {
+          const { fields } = graphQLType.astNode;
+          const hasQueryType = fields?.some((field) => getTypeName(field) === queryType.name);
+          if (!hasQueryType) {
+            context.report({
+              node,
+              message: `Mutation result type "${graphQLType.name}" must contain field of type "${queryType.name}"`
+            });
+          }
+        }
+      }
+    };
+  }
+};
+export {
+  rule
 };

package/{typings/rules/require-id-when-available.d.cts → esm/rules/require-id-when-available.d.mts}

@@ -1,5 +1,12 @@
 import { FromSchema } from 'json-schema-to-ts';
-import { GraphQLESLintRule } from '../types.cjs';
+import { i as GraphQLESLintRule } from '../types-2e1afd7c.js';
+import '@graphql-tools/utils';
+import 'eslint';
+import 'estree';
+import 'graphql';
+import 'graphql-config';
+import '../estree-converter/types.mjs';
+
 declare const schema: {
     readonly definitions: {
         readonly asString: {
@@ -31,6 +38,7 @@ declare const schema: {
         };
     };
 };
-export type RuleOptions = FromSchema<typeof schema>;
-export declare const rule: GraphQLESLintRule<RuleOptions, true>;
-export {};
+type RuleOptions = FromSchema<typeof schema>;
+declare const rule: GraphQLESLintRule<RuleOptions, true>;
+
+export { RuleOptions, rule };