@graphql-eslint/eslint-plugin 3.0.0-alpha-698204a.0 → 3.0.0-alpha-0a996de.0

package/index.js

@@ -38,21 +38,22 @@ const schemaRecommendedConfig = {
             'error',
             {
                 types: 'PascalCase',
-                fields: 'camelCase',
-                overrides: {
-                    EnumValueDefinition: 'UPPER_CASE',
-                    'FieldDefinition[parent.name.value=Query]': {
-                        forbiddenPrefixes: ['query', 'get'],
-                        forbiddenSuffixes: ['Query'],
-                    },
-                    'FieldDefinition[parent.name.value=Mutation]': {
-                        forbiddenPrefixes: ['mutation'],
-                        forbiddenSuffixes: ['Mutation'],
-                    },
-                    'FieldDefinition[parent.name.value=Subscription]': {
-                        forbiddenPrefixes: ['subscription'],
-                        forbiddenSuffixes: ['Subscription'],
-                    },
+                FieldDefinition: 'camelCase',
+                InputValueDefinition: 'camelCase',
+                Argument: 'camelCase',
+                DirectiveDefinition: 'camelCase',
+                EnumValueDefinition: 'UPPER_CASE',
+                'FieldDefinition[parent.name.value=Query]': {
+                    forbiddenPrefixes: ['query', 'get'],
+                    forbiddenSuffixes: ['Query'],
+                },
+                'FieldDefinition[parent.name.value=Mutation]': {
+                    forbiddenPrefixes: ['mutation'],
+                    forbiddenSuffixes: ['Mutation'],
+                },
+                'FieldDefinition[parent.name.value=Subscription]': {
+                    forbiddenPrefixes: ['subscription'],
+                    forbiddenSuffixes: ['Subscription'],
                 },
             },
         ],
@@ -60,9 +61,9 @@ const schemaRecommendedConfig = {
         '@graphql-eslint/no-hashtag-description': 'error',
         '@graphql-eslint/no-typename-prefix': 'error',
         '@graphql-eslint/no-unreachable-types': 'error',
-        '@graphql-eslint/possible-type-extension': 'error',
         '@graphql-eslint/provided-required-arguments': 'error',
         '@graphql-eslint/require-deprecation-reason': 'error',
+        '@graphql-eslint/require-description': ['error', { types: true, DirectiveDefinition: true }],
         '@graphql-eslint/strict-id-in-types': 'error',
         '@graphql-eslint/unique-directive-names': 'error',
         '@graphql-eslint/unique-directive-names-per-location': 'error',
@@ -91,8 +92,8 @@ const schemaAllConfig = {
         '@graphql-eslint/no-root-type': 'off',
         '@graphql-eslint/no-scalar-result-type-on-mutation': 'error',
         '@graphql-eslint/no-unused-fields': 'off',
+        '@graphql-eslint/possible-type-extension': 'off',
         '@graphql-eslint/require-deprecation-date': 'error',
-        '@graphql-eslint/require-description': ['error', { types: true, overrides: { DirectiveDefinition: true } }],
         '@graphql-eslint/require-field-of-type-query-in-mutation-result': 'error',
     },
 };
@@ -114,16 +115,13 @@ const operationsRecommendedConfig = {
         '@graphql-eslint/naming-convention': [
             'error',
             {
-                overrides: {
-                    Argument: 'camelCase',
-                    VariableDefinition: 'camelCase',
-                    OperationDefinition: {
-                        style: 'PascalCase',
-                        forbiddenPrefixes: ['Query', 'Mutation', 'Subscription', 'Get'],
-                        forbiddenSuffixes: ['Query', 'Mutation', 'Subscription'],
-                    },
-                    FragmentDefinition: { style: 'PascalCase', forbiddenPrefixes: ['Fragment'], forbiddenSuffixes: ['Fragment'] },
+                VariableDefinition: 'camelCase',
+                OperationDefinition: {
+                    style: 'PascalCase',
+                    forbiddenPrefixes: ['Query', 'Mutation', 'Subscription', 'Get'],
+                    forbiddenSuffixes: ['Query', 'Mutation', 'Subscription'],
                 },
+                FragmentDefinition: { style: 'PascalCase', forbiddenPrefixes: ['Fragment'], forbiddenSuffixes: ['Fragment'] },
             },
         ],
         '@graphql-eslint/no-anonymous-operations': 'error',
@@ -389,9 +387,9 @@ const validationToRule = (name, ruleName, docs, getDocumentNode) => {
         [name]: {
             meta: {
                 docs: {
+                    recommended: true,
                     ...docs,
                     graphQLJSRuleName: ruleName,
-                    recommended: true,
                     requiresSchema,
                     url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${name}.md`,
                     description: `${docs.description}\n\n> This rule is a wrapper around a \`graphql-js\` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/${ruleName}Rule.ts).`,
@@ -567,6 +565,7 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
     category: 'Schema',
     description: `A type extension is only valid if the type is defined and has the same kind.`,
     requiresSchema: false,
+    recommended: false, // TODO: enable after https://github.com/dotansimha/graphql-eslint/issues/787 will be fixed
 }), validationToRule('provided-required-arguments', 'ProvidedRequiredArguments', {
     category: ['Schema', 'Operations'],
     description: `A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.`,
@@ -912,23 +911,21 @@ const rule$1 = {
                 properties: {
                     style: {
                         enum: ['block', 'inline'],
-                        default: 'inline',
+                        default: 'block',
                     },
                 },
             },
         ],
     },
     create(context) {
-        const { style } = context.options[0] || { style: 'inline' };
-        const wrongDescriptionType = style === 'block' ? 'inline' : 'block';
+        const { style = 'block' } = context.options[0] || {};
+        const isBlock = style === 'block';
         return {
-            '[description.type="StringValue"]': node => {
-                if (node.description.block !== (style === 'block')) {
-                    context.report({
-                        loc: getLocation(node.description.loc),
-                        message: `Unexpected ${wrongDescriptionType} description`,
-                    });
-                }
+            [`.description[type=StringValue][block!=${isBlock}]`](node) {
+                context.report({
+                    loc: getLocation(node.loc),
+                    message: `Unexpected ${isBlock ? 'inline' : 'block'} description`,
+                });
             },
         };
     },
@@ -1254,7 +1251,6 @@ const rule$3 = {
     },
 };
 
-const FIELDS_KINDS = [graphql.Kind.FIELD_DEFINITION, graphql.Kind.INPUT_VALUE_DEFINITION, graphql.Kind.ARGUMENT, graphql.Kind.DIRECTIVE_DEFINITION];
 const KindToDisplayName = {
     // types
     [graphql.Kind.OBJECT_TYPE_DEFINITION]: 'Type',
@@ -1296,20 +1292,56 @@ const rule$4 = {
             examples: [
                 {
                     title: 'Incorrect',
-                    usage: [{ types: 'PascalCase', fields: 'camelCase' }],
+                    usage: [{ types: 'PascalCase', FieldDefinition: 'camelCase' }],
                     code: /* GraphQL */ `
             type user {
               first_name: String!
             }
+          `,
+                },
+                {
+                    title: 'Incorrect',
+                    usage: [{ FragmentDefinition: { style: 'PascalCase', forbiddenSuffixes: ['Fragment'] } }],
+                    code: /* GraphQL */ `
+            fragment UserFragment on User {
+              # ...
+            }
+          `,
+                },
+                {
+                    title: 'Incorrect',
+                    usage: [{ 'FieldDefinition[parent.name.value=Query]': { forbiddenPrefixes: ['get'] } }],
+                    code: /* GraphQL */ `
+            type Query {
+              getUsers: [User!]!
+            }
           `,
                 },
                 {
                     title: 'Correct',
-                    usage: [{ types: 'PascalCase', fields: 'camelCase' }],
+                    usage: [{ types: 'PascalCase', FieldDefinition: 'camelCase' }],
                     code: /* GraphQL */ `
             type User {
               firstName: String
             }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    usage: [{ FragmentDefinition: { style: 'PascalCase', forbiddenSuffixes: ['Fragment'] } }],
+                    code: /* GraphQL */ `
+            fragment UserFields on User {
+              # ...
+            }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    usage: [{ 'FieldDefinition[parent.name.value=Query]': { forbiddenPrefixes: ['get'] } }],
+                    code: /* GraphQL */ `
+            type Query {
+              users: [User!]!
+            }
           `,
                 },
             ],
@@ -1317,39 +1349,37 @@ const rule$4 = {
                 schema: [
                     {
                         types: 'PascalCase',
-                        fields: 'camelCase',
-                        overrides: {
-                            EnumValueDefinition: 'UPPER_CASE',
-                            'FieldDefinition[parent.name.value=Query]': {
-                                forbiddenPrefixes: ['query', 'get'],
-                                forbiddenSuffixes: ['Query'],
-                            },
-                            'FieldDefinition[parent.name.value=Mutation]': {
-                                forbiddenPrefixes: ['mutation'],
-                                forbiddenSuffixes: ['Mutation'],
-                            },
-                            'FieldDefinition[parent.name.value=Subscription]': {
-                                forbiddenPrefixes: ['subscription'],
-                                forbiddenSuffixes: ['Subscription'],
-                            },
+                        FieldDefinition: 'camelCase',
+                        InputValueDefinition: 'camelCase',
+                        Argument: 'camelCase',
+                        DirectiveDefinition: 'camelCase',
+                        EnumValueDefinition: 'UPPER_CASE',
+                        'FieldDefinition[parent.name.value=Query]': {
+                            forbiddenPrefixes: ['query', 'get'],
+                            forbiddenSuffixes: ['Query'],
+                        },
+                        'FieldDefinition[parent.name.value=Mutation]': {
+                            forbiddenPrefixes: ['mutation'],
+                            forbiddenSuffixes: ['Mutation'],
+                        },
+                        'FieldDefinition[parent.name.value=Subscription]': {
+                            forbiddenPrefixes: ['subscription'],
+                            forbiddenSuffixes: ['Subscription'],
                         },
                     },
                 ],
                 operations: [
                     {
-                        overrides: {
-                            Argument: 'camelCase',
-                            VariableDefinition: 'camelCase',
-                            OperationDefinition: {
-                                style: 'PascalCase',
-                                forbiddenPrefixes: ['Query', 'Mutation', 'Subscription', 'Get'],
-                                forbiddenSuffixes: ['Query', 'Mutation', 'Subscription'],
-                            },
-                            FragmentDefinition: {
-                                style: 'PascalCase',
-                                forbiddenPrefixes: ['Fragment'],
-                                forbiddenSuffixes: ['Fragment'],
-                            },
+                        VariableDefinition: 'camelCase',
+                        OperationDefinition: {
+                            style: 'PascalCase',
+                            forbiddenPrefixes: ['Query', 'Mutation', 'Subscription', 'Get'],
+                            forbiddenSuffixes: ['Query', 'Mutation', 'Subscription'],
+                        },
+                        FragmentDefinition: {
+                            style: 'PascalCase',
+                            forbiddenPrefixes: ['Fragment'],
+                            forbiddenSuffixes: ['Fragment'],
                         },
                     },
                 ],
@@ -1391,12 +1421,15 @@ const rule$4 = {
                 properties: {
                     types: {
                         ...schemaOption$1,
-                        description: `Includes:\n\n${TYPES_KINDS.map(kind => `- [${kind}](https://spec.graphql.org/October2021/#${kind})`).join('\n')}`,
-                    },
-                    fields: {
-                        ...schemaOption$1,
-                        description: `Includes:\n\n${FIELDS_KINDS.map(kind => `- [${kind}](https://spec.graphql.org/October2021/#${kind})`).join('\n')}`,
+                        description: `Includes:\n\n${TYPES_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
                     },
+                    ...Object.fromEntries(ALLOWED_KINDS.map(kind => [
+                        kind,
+                        {
+                            ...schemaOption$1,
+                            description: `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`,
+                        },
+                    ])),
                     allowLeadingUnderscore: {
                         type: 'boolean',
                         default: false,
@@ -1405,36 +1438,25 @@ const rule$4 = {
                         type: 'boolean',
                         default: false,
                     },
-                    overrides: {
-                        type: 'object',
-                        additionalProperties: false,
-                        description: [
-                            'May contain the following `ASTNode` names:',
-                            '',
-                            ...ALLOWED_KINDS.map(kind => `- [${kind}](https://spec.graphql.org/October2021/#${kind})`),
-                            '',
-                            "> It's also possible to use a [`selector`](https://eslint.org/docs/developer-guide/selectors) that starts with `ASTNode` name",
-                            '>',
-                            '> Example: pattern property `FieldDefinition[parent.name.value=Query]` will match only fields for type `Query`',
-                        ].join('\n'),
-                        patternProperties: {
-                            [`^(${ALLOWED_KINDS.join('|')})(.+)?$`]: schemaOption$1,
-                        },
-                    },
                 },
+                patternProperties: {
+                    [`^(${ALLOWED_KINDS.join('|')})(.+)?$`]: schemaOption$1,
+                },
+                description: [
+                    "> It's possible to use a [`selector`](https://eslint.org/docs/developer-guide/selectors) that starts with allowed `ASTNode` names which are described below.",
+                    '>',
+                    '> Paste or drop code into the editor in [ASTExplorer](https://astexplorer.net) and inspect the generated AST to compose your selector.',
+                    '>',
+                    '> Example: pattern property `FieldDefinition[parent.name.value=Query]` will match only fields for type `Query`.',
+                ].join('\n'),
             },
         },
     },
     create(context) {
-        const options = {
-            overrides: {},
-            ...context.options[0],
-        };
+        const options = context.options[0] || {};
+        const { allowLeadingUnderscore, allowTrailingUnderscore, types, ...restOptions } = options;
         function normalisePropertyOption(kind) {
-            let style = options.overrides[kind];
-            if (!style) {
-                style = TYPES_KINDS.includes(kind) ? options.types : options.fields;
-            }
+            const style = restOptions[kind] || types;
             return typeof style === 'object' ? style : { style };
         }
         const checkNode = (selector) => (node) => {
@@ -1454,10 +1476,10 @@ const rule$4 = {
             }
             function getErrorMessage() {
                 let name = nodeName;
-                if (options.allowLeadingUnderscore) {
+                if (allowLeadingUnderscore) {
                     name = name.replace(/^_*/, '');
                 }
-                if (options.allowTrailingUnderscore) {
+                if (allowTrailingUnderscore) {
                     name = name.replace(/_*$/, '');
                 }
                 if (prefix && !name.startsWith(prefix)) {
@@ -1491,15 +1513,13 @@ const rule$4 = {
             });
         };
         const listeners = {};
-        if (!options.allowLeadingUnderscore) {
+        if (!allowLeadingUnderscore) {
             listeners['Name[value=/^_/]:matches([parent.kind!=Field], [parent.kind=Field][parent.alias])'] = checkUnderscore;
         }
-        if (!options.allowTrailingUnderscore) {
+        if (!allowTrailingUnderscore) {
             listeners['Name[value=/_$/]:matches([parent.kind!=Field], [parent.kind=Field][parent.alias])'] = checkUnderscore;
         }
-        const selectors = new Set([options.types && TYPES_KINDS, options.fields && FIELDS_KINDS, Object.keys(options.overrides)]
-            .flat()
-            .filter(Boolean));
+        const selectors = new Set([types && TYPES_KINDS, Object.keys(restOptions)].flat().filter(Boolean));
         for (const selector of selectors) {
             listeners[selector] = checkNode(selector);
         }
@@ -1904,18 +1924,18 @@ const rule$9 = {
     },
 };
 
-const ROOT_TYPES = ['query', 'mutation', 'subscription'];
+const ROOT_TYPES = ['mutation', 'subscription'];
 const rule$a = {
     meta: {
         type: 'suggestion',
         docs: {
             category: 'Schema',
-            description: 'Disallow using root types for `read-only` or `write-only` schemas.',
+            description: 'Disallow using root types `mutation` and/or `subscription`.',
             url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/no-root-type.md',
             requiresSchema: true,
             examples: [
                 {
-                    title: 'Incorrect (`read-only` schema)',
+                    title: 'Incorrect',
                     usage: [{ disallow: ['mutation', 'subscription'] }],
                     code: /* GraphQL */ `
             type Mutation {
@@ -1924,16 +1944,7 @@ const rule$a = {
           `,
                 },
                 {
-                    title: 'Incorrect (`write-only` schema)',
-                    usage: [{ disallow: ['query'] }],
-                    code: /* GraphQL */ `
-            type Query {
-              users: [User!]!
-            }
-          `,
-                },
-                {
-                    title: 'Correct (`read-only` schema)',
+                    title: 'Correct',
                     usage: [{ disallow: ['mutation', 'subscription'] }],
                     code: /* GraphQL */ `
             type Query {
@@ -1968,7 +1979,6 @@ const rule$a = {
         const schema = requireGraphQLSchemaFromContext('no-root-type', context);
         const disallow = new Set(context.options[0].disallow);
         const rootTypeNames = [
-            disallow.has('query') && schema.getQueryType(),
             disallow.has('mutation') && schema.getMutationType(),
             disallow.has('subscription') && schema.getSubscriptionType(),
         ]
@@ -2548,7 +2558,7 @@ const rule$h = {
             examples: [
                 {
                     title: 'Incorrect',
-                    usage: [{ types: true, overrides: { FieldDefinition: true } }],
+                    usage: [{ types: true, FieldDefinition: true }],
                     code: /* GraphQL */ `
             type someTypeName {
               name: String
@@ -2557,7 +2567,7 @@ const rule$h = {
                 },
                 {
                     title: 'Correct',
-                    usage: [{ types: true, overrides: { FieldDefinition: true } }],
+                    usage: [{ types: true, FieldDefinition: true }],
                     code: /* GraphQL */ `
             """
             Some type description
@@ -2574,11 +2584,10 @@ const rule$h = {
             configOptions: [
                 {
                     types: true,
-                    overrides: {
-                        [graphql.Kind.DIRECTIVE_DEFINITION]: true,
-                    },
+                    [graphql.Kind.DIRECTIVE_DEFINITION]: true,
                 },
             ],
+            recommended: true,
         },
         type: 'suggestion',
         messages: {
@@ -2595,22 +2604,23 @@ const rule$h = {
                 properties: {
                     types: {
                         type: 'boolean',
-                        description: `Includes:\n\n${TYPES_KINDS.map(kind => `- [${kind}](https://spec.graphql.org/October2021/#${kind})`).join('\n')}`,
-                    },
-                    overrides: {
-                        type: 'object',
-                        description: 'Configuration for precise `ASTNode`',
-                        additionalProperties: false,
-                        properties: Object.fromEntries(ALLOWED_KINDS$1.map(kind => [kind, { type: 'boolean' }])),
+                        description: `Includes:\n\n${TYPES_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
                     },
+                    ...Object.fromEntries([...ALLOWED_KINDS$1].sort().map(kind => [
+                        kind,
+                        {
+                            type: 'boolean',
+                            description: `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`,
+                        },
+                    ])),
                 },
             },
         },
     },
     create(context) {
-        const { types, overrides = {} } = context.options[0];
+        const { types, ...restOptions } = context.options[0];
         const kinds = new Set(types ? TYPES_KINDS : []);
-        for (const [kind, isEnabled] of Object.entries(overrides)) {
+        for (const [kind, isEnabled] of Object.entries(restOptions)) {
             if (isEnabled) {
                 kinds.add(kind);
             }