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

package/esm/rules/no-unreachable-types.js

@@ -1,106 +1,109 @@
-import { DirectiveLocation, isInterfaceType, Kind, visit, } from 'graphql';
-import lowerCase from 'lodash.lowercase';
-import { getTypeName, requireGraphQLSchemaFromContext } from '../utils.js';
-const RULE_ID = 'no-unreachable-types';
+import {
+  DirectiveLocation,
+  isInterfaceType,
+  Kind,
+  visit
+} from "graphql";
+import lowerCase from "lodash.lowercase";
+import { getTypeName, requireGraphQLSchemaFromContext } from "../utils.js";
+const RULE_ID = "no-unreachable-types";
 const KINDS = [
-    Kind.DIRECTIVE_DEFINITION,
-    Kind.OBJECT_TYPE_DEFINITION,
-    Kind.OBJECT_TYPE_EXTENSION,
-    Kind.INTERFACE_TYPE_DEFINITION,
-    Kind.INTERFACE_TYPE_EXTENSION,
-    Kind.SCALAR_TYPE_DEFINITION,
-    Kind.SCALAR_TYPE_EXTENSION,
-    Kind.INPUT_OBJECT_TYPE_DEFINITION,
-    Kind.INPUT_OBJECT_TYPE_EXTENSION,
-    Kind.UNION_TYPE_DEFINITION,
-    Kind.UNION_TYPE_EXTENSION,
-    Kind.ENUM_TYPE_DEFINITION,
-    Kind.ENUM_TYPE_EXTENSION,
+  Kind.DIRECTIVE_DEFINITION,
+  Kind.OBJECT_TYPE_DEFINITION,
+  Kind.OBJECT_TYPE_EXTENSION,
+  Kind.INTERFACE_TYPE_DEFINITION,
+  Kind.INTERFACE_TYPE_EXTENSION,
+  Kind.SCALAR_TYPE_DEFINITION,
+  Kind.SCALAR_TYPE_EXTENSION,
+  Kind.INPUT_OBJECT_TYPE_DEFINITION,
+  Kind.INPUT_OBJECT_TYPE_EXTENSION,
+  Kind.UNION_TYPE_DEFINITION,
+  Kind.UNION_TYPE_EXTENSION,
+  Kind.ENUM_TYPE_DEFINITION,
+  Kind.ENUM_TYPE_EXTENSION
 ];
 let reachableTypesCache;
-const RequestDirectiveLocations = new Set([
-    DirectiveLocation.QUERY,
-    DirectiveLocation.MUTATION,
-    DirectiveLocation.SUBSCRIPTION,
-    DirectiveLocation.FIELD,
-    DirectiveLocation.FRAGMENT_DEFINITION,
-    DirectiveLocation.FRAGMENT_SPREAD,
-    DirectiveLocation.INLINE_FRAGMENT,
-    DirectiveLocation.VARIABLE_DEFINITION,
+const RequestDirectiveLocations = /* @__PURE__ */ new Set([
+  DirectiveLocation.QUERY,
+  DirectiveLocation.MUTATION,
+  DirectiveLocation.SUBSCRIPTION,
+  DirectiveLocation.FIELD,
+  DirectiveLocation.FRAGMENT_DEFINITION,
+  DirectiveLocation.FRAGMENT_SPREAD,
+  DirectiveLocation.INLINE_FRAGMENT,
+  DirectiveLocation.VARIABLE_DEFINITION
 ]);
 function getReachableTypes(schema) {
-    // We don't want cache reachableTypes on test environment
-    // Otherwise reachableTypes will be same for all tests
-    if (process.env.NODE_ENV !== 'test' && reachableTypesCache) {
-        return reachableTypesCache;
+  if (process.env.NODE_ENV !== "test" && reachableTypesCache) {
+    return reachableTypesCache;
+  }
+  const reachableTypes = /* @__PURE__ */ new Set();
+  const collect = (node) => {
+    const typeName = getTypeName(node);
+    if (reachableTypes.has(typeName)) {
+      return;
     }
-    const reachableTypes = new Set();
-    const collect = (node) => {
-        const typeName = getTypeName(node);
-        if (reachableTypes.has(typeName)) {
-            return;
-        }
-        reachableTypes.add(typeName);
-        const type = schema.getType(typeName) || schema.getDirective(typeName);
-        if (isInterfaceType(type)) {
-            const { objects, interfaces } = schema.getImplementations(type);
-            for (const { astNode } of [...objects, ...interfaces]) {
-                visit(astNode, visitor);
-            }
-        }
-        else if (type === null || type === void 0 ? void 0 : type.astNode) {
-            // astNode can be undefined for ID, String, Boolean
-            visit(type.astNode, visitor);
-        }
-    };
-    const visitor = {
-        InterfaceTypeDefinition: collect,
-        ObjectTypeDefinition: collect,
-        InputValueDefinition: collect,
-        UnionTypeDefinition: collect,
-        FieldDefinition: collect,
-        Directive: collect,
-        NamedType: collect,
-    };
-    for (const type of [
-        schema,
-        schema.getQueryType(),
-        schema.getMutationType(),
-        schema.getSubscriptionType(),
-    ]) {
-        // if schema don't have Query type, schema.astNode will be undefined
-        if (type === null || type === void 0 ? void 0 : type.astNode) {
-            visit(type.astNode, visitor);
-        }
+    reachableTypes.add(typeName);
+    const type = schema.getType(typeName) || schema.getDirective(typeName);
+    if (isInterfaceType(type)) {
+      const { objects, interfaces } = schema.getImplementations(type);
+      for (const { astNode } of [...objects, ...interfaces]) {
+        visit(astNode, visitor);
+      }
+    } else if (type?.astNode) {
+      visit(type.astNode, visitor);
     }
-    for (const node of schema.getDirectives()) {
-        if (node.locations.some(location => RequestDirectiveLocations.has(location))) {
-            reachableTypes.add(node.name);
-            for (const arg of node.args) {
-                const argTypeName = 'name' in arg.type && arg.type.name;
-                if (argTypeName) {
-                    reachableTypes.add(argTypeName);
-                }
-            }
+  };
+  const visitor = {
+    InterfaceTypeDefinition: collect,
+    ObjectTypeDefinition: collect,
+    InputValueDefinition: collect,
+    UnionTypeDefinition: collect,
+    FieldDefinition: collect,
+    Directive: collect,
+    NamedType: collect
+  };
+  for (const type of [
+    schema,
+    // visiting SchemaDefinition node
+    schema.getQueryType(),
+    schema.getMutationType(),
+    schema.getSubscriptionType()
+  ]) {
+    if (type?.astNode) {
+      visit(type.astNode, visitor);
+    }
+  }
+  for (const node of schema.getDirectives()) {
+    if (node.locations.some((location) => RequestDirectiveLocations.has(location))) {
+      reachableTypes.add(node.name);
+      for (const arg of node.args) {
+        const argTypeName = "name" in arg.type && arg.type.name;
+        if (argTypeName) {
+          reachableTypes.add(argTypeName);
         }
+      }
     }
-    reachableTypesCache = reachableTypes;
-    return reachableTypesCache;
+  }
+  reachableTypesCache = reachableTypes;
+  return reachableTypesCache;
 }
-export const rule = {
-    meta: {
-        messages: {
-            [RULE_ID]: '{{ type }} `{{ typeName }}` is unreachable.',
-        },
-        docs: {
-            description: 'Requires all types to be reachable at some level by root level fields.',
-            category: 'Schema',
-            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
-            requiresSchema: true,
-            examples: [
-                {
-                    title: 'Incorrect',
-                    code: /* GraphQL */ `
+const rule = {
+  meta: {
+    messages: {
+      [RULE_ID]: "{{ type }} `{{ typeName }}` is unreachable."
+    },
+    docs: {
+      description: "Requires all types to be reachable at some level by root level fields.",
+      category: "Schema",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      requiresSchema: true,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
             type User {
               id: ID!
               name: String
@@ -109,11 +112,14 @@ export const rule = {
             type Query {
               me: String
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
             type User {
               id: ID!
               name: String
@@ -122,39 +128,43 @@ export const rule = {
             type Query {
               me: User
             }
-          `,
-                },
-            ],
-            recommended: true,
-        },
-        type: 'suggestion',
-        schema: [],
-        hasSuggestions: true,
+          `
+          )
+        }
+      ],
+      recommended: true
     },
-    create(context) {
-        const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
-        const reachableTypes = getReachableTypes(schema);
-        return {
-            [`:matches(${KINDS}) > .name`](node) {
-                const typeName = node.value;
-                if (!reachableTypes.has(typeName)) {
-                    const type = lowerCase(node.parent.kind.replace(/(Extension|Definition)$/, ''));
-                    context.report({
-                        node,
-                        messageId: RULE_ID,
-                        data: {
-                            type: type[0].toUpperCase() + type.slice(1),
-                            typeName,
-                        },
-                        suggest: [
-                            {
-                                desc: `Remove \`${typeName}\``,
-                                fix: fixer => fixer.remove(node.parent),
-                            },
-                        ],
-                    });
-                }
+    type: "suggestion",
+    schema: [],
+    hasSuggestions: true
+  },
+  create(context) {
+    const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
+    const reachableTypes = getReachableTypes(schema);
+    return {
+      [`:matches(${KINDS}) > .name`](node) {
+        const typeName = node.value;
+        if (!reachableTypes.has(typeName)) {
+          const type = lowerCase(node.parent.kind.replace(/(Extension|Definition)$/, ""));
+          context.report({
+            node,
+            messageId: RULE_ID,
+            data: {
+              type: type[0].toUpperCase() + type.slice(1),
+              typeName
             },
-        };
-    },
+            suggest: [
+              {
+                desc: `Remove \`${typeName}\``,
+                fix: (fixer) => fixer.remove(node.parent)
+              }
+            ]
+          });
+        }
+      }
+    };
+  }
+};
+export {
+  rule
 };

package/esm/rules/no-unused-fields.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/no-unused-fields.js

@@ -1,52 +1,50 @@
-import { TypeInfo, visit, visitWithTypeInfo } from 'graphql';
-import { requireGraphQLSchemaFromContext, requireSiblingsOperations } from '../utils.js';
-const RULE_ID = 'no-unused-fields';
+import { TypeInfo, visit, visitWithTypeInfo } from "graphql";
+import { requireGraphQLSchemaFromContext, requireSiblingsOperations } from "../utils.js";
+const RULE_ID = "no-unused-fields";
 let usedFieldsCache;
 function getUsedFields(schema, operations) {
-    // We don't want cache usedFields on test environment
-    // Otherwise usedFields will be same for all tests
-    if (process.env.NODE_ENV !== 'test' && usedFieldsCache) {
-        return usedFieldsCache;
-    }
-    const usedFields = Object.create(null);
-    const typeInfo = new TypeInfo(schema);
-    const visitor = visitWithTypeInfo(typeInfo, {
-        Field(node) {
-            var _a;
-            const fieldDef = typeInfo.getFieldDef();
-            if (!fieldDef) {
-                // skip visiting this node if field is not defined in schema
-                return false;
-            }
-            const parentTypeName = typeInfo.getParentType().name;
-            const fieldName = node.name.value;
-            (_a = usedFields[parentTypeName]) !== null && _a !== void 0 ? _a : (usedFields[parentTypeName] = new Set());
-            usedFields[parentTypeName].add(fieldName);
-        },
-    });
-    const allDocuments = [...operations.getOperations(), ...operations.getFragments()];
-    for (const { document } of allDocuments) {
-        visit(document, visitor);
-    }
-    usedFieldsCache = usedFields;
+  if (process.env.NODE_ENV !== "test" && usedFieldsCache) {
     return usedFieldsCache;
+  }
+  const usedFields = /* @__PURE__ */ Object.create(null);
+  const typeInfo = new TypeInfo(schema);
+  const visitor = visitWithTypeInfo(typeInfo, {
+    Field(node) {
+      const fieldDef = typeInfo.getFieldDef();
+      if (!fieldDef) {
+        return false;
+      }
+      const parentTypeName = typeInfo.getParentType().name;
+      const fieldName = node.name.value;
+      usedFields[parentTypeName] ??= /* @__PURE__ */ new Set();
+      usedFields[parentTypeName].add(fieldName);
+    }
+  });
+  const allDocuments = [...operations.getOperations(), ...operations.getFragments()];
+  for (const { document } of allDocuments) {
+    visit(document, visitor);
+  }
+  usedFieldsCache = usedFields;
+  return usedFieldsCache;
 }
-export const rule = {
-    meta: {
-        messages: {
-            [RULE_ID]: 'Field "{{fieldName}}" is unused',
-        },
-        docs: {
-            description: 'Requires all fields to be used at some level by siblings operations.',
-            category: 'Schema',
-            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
-            requiresSiblings: true,
-            requiresSchema: true,
-            isDisabledForAllConfig: true,
-            examples: [
-                {
-                    title: 'Incorrect',
-                    code: /* GraphQL */ `
+const rule = {
+  meta: {
+    messages: {
+      [RULE_ID]: 'Field "{{fieldName}}" is unused'
+    },
+    docs: {
+      description: "Requires all fields to be used at some level by siblings operations.",
+      category: "Schema",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      requiresSiblings: true,
+      requiresSchema: true,
+      isDisabledForAllConfig: true,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
             type User {
               id: ID!
               name: String
@@ -63,11 +61,14 @@ export const rule = {
                 name
               }
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
             type User {
               id: ID!
               name: String
@@ -83,45 +84,48 @@ export const rule = {
                 name
               }
             }
-          `,
-                },
-            ],
-        },
-        type: 'suggestion',
-        schema: [],
-        hasSuggestions: true,
-    },
-    create(context) {
-        const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
-        const siblingsOperations = requireSiblingsOperations(RULE_ID, context);
-        const usedFields = getUsedFields(schema, siblingsOperations);
-        return {
-            FieldDefinition(node) {
-                var _a;
-                const fieldName = node.name.value;
-                const parentTypeName = node.parent.name.value;
-                const isUsed = (_a = usedFields[parentTypeName]) === null || _a === void 0 ? void 0 : _a.has(fieldName);
-                if (isUsed) {
-                    return;
-                }
-                context.report({
-                    node: node.name,
-                    messageId: RULE_ID,
-                    data: { fieldName },
-                    suggest: [
-                        {
-                            desc: `Remove \`${fieldName}\` field`,
-                            fix(fixer) {
-                                const sourceCode = context.getSourceCode();
-                                const tokenBefore = sourceCode.getTokenBefore(node);
-                                const tokenAfter = sourceCode.getTokenAfter(node);
-                                const isEmptyType = tokenBefore.type === '{' && tokenAfter.type === '}';
-                                return fixer.remove((isEmptyType ? node.parent : node));
-                            },
-                        },
-                    ],
-                });
-            },
-        };
+          `
+          )
+        }
+      ]
     },
+    type: "suggestion",
+    schema: [],
+    hasSuggestions: true
+  },
+  create(context) {
+    const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
+    const siblingsOperations = requireSiblingsOperations(RULE_ID, context);
+    const usedFields = getUsedFields(schema, siblingsOperations);
+    return {
+      FieldDefinition(node) {
+        const fieldName = node.name.value;
+        const parentTypeName = node.parent.name.value;
+        const isUsed = usedFields[parentTypeName]?.has(fieldName);
+        if (isUsed) {
+          return;
+        }
+        context.report({
+          node: node.name,
+          messageId: RULE_ID,
+          data: { fieldName },
+          suggest: [
+            {
+              desc: `Remove \`${fieldName}\` field`,
+              fix(fixer) {
+                const sourceCode = context.getSourceCode();
+                const tokenBefore = sourceCode.getTokenBefore(node);
+                const tokenAfter = sourceCode.getTokenAfter(node);
+                const isEmptyType = tokenBefore.type === "{" && tokenAfter.type === "}";
+                return fixer.remove(isEmptyType ? node.parent : node);
+              }
+            }
+          ]
+        });
+      }
+    };
+  }
+};
+export {
+  rule
 };

package/{typings/rules/relay-arguments.d.cts → esm/rules/relay-arguments.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 type: "array";
     readonly maxItems: 1;
@@ -16,6 +23,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 };