@graphql-eslint/eslint-plugin 3.0.0-alpha-636cc2a.0 → 3.0.1-alpha-86a9e78.0

package/README.md

@@ -180,17 +180,27 @@ You can find a list of [ESLint directives here](https://eslint.org/docs/2.13.1/u
 
 You can find a complete list of [all available rules here](docs/README.md).
 
+## Deprecated Rules
+
+See [docs/deprecated-rules.md](docs/deprecated-rules.md).
+
 ## Available Configs
 
 <!-- prettier-ignore-start -->
 |Name|Description|
 |:-:|-|
-|[`schema-recommended`](packages/plugin/src/configs/schema-recommended.ts)|enables all recommended rules|
-|[`operations-recommended`](packages/plugin/src/configs/operations-recommended.ts) |enables all recommended rules|
-|[`schema-all`](packages/plugin/src/configs/schema-all.ts)|enables all rules, except for those that require `parserOptions.operations` option)|
-|[`operations-all`](packages/plugin/src/configs/operations-all.ts)|enables all rules|
+|[`schema-recommended`](packages/plugin/src/configs/schema-recommended.ts)|enables recommended rules for schema (SDL) development|
+|[`schema-all`](packages/plugin/src/configs/schema-all.ts)|enables all rules for schema (SDL) development, except for those that require `parserOptions.operations` option|
+|[`operations-recommended`](packages/plugin/src/configs/operations-recommended.ts) |enables recommended rules for consuming GraphQL (operations) development|
+|[`operations-all`](packages/plugin/src/configs/operations-all.ts)|enables all rules for consuming GraphQL (operations) development|
 <!-- prettier-ignore-end -->
 
+> If you are in a project that develops the GraphQL schema, you'll need `schema` rules. 
+
+> If you are in a project that develops GraphQL operations (query/mutation/subscription), you'll need `operations` rules.
+
+> If you are in a monorepo project, you probably need both sets of rules.
+
 ## Config usage
 
 For example, to enable the `schema-recommended` config, enable it in your `.eslintrc` file with the `extends` option:

package/configs/index.d.ts

@@ -13,7 +13,10 @@ export declare const configs: {
             '@graphql-eslint/lone-schema-definition': string;
             '@graphql-eslint/naming-convention': (string | {
                 types: string;
-                fields: string;
+                FieldDefinition: string;
+                InputValueDefinition: string;
+                Argument: string;
+                DirectiveDefinition: string;
                 EnumValueDefinition: string;
                 'FieldDefinition[parent.name.value=Query]': {
                     forbiddenPrefixes: string[];
@@ -32,7 +35,6 @@ export declare const configs: {
             '@graphql-eslint/no-hashtag-description': string;
             '@graphql-eslint/no-typename-prefix': string;
             '@graphql-eslint/no-unreachable-types': string;
-            '@graphql-eslint/possible-type-extension': string;
             '@graphql-eslint/provided-required-arguments': string;
             '@graphql-eslint/require-deprecation-reason': string;
             '@graphql-eslint/require-description': (string | {
@@ -60,6 +62,7 @@ export declare const configs: {
             '@graphql-eslint/no-root-type': string;
             '@graphql-eslint/no-scalar-result-type-on-mutation': string;
             '@graphql-eslint/no-unused-fields': string;
+            '@graphql-eslint/possible-type-extension': string;
             '@graphql-eslint/require-deprecation-date': string;
             '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
         };

package/configs/schema-all.d.ts

@@ -10,6 +10,7 @@ declare const _default: {
         '@graphql-eslint/no-root-type': string;
         '@graphql-eslint/no-scalar-result-type-on-mutation': string;
         '@graphql-eslint/no-unused-fields': string;
+        '@graphql-eslint/possible-type-extension': string;
         '@graphql-eslint/require-deprecation-date': string;
         '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
     };

package/configs/schema-recommended.d.ts

@@ -8,7 +8,10 @@ declare const _default: {
         '@graphql-eslint/lone-schema-definition': string;
         '@graphql-eslint/naming-convention': (string | {
             types: string;
-            fields: string;
+            FieldDefinition: string;
+            InputValueDefinition: string;
+            Argument: string;
+            DirectiveDefinition: string;
             EnumValueDefinition: string;
             'FieldDefinition[parent.name.value=Query]': {
                 forbiddenPrefixes: string[];
@@ -27,7 +30,6 @@ declare const _default: {
         '@graphql-eslint/no-hashtag-description': string;
         '@graphql-eslint/no-typename-prefix': string;
         '@graphql-eslint/no-unreachable-types': string;
-        '@graphql-eslint/possible-type-extension': string;
         '@graphql-eslint/provided-required-arguments': string;
         '@graphql-eslint/require-deprecation-reason': string;
         '@graphql-eslint/require-description': (string | {

package/docs/README.md

@@ -42,7 +42,7 @@ Name            &nbs
 [one-field-subscriptions](rules/one-field-subscriptions.md)|A GraphQL subscription is valid only if it contains a single root field.|🔮||✅
 [overlapping-fields-can-be-merged](rules/overlapping-fields-can-be-merged.md)|A selection set is only valid if all fields (including spreading any fragments) either correspond to distinct response names or can be merged without ambiguity.|🔮||✅
 [possible-fragment-spread](rules/possible-fragment-spread.md)|A fragment spread is only valid if the type condition could ever possibly be true: if there is a non-empty intersection of the possible parent types, and possible types which pass the type condition.|🔮||✅
-[possible-type-extension](rules/possible-type-extension.md)|A type extension is only valid if the type is defined and has the same kind.|🔮||✅
+[possible-type-extension](rules/possible-type-extension.md)|A type extension is only valid if the type is defined and has the same kind.|🔮||
 [provided-required-arguments](rules/provided-required-arguments.md)|A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.|🔮||✅
 [require-deprecation-date](rules/require-deprecation-date.md)|Require deletion date on `@deprecated` directive. Suggest removing deprecated things after deprecated date.|🚀||
 [require-deprecation-reason](rules/require-deprecation-reason.md)|Require all deprecation directives to specify a reason.|🚀||✅

package/docs/rules/naming-convention.md

@@ -14,7 +14,7 @@ Require names to follow specified conventions.
 ### Incorrect
 
 ```graphql
-# eslint @graphql-eslint/naming-convention: ['error', { types: 'PascalCase', fields: 'camelCase' }]
+# eslint @graphql-eslint/naming-convention: ['error', { types: 'PascalCase', FieldDefinition: 'camelCase' }]
 
 type user {
   first_name: String!
@@ -44,7 +44,7 @@ type Query {
 ### Correct
 
 ```graphql
-# eslint @graphql-eslint/naming-convention: ['error', { types: 'PascalCase', fields: 'camelCase' }]
+# eslint @graphql-eslint/naming-convention: ['error', { types: 'PascalCase', FieldDefinition: 'camelCase' }]
 
 type User {
   firstName: String
@@ -97,20 +97,6 @@ The object must be one of the following types:
 * `asString`
 * `asObject`
 
-### `fields`
-
-Includes:
-
-- `FieldDefinition`
-- `InputValueDefinition`
-- `Argument`
-- `DirectiveDefinition`
-
-The object must be one of the following types:
-
-* `asString`
-* `asObject`
-
 ### `Argument`
 
 Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#Argument).

package/docs/rules/possible-type-extension.md

@@ -1,7 +1,5 @@
 # `possible-type-extension`
 
-✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
-
 - Category: `Schema`
 - Rule name: `@graphql-eslint/possible-type-extension`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

package/index.js

@@ -38,7 +38,10 @@ const schemaRecommendedConfig = {
             'error',
             {
                 types: 'PascalCase',
-                fields: 'camelCase',
+                FieldDefinition: 'camelCase',
+                InputValueDefinition: 'camelCase',
+                Argument: 'camelCase',
+                DirectiveDefinition: 'camelCase',
                 EnumValueDefinition: 'UPPER_CASE',
                 'FieldDefinition[parent.name.value=Query]': {
                     forbiddenPrefixes: ['query', 'get'],
@@ -58,7 +61,6 @@ 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 }],
@@ -90,6 +92,7 @@ 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-field-of-type-query-in-mutation-result': 'error',
     },
@@ -384,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).`,
@@ -562,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.`,
@@ -1247,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',
@@ -1289,7 +1292,7 @@ const rule$4 = {
             examples: [
                 {
                     title: 'Incorrect',
-                    usage: [{ types: 'PascalCase', fields: 'camelCase' }],
+                    usage: [{ types: 'PascalCase', FieldDefinition: 'camelCase' }],
                     code: /* GraphQL */ `
             type user {
               first_name: String!
@@ -1316,7 +1319,7 @@ const rule$4 = {
                 },
                 {
                     title: 'Correct',
-                    usage: [{ types: 'PascalCase', fields: 'camelCase' }],
+                    usage: [{ types: 'PascalCase', FieldDefinition: 'camelCase' }],
                     code: /* GraphQL */ `
             type User {
               firstName: String
@@ -1346,7 +1349,10 @@ const rule$4 = {
                 schema: [
                     {
                         types: 'PascalCase',
-                        fields: 'camelCase',
+                        FieldDefinition: 'camelCase',
+                        InputValueDefinition: 'camelCase',
+                        Argument: 'camelCase',
+                        DirectiveDefinition: 'camelCase',
                         EnumValueDefinition: 'UPPER_CASE',
                         'FieldDefinition[parent.name.value=Query]': {
                             forbiddenPrefixes: ['query', 'get'],
@@ -1417,10 +1423,6 @@ const rule$4 = {
                         ...schemaOption$1,
                         description: `Includes:\n\n${TYPES_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
                     },
-                    fields: {
-                        ...schemaOption$1,
-                        description: `Includes:\n\n${FIELDS_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
-                    },
                     ...Object.fromEntries(ALLOWED_KINDS.map(kind => [
                         kind,
                         {
@@ -1452,12 +1454,9 @@ const rule$4 = {
     },
     create(context) {
         const options = context.options[0] || {};
-        const { allowLeadingUnderscore, allowTrailingUnderscore, types, fields, ...restOptions } = options;
+        const { allowLeadingUnderscore, allowTrailingUnderscore, types, ...restOptions } = options;
         function normalisePropertyOption(kind) {
-            let style = options[kind];
-            if (!style) {
-                style = TYPES_KINDS.includes(kind) ? types : fields;
-            }
+            const style = restOptions[kind] || types;
             return typeof style === 'object' ? style : { style };
         }
         const checkNode = (selector) => (node) => {
@@ -1520,7 +1519,7 @@ const rule$4 = {
         if (!allowTrailingUnderscore) {
             listeners['Name[value=/_$/]:matches([parent.kind!=Field], [parent.kind=Field][parent.alias])'] = checkUnderscore;
         }
-        const selectors = new Set([types && TYPES_KINDS, fields && FIELDS_KINDS, Object.keys(restOptions)].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);
         }
@@ -2698,13 +2697,11 @@ const rule$i = {
         }
         const selector = [
             `:matches(${graphql.Kind.OBJECT_TYPE_DEFINITION}, ${graphql.Kind.OBJECT_TYPE_EXTENSION})[name.value=${mutationType.name}]`,
-            '>',
-            graphql.Kind.FIELD_DEFINITION,
-            graphql.Kind.NAMED_TYPE,
+            `> ${graphql.Kind.FIELD_DEFINITION} > .gqlType ${graphql.Kind.NAME}`,
         ].join(' ');
         return {
             [selector](node) {
-                const typeName = node.name.value;
+                const typeName = node.value;
                 const graphQLType = schema.getType(typeName);
                 if (graphql.isObjectType(graphQLType)) {
                     const { fields } = graphQLType.astNode;
@@ -2712,7 +2709,7 @@ const rule$i = {
                     if (!hasQueryType) {
                         context.report({
                             loc: getLocation(node.loc, typeName),
-                            message: `Mutation result type "${graphQLType.name}" must contain field of type "${queryType.name}".`,
+                            message: `Mutation result type "${graphQLType.name}" must contain field of type "${queryType.name}"`,
                         });
                     }
                 }

package/index.mjs

@@ -32,7 +32,10 @@ const schemaRecommendedConfig = {
             'error',
             {
                 types: 'PascalCase',
-                fields: 'camelCase',
+                FieldDefinition: 'camelCase',
+                InputValueDefinition: 'camelCase',
+                Argument: 'camelCase',
+                DirectiveDefinition: 'camelCase',
                 EnumValueDefinition: 'UPPER_CASE',
                 'FieldDefinition[parent.name.value=Query]': {
                     forbiddenPrefixes: ['query', 'get'],
@@ -52,7 +55,6 @@ 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 }],
@@ -84,6 +86,7 @@ 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-field-of-type-query-in-mutation-result': 'error',
     },
@@ -378,9 +381,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).`,
@@ -556,6 +559,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.`,
@@ -1241,7 +1245,6 @@ const rule$3 = {
     },
 };
 
-const FIELDS_KINDS = [Kind.FIELD_DEFINITION, Kind.INPUT_VALUE_DEFINITION, Kind.ARGUMENT, Kind.DIRECTIVE_DEFINITION];
 const KindToDisplayName = {
     // types
     [Kind.OBJECT_TYPE_DEFINITION]: 'Type',
@@ -1283,7 +1286,7 @@ const rule$4 = {
             examples: [
                 {
                     title: 'Incorrect',
-                    usage: [{ types: 'PascalCase', fields: 'camelCase' }],
+                    usage: [{ types: 'PascalCase', FieldDefinition: 'camelCase' }],
                     code: /* GraphQL */ `
             type user {
               first_name: String!
@@ -1310,7 +1313,7 @@ const rule$4 = {
                 },
                 {
                     title: 'Correct',
-                    usage: [{ types: 'PascalCase', fields: 'camelCase' }],
+                    usage: [{ types: 'PascalCase', FieldDefinition: 'camelCase' }],
                     code: /* GraphQL */ `
             type User {
               firstName: String
@@ -1340,7 +1343,10 @@ const rule$4 = {
                 schema: [
                     {
                         types: 'PascalCase',
-                        fields: 'camelCase',
+                        FieldDefinition: 'camelCase',
+                        InputValueDefinition: 'camelCase',
+                        Argument: 'camelCase',
+                        DirectiveDefinition: 'camelCase',
                         EnumValueDefinition: 'UPPER_CASE',
                         'FieldDefinition[parent.name.value=Query]': {
                             forbiddenPrefixes: ['query', 'get'],
@@ -1411,10 +1417,6 @@ const rule$4 = {
                         ...schemaOption$1,
                         description: `Includes:\n\n${TYPES_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
                     },
-                    fields: {
-                        ...schemaOption$1,
-                        description: `Includes:\n\n${FIELDS_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
-                    },
                     ...Object.fromEntries(ALLOWED_KINDS.map(kind => [
                         kind,
                         {
@@ -1446,12 +1448,9 @@ const rule$4 = {
     },
     create(context) {
         const options = context.options[0] || {};
-        const { allowLeadingUnderscore, allowTrailingUnderscore, types, fields, ...restOptions } = options;
+        const { allowLeadingUnderscore, allowTrailingUnderscore, types, ...restOptions } = options;
         function normalisePropertyOption(kind) {
-            let style = options[kind];
-            if (!style) {
-                style = TYPES_KINDS.includes(kind) ? types : fields;
-            }
+            const style = restOptions[kind] || types;
             return typeof style === 'object' ? style : { style };
         }
         const checkNode = (selector) => (node) => {
@@ -1514,7 +1513,7 @@ const rule$4 = {
         if (!allowTrailingUnderscore) {
             listeners['Name[value=/_$/]:matches([parent.kind!=Field], [parent.kind=Field][parent.alias])'] = checkUnderscore;
         }
-        const selectors = new Set([types && TYPES_KINDS, fields && FIELDS_KINDS, Object.keys(restOptions)].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);
         }
@@ -2692,13 +2691,11 @@ const rule$i = {
         }
         const selector = [
             `:matches(${Kind.OBJECT_TYPE_DEFINITION}, ${Kind.OBJECT_TYPE_EXTENSION})[name.value=${mutationType.name}]`,
-            '>',
-            Kind.FIELD_DEFINITION,
-            Kind.NAMED_TYPE,
+            `> ${Kind.FIELD_DEFINITION} > .gqlType ${Kind.NAME}`,
         ].join(' ');
         return {
             [selector](node) {
-                const typeName = node.name.value;
+                const typeName = node.value;
                 const graphQLType = schema.getType(typeName);
                 if (isObjectType$1(graphQLType)) {
                     const { fields } = graphQLType.astNode;
@@ -2706,7 +2703,7 @@ const rule$i = {
                     if (!hasQueryType) {
                         context.report({
                             loc: getLocation(node.loc, typeName),
-                            message: `Mutation result type "${graphQLType.name}" must contain field of type "${queryType.name}".`,
+                            message: `Mutation result type "${graphQLType.name}" must contain field of type "${queryType.name}"`,
                         });
                     }
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.0.0-alpha-636cc2a.0",
+  "version": "3.0.1-alpha-86a9e78.0",
   "sideEffects": false,
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"

package/rules/index.d.ts

@@ -44,13 +44,6 @@ export declare const rules: {
             forbiddenPrefixes?: string[];
             forbiddenSuffixes?: string[];
         };
-        fields?: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
     } & {
         [x: `OperationDefinition${string}`]: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
             style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";

package/rules/naming-convention.d.ts

@@ -29,7 +29,6 @@ declare type NamingConventionRuleConfig = {
     allowLeadingUnderscore?: boolean;
     allowTrailingUnderscore?: boolean;
     types?: Options;
-    fields?: Options;
 } & {
     [key in `${AllowedKind}${string}`]?: Options;
 };