@graphql-eslint/eslint-plugin 2.5.0-alpha-14532ce.0 → 2.5.0

package/configs/all.d.ts

@@ -15,6 +15,9 @@ export declare const allConfig: {
         '@graphql-eslint/match-document-filename': string;
         '@graphql-eslint/no-deprecated': string;
         '@graphql-eslint/no-hashtag-description': string;
+        '@graphql-eslint/no-root-type': (string | {
+            disallow: string[];
+        })[];
         '@graphql-eslint/no-unreachable-types': string;
         '@graphql-eslint/no-unused-fields': string;
         '@graphql-eslint/require-deprecation-date': string;

package/configs/index.d.ts

@@ -16,6 +16,9 @@ export declare const configs: {
             '@graphql-eslint/match-document-filename': string;
             '@graphql-eslint/no-deprecated': string;
             '@graphql-eslint/no-hashtag-description': string;
+            '@graphql-eslint/no-root-type': (string | {
+                disallow: string[];
+            })[];
             '@graphql-eslint/no-unreachable-types': string;
             '@graphql-eslint/no-unused-fields': string;
             '@graphql-eslint/require-deprecation-date': string;

package/docs/README.md

@@ -35,6 +35,7 @@ Name            &nbs
 [no-fragment-cycles](rules/no-fragment-cycles.md)|A GraphQL fragment is only valid when it does not have cycles in fragments usage.|🔮||✅
 [no-hashtag-description](rules/no-hashtag-description.md)|Requires to use `"""` or `"` for adding a GraphQL description instead of `#`.|🚀||
 [no-operation-name-suffix](rules/no-operation-name-suffix.md)|Makes sure you are not adding the operation type to the name of the operation.|🚀|🔧|✅
+[no-root-type](rules/no-root-type.md)|Disallow using root types for `read-only` or `write-only` schemas.|🚀||
 [no-undefined-variables](rules/no-undefined-variables.md)|A GraphQL operation is only valid if all variables encountered, both directly and via fragment spreads, are defined by that operation.|🔮||✅
 [no-unreachable-types](rules/no-unreachable-types.md)|Requires all types to be reachable at some level by root level fields.|🚀|🔧|
 [no-unused-fields](rules/no-unused-fields.md)|Requires all fields to be used at some level by siblings operations.|🚀|🔧|

package/docs/rules/no-deprecated.md

@@ -48,8 +48,8 @@ enum SomeType {
 mutation {
   changeSomething(
     type: OLD # This is deprecated, so you'll get an error
-  ) { 
-    ... 
+  ) {
+    ...
   }
 }
 ```

package/docs/rules/no-root-type.md

@@ -0,0 +1,56 @@
+# `no-root-type`
+
+- Category: `Validation`
+- Rule name: `@graphql-eslint/no-root-type`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Disallow using root types for `read-only` or `write-only` schemas.
+
+## Usage Examples
+
+### Incorrect (`read-only` schema)
+
+```graphql
+# eslint @graphql-eslint/no-root-type: ['error', { disallow: ['mutation', 'subscription'] }]
+
+type Mutation {
+  createUser(input: CreateUserInput!): User!
+}
+```
+
+### Incorrect (`write-only` schema)
+
+```graphql
+# eslint @graphql-eslint/no-root-type: ['error', { disallow: ['query'] }]
+
+type Query {
+  users: [User!]!
+}
+```
+
+### Correct (`read-only` schema)
+
+```graphql
+# eslint @graphql-eslint/no-root-type: ['error', { disallow: ['mutation', 'subscription'] }]
+
+type Query {
+  users: [User!]!
+}
+```
+
+## Config Schema
+
+The schema defines the following properties:
+
+### `disallow` (array, required)
+
+Additional restrictions:
+
+* Minimum items: `1`
+* Unique items: `true`
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/no-root-type.ts)
+- [Test source](../../packages/plugin/tests/no-root-type.spec.ts)

package/index.js

@@ -91,6 +91,7 @@ const allConfig = {
         '@graphql-eslint/match-document-filename': 'error',
         '@graphql-eslint/no-deprecated': 'error',
         '@graphql-eslint/no-hashtag-description': 'error',
+        '@graphql-eslint/no-root-type': ['error', { disallow: ['subscription'] }],
         '@graphql-eslint/no-unreachable-types': 'error',
         '@graphql-eslint/no-unused-fields': 'error',
         '@graphql-eslint/require-deprecation-date': 'error',
@@ -2065,9 +2066,100 @@ const rule$d = {
     },
 };
 
+const ROOT_TYPES = ['query', 'mutation', 'subscription'];
+const rule$e = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            category: 'Validation',
+            description: 'Disallow using root types for `read-only` or `write-only` schemas.',
+            url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/no-root-type.md',
+            requiresSchema: true,
+            examples: [
+                {
+                    title: 'Incorrect (`read-only` schema)',
+                    usage: [{ disallow: ['mutation', 'subscription'] }],
+                    code: /* GraphQL */ `
+            type Mutation {
+              createUser(input: CreateUserInput!): User!
+            }
+          `,
+                },
+                {
+                    title: 'Incorrect (`write-only` schema)',
+                    usage: [{ disallow: ['query'] }],
+                    code: /* GraphQL */ `
+            type Query {
+              users: [User!]!
+            }
+          `,
+                },
+                {
+                    title: 'Correct (`read-only` schema)',
+                    usage: [{ disallow: ['mutation', 'subscription'] }],
+                    code: /* GraphQL */ `
+            type Query {
+              users: [User!]!
+            }
+          `,
+                },
+            ],
+            optionsForConfig: [{ disallow: ['subscription'] }],
+        },
+        schema: {
+            type: 'array',
+            minItems: 1,
+            maxItems: 1,
+            items: {
+                type: 'object',
+                additionalProperties: false,
+                required: ['disallow'],
+                properties: {
+                    disallow: {
+                        type: 'array',
+                        uniqueItems: true,
+                        minItems: 1,
+                        items: {
+                            enum: ROOT_TYPES,
+                        },
+                    },
+                },
+            },
+        },
+    },
+    create(context) {
+        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(),
+        ]
+            .filter(Boolean)
+            .map(type => type.name);
+        if (rootTypeNames.length === 0) {
+            return {};
+        }
+        const selector = [
+            `:matches(${graphql.Kind.OBJECT_TYPE_DEFINITION}, ${graphql.Kind.OBJECT_TYPE_EXTENSION})`,
+            '>',
+            `${graphql.Kind.NAME}[value=/^(${rootTypeNames.join('|')})$/]`,
+        ].join(' ');
+        return {
+            [selector](node) {
+                const typeName = node.value;
+                context.report({
+                    loc: getLocation(node.loc, typeName),
+                    message: `Root type "${typeName}" is forbidden`,
+                });
+            },
+        };
+    },
+};
+
 const UNREACHABLE_TYPE = 'UNREACHABLE_TYPE';
 const RULE_NAME = 'no-unreachable-types';
-const rule$e = {
+const rule$f = {
     meta: {
         messages: {
             [UNREACHABLE_TYPE]: `Type "{{ typeName }}" is unreachable`,
@@ -2143,7 +2235,7 @@ const rule$e = {
 
 const UNUSED_FIELD = 'UNUSED_FIELD';
 const RULE_NAME$1 = 'no-unused-fields';
-const rule$f = {
+const rule$g = {
     meta: {
         messages: {
             [UNUSED_FIELD]: `Field "{{fieldName}}" is unused`,
@@ -2331,7 +2423,7 @@ const MESSAGE_REQUIRE_DATE = 'MESSAGE_REQUIRE_DATE';
 const MESSAGE_INVALID_FORMAT = 'MESSAGE_INVALID_FORMAT';
 const MESSAGE_INVALID_DATE = 'MESSAGE_INVALID_DATE';
 const MESSAGE_CAN_BE_REMOVED = 'MESSAGE_CAN_BE_REMOVED';
-const rule$g = {
+const rule$h = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -2434,7 +2526,7 @@ const rule$g = {
     },
 };
 
-const rule$h = {
+const rule$i = {
     meta: {
         docs: {
             description: `Require all deprecation directives to specify a reason.`,
@@ -2514,7 +2606,7 @@ function verifyRule(context, node) {
         }
     }
 }
-const rule$i = {
+const rule$j = {
     meta: {
         docs: {
             category: 'Best Practices',
@@ -2579,7 +2671,7 @@ const rule$i = {
 };
 
 const RULE_NAME$2 = 'require-field-of-type-query-in-mutation-result';
-const rule$j = {
+const rule$k = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -2747,7 +2839,7 @@ const convertNode = (typeInfo) => (node, key, parent) => {
 
 const REQUIRE_ID_WHEN_AVAILABLE = 'REQUIRE_ID_WHEN_AVAILABLE';
 const DEFAULT_ID_FIELD_NAME = 'id';
-const rule$k = {
+const rule$l = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -2883,7 +2975,7 @@ const rule$k = {
     },
 };
 
-const rule$l = {
+const rule$m = {
     meta: {
         docs: {
             category: 'Best Practices',
@@ -3005,7 +3097,7 @@ const shouldIgnoreNode = ({ node, exceptions }) => {
     }
     return false;
 };
-const rule$m = {
+const rule$n = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -3182,7 +3274,7 @@ const checkNode = (context, node, ruleName, messageId) => {
         });
     }
 };
-const rule$n = {
+const rule$o = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -3241,7 +3333,7 @@ const rule$n = {
 
 const RULE_NAME$4 = 'unique-operation-name';
 const UNIQUE_OPERATION_NAME = 'UNIQUE_OPERATION_NAME';
-const rule$o = {
+const rule$p = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -3321,17 +3413,18 @@ const rules = {
     'no-deprecated': rule$b,
     'no-hashtag-description': rule$c,
     'no-operation-name-suffix': rule$d,
-    'no-unreachable-types': rule$e,
-    'no-unused-fields': rule$f,
-    'require-deprecation-date': rule$g,
-    'require-deprecation-reason': rule$h,
-    'require-description': rule$i,
-    'require-field-of-type-query-in-mutation-result': rule$j,
-    'require-id-when-available': rule$k,
-    'selection-set-depth': rule$l,
-    'strict-id-in-types': rule$m,
-    'unique-fragment-name': rule$n,
-    'unique-operation-name': rule$o,
+    'no-root-type': rule$e,
+    'no-unreachable-types': rule$f,
+    'no-unused-fields': rule$g,
+    'require-deprecation-date': rule$h,
+    'require-deprecation-reason': rule$i,
+    'require-description': rule$j,
+    'require-field-of-type-query-in-mutation-result': rule$k,
+    'require-id-when-available': rule$l,
+    'selection-set-depth': rule$m,
+    'strict-id-in-types': rule$n,
+    'unique-fragment-name': rule$o,
+    'unique-operation-name': rule$p,
 };
 
 const RELEVANT_KEYWORDS = ['gql', 'graphql', '/* GraphQL */'];

package/index.mjs

@@ -85,6 +85,7 @@ const allConfig = {
         '@graphql-eslint/match-document-filename': 'error',
         '@graphql-eslint/no-deprecated': 'error',
         '@graphql-eslint/no-hashtag-description': 'error',
+        '@graphql-eslint/no-root-type': ['error', { disallow: ['subscription'] }],
         '@graphql-eslint/no-unreachable-types': 'error',
         '@graphql-eslint/no-unused-fields': 'error',
         '@graphql-eslint/require-deprecation-date': 'error',
@@ -2059,9 +2060,100 @@ const rule$d = {
     },
 };
 
+const ROOT_TYPES = ['query', 'mutation', 'subscription'];
+const rule$e = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            category: 'Validation',
+            description: 'Disallow using root types for `read-only` or `write-only` schemas.',
+            url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/no-root-type.md',
+            requiresSchema: true,
+            examples: [
+                {
+                    title: 'Incorrect (`read-only` schema)',
+                    usage: [{ disallow: ['mutation', 'subscription'] }],
+                    code: /* GraphQL */ `
+            type Mutation {
+              createUser(input: CreateUserInput!): User!
+            }
+          `,
+                },
+                {
+                    title: 'Incorrect (`write-only` schema)',
+                    usage: [{ disallow: ['query'] }],
+                    code: /* GraphQL */ `
+            type Query {
+              users: [User!]!
+            }
+          `,
+                },
+                {
+                    title: 'Correct (`read-only` schema)',
+                    usage: [{ disallow: ['mutation', 'subscription'] }],
+                    code: /* GraphQL */ `
+            type Query {
+              users: [User!]!
+            }
+          `,
+                },
+            ],
+            optionsForConfig: [{ disallow: ['subscription'] }],
+        },
+        schema: {
+            type: 'array',
+            minItems: 1,
+            maxItems: 1,
+            items: {
+                type: 'object',
+                additionalProperties: false,
+                required: ['disallow'],
+                properties: {
+                    disallow: {
+                        type: 'array',
+                        uniqueItems: true,
+                        minItems: 1,
+                        items: {
+                            enum: ROOT_TYPES,
+                        },
+                    },
+                },
+            },
+        },
+    },
+    create(context) {
+        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(),
+        ]
+            .filter(Boolean)
+            .map(type => type.name);
+        if (rootTypeNames.length === 0) {
+            return {};
+        }
+        const selector = [
+            `:matches(${Kind.OBJECT_TYPE_DEFINITION}, ${Kind.OBJECT_TYPE_EXTENSION})`,
+            '>',
+            `${Kind.NAME}[value=/^(${rootTypeNames.join('|')})$/]`,
+        ].join(' ');
+        return {
+            [selector](node) {
+                const typeName = node.value;
+                context.report({
+                    loc: getLocation(node.loc, typeName),
+                    message: `Root type "${typeName}" is forbidden`,
+                });
+            },
+        };
+    },
+};
+
 const UNREACHABLE_TYPE = 'UNREACHABLE_TYPE';
 const RULE_NAME = 'no-unreachable-types';
-const rule$e = {
+const rule$f = {
     meta: {
         messages: {
             [UNREACHABLE_TYPE]: `Type "{{ typeName }}" is unreachable`,
@@ -2137,7 +2229,7 @@ const rule$e = {
 
 const UNUSED_FIELD = 'UNUSED_FIELD';
 const RULE_NAME$1 = 'no-unused-fields';
-const rule$f = {
+const rule$g = {
     meta: {
         messages: {
             [UNUSED_FIELD]: `Field "{{fieldName}}" is unused`,
@@ -2325,7 +2417,7 @@ const MESSAGE_REQUIRE_DATE = 'MESSAGE_REQUIRE_DATE';
 const MESSAGE_INVALID_FORMAT = 'MESSAGE_INVALID_FORMAT';
 const MESSAGE_INVALID_DATE = 'MESSAGE_INVALID_DATE';
 const MESSAGE_CAN_BE_REMOVED = 'MESSAGE_CAN_BE_REMOVED';
-const rule$g = {
+const rule$h = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -2428,7 +2520,7 @@ const rule$g = {
     },
 };
 
-const rule$h = {
+const rule$i = {
     meta: {
         docs: {
             description: `Require all deprecation directives to specify a reason.`,
@@ -2508,7 +2600,7 @@ function verifyRule(context, node) {
         }
     }
 }
-const rule$i = {
+const rule$j = {
     meta: {
         docs: {
             category: 'Best Practices',
@@ -2573,7 +2665,7 @@ const rule$i = {
 };
 
 const RULE_NAME$2 = 'require-field-of-type-query-in-mutation-result';
-const rule$j = {
+const rule$k = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -2741,7 +2833,7 @@ const convertNode = (typeInfo) => (node, key, parent) => {
 
 const REQUIRE_ID_WHEN_AVAILABLE = 'REQUIRE_ID_WHEN_AVAILABLE';
 const DEFAULT_ID_FIELD_NAME = 'id';
-const rule$k = {
+const rule$l = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -2877,7 +2969,7 @@ const rule$k = {
     },
 };
 
-const rule$l = {
+const rule$m = {
     meta: {
         docs: {
             category: 'Best Practices',
@@ -2999,7 +3091,7 @@ const shouldIgnoreNode = ({ node, exceptions }) => {
     }
     return false;
 };
-const rule$m = {
+const rule$n = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -3176,7 +3268,7 @@ const checkNode = (context, node, ruleName, messageId) => {
         });
     }
 };
-const rule$n = {
+const rule$o = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -3235,7 +3327,7 @@ const rule$n = {
 
 const RULE_NAME$4 = 'unique-operation-name';
 const UNIQUE_OPERATION_NAME = 'UNIQUE_OPERATION_NAME';
-const rule$o = {
+const rule$p = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -3315,17 +3407,18 @@ const rules = {
     'no-deprecated': rule$b,
     'no-hashtag-description': rule$c,
     'no-operation-name-suffix': rule$d,
-    'no-unreachable-types': rule$e,
-    'no-unused-fields': rule$f,
-    'require-deprecation-date': rule$g,
-    'require-deprecation-reason': rule$h,
-    'require-description': rule$i,
-    'require-field-of-type-query-in-mutation-result': rule$j,
-    'require-id-when-available': rule$k,
-    'selection-set-depth': rule$l,
-    'strict-id-in-types': rule$m,
-    'unique-fragment-name': rule$n,
-    'unique-operation-name': rule$o,
+    'no-root-type': rule$e,
+    'no-unreachable-types': rule$f,
+    'no-unused-fields': rule$g,
+    'require-deprecation-date': rule$h,
+    'require-deprecation-reason': rule$i,
+    'require-description': rule$j,
+    'require-field-of-type-query-in-mutation-result': rule$k,
+    'require-id-when-available': rule$l,
+    'selection-set-depth': rule$m,
+    'strict-id-in-types': rule$n,
+    'unique-fragment-name': rule$o,
+    'unique-operation-name': rule$p,
 };
 
 const RELEVANT_KEYWORDS = ['gql', 'graphql', '/* GraphQL */'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "2.5.0-alpha-14532ce.0",
+  "version": "2.5.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

@@ -59,6 +59,9 @@ export declare const rules: {
     'no-deprecated': import("..").GraphQLESLintRule<[], true>;
     'no-hashtag-description': import("..").GraphQLESLintRule<any[], false>;
     'no-operation-name-suffix': import("..").GraphQLESLintRule<any[], false>;
+    'no-root-type': import("..").GraphQLESLintRule<[{
+        disallow: ("subscription" | "query" | "mutation")[];
+    }], false>;
     'no-unreachable-types': import("..").GraphQLESLintRule<any[], false>;
     'no-unused-fields': import("..").GraphQLESLintRule<any[], false>;
     'require-deprecation-date': import("..").GraphQLESLintRule<[{

package/rules/no-root-type.d.ts

@@ -0,0 +1,7 @@
+import { GraphQLESLintRule } from '../types';
+declare const ROOT_TYPES: ('query' | 'mutation' | 'subscription')[];
+declare type NoRootTypeConfig = {
+    disallow: typeof ROOT_TYPES;
+};
+declare const rule: GraphQLESLintRule<[NoRootTypeConfig]>;
+export default rule;

package/testkit.d.ts

@@ -6,7 +6,7 @@ export declare type GraphQLESLintRuleListener<WithTypeInfo extends boolean = fal
     [K in keyof ASTKindToNode]?: (node: GraphQLESTreeNode<ASTKindToNode[K], WithTypeInfo>) => void;
 } & Record<string, any>;
 export declare type GraphQLValidTestCase<Options> = Omit<RuleTester.ValidTestCase, 'options' | 'parserOptions'> & {
-    name: string;
+    name?: string;
     options?: Options;
     parserOptions?: ParserOptions;
 };