@graphql-eslint/eslint-plugin/cjs/rules/input-name.js

GraphQL plugin for ESLint

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.rule = void 0;
const graphql_1 = require("graphql");
const schema = {
    type: 'array',
    maxItems: 1,
    items: {
        type: 'object',
        additionalProperties: false,
        properties: {
            checkInputType: {
                type: 'boolean',
                default: false,
                description: 'Check that the input type name follows the convention <mutationName>Input',
            },
            caseSensitiveInputType: {
                type: 'boolean',
                default: true,
                description: 'Allow for case discrepancies in the input type name',
            },
            checkQueries: {
                type: 'boolean',
                default: false,
                description: 'Apply the rule to Queries',
            },
            checkMutations: {
                type: 'boolean',
                default: true,
                description: 'Apply the rule to Mutations',
            },
        },
    },
};
const isObjectType = (node) => [graphql_1.Kind.OBJECT_TYPE_DEFINITION, graphql_1.Kind.OBJECT_TYPE_EXTENSION].includes(node.type);
const isQueryType = (node) => isObjectType(node) && node.name.value === 'Query';
const isMutationType = (node) => isObjectType(node) && node.name.value === 'Mutation';
exports.rule = {
    meta: {
        type: 'suggestion',
        hasSuggestions: true,
        docs: {
            description: 'Require mutation argument to be always called "input" and input type to be called Mutation name + "Input".\nUsing the same name for all input parameters will make your schemas easier to consume and more predictable. Using the same name as mutation for InputType will make it easier to find mutations that InputType belongs to.',
            category: 'Schema',
            url: 'https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/input-name.md',
            examples: [
                {
                    title: 'Incorrect',
                    usage: [{ checkInputType: true }],
                    code: /* GraphQL */ `
            type Mutation {
              SetMessage(message: InputMessage): String
            }
          `,
                },
                {
                    title: 'Correct (with checkInputType)',
                    usage: [{ checkInputType: true }],
                    code: /* GraphQL */ `
            type Mutation {
              SetMessage(input: SetMessageInput): String
            }
          `,
                },
                {
                    title: 'Correct (without checkInputType)',
                    usage: [{ checkInputType: false }],
                    code: /* GraphQL */ `
            type Mutation {
              SetMessage(input: AnyInputTypeName): String
            }
          `,
                },
            ],
        },
        schema,
    },
    create(context) {
        const options = {
            checkInputType: false,
            caseSensitiveInputType: true,
            checkQueries: false,
            checkMutations: true,
            ...context.options[0],
        };
        const shouldCheckType = node => (options.checkMutations && isMutationType(node)) ||
            (options.checkQueries && isQueryType(node));
        const listeners = {
            'FieldDefinition > InputValueDefinition[name.value!=input] > Name'(node) {
                if (shouldCheckType(node.parent.parent.parent)) {
                    const inputName = node.value;
                    context.report({
                        node,
                        message: `Input \`${inputName}\` should be called \`input\`.`,
                        suggest: [
                            {
                                desc: 'Rename to `input`',
                                fix: fixer => fixer.replaceText(node, 'input'),
                            },
                        ],
                    });
                }
            },
        };
        if (options.checkInputType) {
            listeners['FieldDefinition > InputValueDefinition NamedType'] = (node) => {
                const findInputType = item => {
                    let currentNode = item;
                    while (currentNode.type !== graphql_1.Kind.INPUT_VALUE_DEFINITION) {
                        currentNode = currentNode.parent;
                    }
                    return currentNode;
                };
                const inputValueNode = findInputType(node);
                if (shouldCheckType(inputValueNode.parent.parent)) {
                    const mutationName = `${inputValueNode.parent.name.value}Input`;
                    const name = node.name.value;
                    if ((options.caseSensitiveInputType && node.name.value !== mutationName) ||
                        name.toLowerCase() !== mutationName.toLowerCase()) {
                        context.report({
                            node: node.name,
                            message: `Input type \`${name}\` name should be \`${mutationName}\`.`,
                            suggest: [
                                {
                                    desc: `Rename to \`${mutationName}\``,
                                    fix: fixer => fixer.replaceText(node, mutationName),
                                },
                            ],
                        });
                    }
                }
            };
        }
        return listeners;
    },
};