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

package/esm/rules/no-root-type.js

@@ -1,83 +1,89 @@
-import { ARRAY_DEFAULT_OPTIONS, requireGraphQLSchemaFromContext, truthy } from '../utils.js';
+import { ARRAY_DEFAULT_OPTIONS, requireGraphQLSchemaFromContext, truthy } from "../utils.js";
 const schema = {
-    type: 'array',
-    minItems: 1,
-    maxItems: 1,
-    items: {
-        type: 'object',
-        additionalProperties: false,
-        required: ['disallow'],
-        properties: {
-            disallow: {
-                ...ARRAY_DEFAULT_OPTIONS,
-                items: {
-                    enum: ['mutation', 'subscription'],
-                },
-            },
-        },
-    },
+  type: "array",
+  minItems: 1,
+  maxItems: 1,
+  items: {
+    type: "object",
+    additionalProperties: false,
+    required: ["disallow"],
+    properties: {
+      disallow: {
+        ...ARRAY_DEFAULT_OPTIONS,
+        items: {
+          enum: ["mutation", "subscription"]
+        }
+      }
+    }
+  }
 };
-export const rule = {
-    meta: {
-        type: 'suggestion',
-        hasSuggestions: true,
-        docs: {
-            category: 'Schema',
-            description: 'Disallow using root types `mutation` and/or `subscription`.',
-            url: 'https://the-guild.dev/graphql/eslint/rules/no-root-type',
-            requiresSchema: true,
-            isDisabledForAllConfig: true,
-            examples: [
-                {
-                    title: 'Incorrect',
-                    usage: [{ disallow: ['mutation', 'subscription'] }],
-                    code: /* GraphQL */ `
+const rule = {
+  meta: {
+    type: "suggestion",
+    hasSuggestions: true,
+    docs: {
+      category: "Schema",
+      description: "Disallow using root types `mutation` and/or `subscription`.",
+      url: "https://the-guild.dev/graphql/eslint/rules/no-root-type",
+      requiresSchema: true,
+      isDisabledForAllConfig: true,
+      examples: [
+        {
+          title: "Incorrect",
+          usage: [{ disallow: ["mutation", "subscription"] }],
+          code: (
+            /* GraphQL */
+            `
             type Mutation {
               createUser(input: CreateUserInput!): User!
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    usage: [{ disallow: ['mutation', 'subscription'] }],
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ disallow: ["mutation", "subscription"] }],
+          code: (
+            /* GraphQL */
+            `
             type Query {
               users: [User!]!
             }
-          `,
-                },
-            ],
-        },
-        schema,
-    },
-    create(context) {
-        const schema = requireGraphQLSchemaFromContext('no-root-type', context);
-        const disallow = new Set(context.options[0].disallow);
-        const rootTypeNames = [
-            disallow.has('mutation') && schema.getMutationType(),
-            disallow.has('subscription') && schema.getSubscriptionType(),
-        ]
-            .filter(truthy)
-            .map(type => type.name)
-            .join('|');
-        if (!rootTypeNames) {
-            return {};
+          `
+          )
         }
-        const selector = `:matches(ObjectTypeDefinition, ObjectTypeExtension) > .name[value=/^(${rootTypeNames})$/]`;
-        return {
-            [selector](node) {
-                const typeName = node.value;
-                context.report({
-                    node,
-                    message: `Root type \`${typeName}\` is forbidden.`,
-                    suggest: [
-                        {
-                            desc: `Remove \`${typeName}\` type`,
-                            fix: fixer => fixer.remove(node.parent),
-                        },
-                    ],
-                });
-            },
-        };
+      ]
     },
+    schema
+  },
+  create(context) {
+    const schema2 = requireGraphQLSchemaFromContext("no-root-type", context);
+    const disallow = new Set(context.options[0].disallow);
+    const rootTypeNames = [
+      disallow.has("mutation") && schema2.getMutationType(),
+      disallow.has("subscription") && schema2.getSubscriptionType()
+    ].filter(truthy).map((type) => type.name).join("|");
+    if (!rootTypeNames) {
+      return {};
+    }
+    const selector = `:matches(ObjectTypeDefinition, ObjectTypeExtension) > .name[value=/^(${rootTypeNames})$/]`;
+    return {
+      [selector](node) {
+        const typeName = node.value;
+        context.report({
+          node,
+          message: `Root type \`${typeName}\` is forbidden.`,
+          suggest: [
+            {
+              desc: `Remove \`${typeName}\` type`,
+              fix: (fixer) => fixer.remove(node.parent)
+            }
+          ]
+        });
+      }
+    };
+  }
+};
+export {
+  rule
 };

package/esm/rules/no-scalar-result-type-on-mutation.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-scalar-result-type-on-mutation.js

@@ -1,67 +1,76 @@
-import { isScalarType, Kind } from 'graphql';
-import { getNodeName, requireGraphQLSchemaFromContext } from '../utils.js';
-const RULE_ID = 'no-scalar-result-type-on-mutation';
-export const rule = {
-    meta: {
-        type: 'suggestion',
-        hasSuggestions: true,
-        docs: {
-            category: 'Schema',
-            description: 'Avoid scalar result type on mutation type to make sure to return a valid state.',
-            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
-            requiresSchema: true,
-            examples: [
-                {
-                    title: 'Incorrect',
-                    code: /* GraphQL */ `
+import { isScalarType, Kind } from "graphql";
+import { getNodeName, requireGraphQLSchemaFromContext } from "../utils.js";
+const RULE_ID = "no-scalar-result-type-on-mutation";
+const rule = {
+  meta: {
+    type: "suggestion",
+    hasSuggestions: true,
+    docs: {
+      category: "Schema",
+      description: "Avoid scalar result type on mutation type to make sure to return a valid state.",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      requiresSchema: true,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
             type Mutation {
               createUser: Boolean
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
             type Mutation {
               createUser: User!
             }
-          `,
-                },
-            ],
-        },
-        schema: [],
-    },
-    create(context) {
-        const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
-        const mutationType = schema.getMutationType();
-        if (!mutationType) {
-            return {};
+          `
+          )
         }
-        const selector = [
-            `:matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=${mutationType.name}]`,
-            '> FieldDefinition > .gqlType Name',
-        ].join(' ');
-        return {
-            [selector](node) {
-                const typeName = node.value;
-                const graphQLType = schema.getType(typeName);
-                if (isScalarType(graphQLType)) {
-                    let fieldDef = node.parent;
-                    while (fieldDef.kind !== Kind.FIELD_DEFINITION) {
-                        fieldDef = fieldDef.parent;
-                    }
-                    context.report({
-                        node,
-                        message: `Unexpected scalar result type \`${typeName}\` for ${getNodeName(fieldDef)}`,
-                        suggest: [
-                            {
-                                desc: `Remove \`${typeName}\``,
-                                fix: fixer => fixer.remove(node),
-                            },
-                        ],
-                    });
-                }
-            },
-        };
+      ]
     },
+    schema: []
+  },
+  create(context) {
+    const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
+    const mutationType = schema.getMutationType();
+    if (!mutationType) {
+      return {};
+    }
+    const selector = [
+      `:matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=${mutationType.name}]`,
+      "> FieldDefinition > .gqlType Name"
+    ].join(" ");
+    return {
+      [selector](node) {
+        const typeName = node.value;
+        const graphQLType = schema.getType(typeName);
+        if (isScalarType(graphQLType)) {
+          let fieldDef = node.parent;
+          while (fieldDef.kind !== Kind.FIELD_DEFINITION) {
+            fieldDef = fieldDef.parent;
+          }
+          context.report({
+            node,
+            message: `Unexpected scalar result type \`${typeName}\` for ${getNodeName(fieldDef)}`,
+            suggest: [
+              {
+                desc: `Remove \`${typeName}\``,
+                fix: (fixer) => fixer.remove(node)
+              }
+            ]
+          });
+        }
+      }
+    };
+  }
+};
+export {
+  rule
 };

package/esm/rules/no-typename-prefix.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-typename-prefix.js

@@ -1,62 +1,74 @@
-const NO_TYPENAME_PREFIX = 'NO_TYPENAME_PREFIX';
-export const rule = {
-    meta: {
-        type: 'suggestion',
-        hasSuggestions: true,
-        docs: {
-            category: 'Schema',
-            description: 'Enforces users to avoid using the type name in a field name while defining your schema.',
-            recommended: true,
-            url: 'https://the-guild.dev/graphql/eslint/rules/no-typename-prefix',
-            examples: [
-                {
-                    title: 'Incorrect',
-                    code: /* GraphQL */ `
+const NO_TYPENAME_PREFIX = "NO_TYPENAME_PREFIX";
+const rule = {
+  meta: {
+    type: "suggestion",
+    hasSuggestions: true,
+    docs: {
+      category: "Schema",
+      description: "Enforces users to avoid using the type name in a field name while defining your schema.",
+      recommended: true,
+      url: "https://the-guild.dev/graphql/eslint/rules/no-typename-prefix",
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
             type User {
               userId: ID!
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
             type User {
               id: ID!
             }
-          `,
-                },
-            ],
-        },
-        messages: {
-            [NO_TYPENAME_PREFIX]: 'Field "{{ fieldName }}" starts with the name of the parent type "{{ typeName }}"',
-        },
-        schema: [],
+          `
+          )
+        }
+      ]
     },
-    create(context) {
-        return {
-            'ObjectTypeDefinition, ObjectTypeExtension, InterfaceTypeDefinition, InterfaceTypeExtension'(node) {
-                const typeName = node.name.value;
-                const lowerTypeName = typeName.toLowerCase();
-                for (const field of node.fields || []) {
-                    const fieldName = field.name.value;
-                    if (fieldName.toLowerCase().startsWith(lowerTypeName)) {
-                        context.report({
-                            data: {
-                                fieldName,
-                                typeName,
-                            },
-                            messageId: NO_TYPENAME_PREFIX,
-                            node: field.name,
-                            suggest: [
-                                {
-                                    desc: `Remove \`${fieldName.slice(0, typeName.length)}\` prefix`,
-                                    fix: fixer => fixer.replaceText(field.name, fieldName.replace(new RegExp(`^${typeName}`, 'i'), '')),
-                                },
-                            ],
-                        });
-                    }
-                }
-            },
-        };
+    messages: {
+      [NO_TYPENAME_PREFIX]: 'Field "{{ fieldName }}" starts with the name of the parent type "{{ typeName }}"'
     },
+    schema: []
+  },
+  create(context) {
+    return {
+      "ObjectTypeDefinition, ObjectTypeExtension, InterfaceTypeDefinition, InterfaceTypeExtension"(node) {
+        const typeName = node.name.value;
+        const lowerTypeName = typeName.toLowerCase();
+        for (const field of node.fields || []) {
+          const fieldName = field.name.value;
+          if (fieldName.toLowerCase().startsWith(lowerTypeName)) {
+            context.report({
+              data: {
+                fieldName,
+                typeName
+              },
+              messageId: NO_TYPENAME_PREFIX,
+              node: field.name,
+              suggest: [
+                {
+                  desc: `Remove \`${fieldName.slice(0, typeName.length)}\` prefix`,
+                  fix: (fixer) => fixer.replaceText(
+                    field.name,
+                    fieldName.replace(new RegExp(`^${typeName}`, "i"), "")
+                  )
+                }
+              ]
+            });
+          }
+        }
+      }
+    };
+  }
+};
+export {
+  rule
 };

package/esm/rules/no-unreachable-types.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 };