@graphql-eslint/eslint-plugin 3.13.1-alpha-20221105010933-2b1e7ee → 3.13.1

package/docs/rules/no-hashtag-description.md

@@ -0,0 +1,59 @@
+# `no-hashtag-description`
+
+✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
+
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
+- Category: `Schema`
+- Rule name: `@graphql-eslint/no-hashtag-description`
+- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Requires to use `"""` or `"` for adding a GraphQL description instead of `#`.
+Allows to use hashtag for comments, as long as it's not attached to an AST definition.
+
+## Usage Examples
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/no-hashtag-description: 'error'
+
+# Represents a user
+type User {
+  id: ID!
+  name: String
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/no-hashtag-description: 'error'
+
+" Represents a user "
+type User {
+  id: ID!
+  name: String
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/no-hashtag-description: 'error'
+
+# This file defines the basic User type.
+# This comment is valid because it's not attached specifically to an AST object.
+
+" Represents a user "
+type User {
+  id: ID! # This one is also valid, since it comes after the AST object
+  name: String
+}
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/no-hashtag-description.ts)
+- [Test source](../../packages/plugin/tests/no-hashtag-description.spec.ts)

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

@@ -0,0 +1,53 @@
+# `no-root-type`
+
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
+- Category: `Schema`
+- 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 `mutation` and/or `subscription`.
+
+## Usage Examples
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/no-root-type: ['error', { disallow: ['mutation', 'subscription'] }]
+
+type Mutation {
+  createUser(input: CreateUserInput!): User!
+}
+```
+
+### Correct
+
+```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)
+
+The elements of the array can contain the following enum values:
+
+- `mutation`
+- `subscription`
+
+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/docs/rules/no-scalar-result-type-on-mutation.md

@@ -0,0 +1,37 @@
+# `no-scalar-result-type-on-mutation`
+
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
+- Category: `Schema`
+- Rule name: `@graphql-eslint/no-scalar-result-type-on-mutation`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Avoid scalar result type on mutation type to make sure to return a valid state.
+
+## Usage Examples
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/no-scalar-result-type-on-mutation: 'error'
+
+type Mutation {
+  createUser: Boolean
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/no-scalar-result-type-on-mutation: 'error'
+
+type Mutation {
+  createUser: User!
+}
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/no-scalar-result-type-on-mutation.ts)
+- [Test source](../../packages/plugin/tests/no-scalar-result-type-on-mutation.spec.ts)

package/docs/rules/no-typename-prefix.md

@@ -0,0 +1,39 @@
+# `no-typename-prefix`
+
+✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
+
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
+- Category: `Schema`
+- Rule name: `@graphql-eslint/no-typename-prefix`
+- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Enforces users to avoid using the type name in a field name while defining your schema.
+
+## Usage Examples
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/no-typename-prefix: 'error'
+
+type User {
+  userId: ID!
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/no-typename-prefix: 'error'
+
+type User {
+  id: ID!
+}
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/no-typename-prefix.ts)
+- [Test source](../../packages/plugin/tests/no-typename-prefix.spec.ts)

package/docs/rules/no-undefined-variables.md

@@ -0,0 +1,17 @@
+# `no-undefined-variables`
+
+✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
+
+- Category: `Operations`
+- Rule name: `@graphql-eslint/no-undefined-variables`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+A GraphQL operation is only valid if all variables encountered, both directly and via fragment spreads, are defined by that operation.
+
+> This rule is a wrapper around a `graphql-js` validation function.
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/NoUndefinedVariablesRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/NoUndefinedVariablesRule-test.ts)

package/docs/rules/no-unreachable-types.md

@@ -0,0 +1,49 @@
+# `no-unreachable-types`
+
+✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
+
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
+- Category: `Schema`
+- Rule name: `@graphql-eslint/no-unreachable-types`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Requires all types to be reachable at some level by root level fields.
+
+## Usage Examples
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/no-unreachable-types: 'error'
+
+type User {
+  id: ID!
+  name: String
+}
+
+type Query {
+  me: String
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/no-unreachable-types: 'error'
+
+type User {
+  id: ID!
+  name: String
+}
+
+type Query {
+  me: User
+}
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/no-unreachable-types.ts)
+- [Test source](../../packages/plugin/tests/no-unreachable-types.spec.ts)

package/docs/rules/no-unused-fields.md

@@ -0,0 +1,62 @@
+# `no-unused-fields`
+
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
+- Category: `Schema`
+- Rule name: `@graphql-eslint/no-unused-fields`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Requires all fields to be used at some level by siblings operations.
+
+## Usage Examples
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/no-unused-fields: 'error'
+
+type User {
+  id: ID!
+  name: String
+  someUnusedField: String
+}
+
+type Query {
+  me: User
+}
+
+query {
+  me {
+    id
+    name
+  }
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/no-unused-fields: 'error'
+
+type User {
+  id: ID!
+  name: String
+}
+
+type Query {
+  me: User
+}
+
+query {
+  me {
+    id
+    name
+  }
+}
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/no-unused-fields.ts)
+- [Test source](../../packages/plugin/tests/no-unused-fields.spec.ts)

package/docs/rules/no-unused-fragments.md

@@ -0,0 +1,17 @@
+# `no-unused-fragments`
+
+✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
+
+- Category: `Operations`
+- Rule name: `@graphql-eslint/no-unused-fragments`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+A GraphQL document is only valid if all fragment definitions are spread within operations, or spread within other fragments spread within operations.
+
+> This rule is a wrapper around a `graphql-js` validation function.
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/NoUnusedFragmentsRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/NoUnusedFragmentsRule-test.ts)

package/docs/rules/no-unused-variables.md

@@ -0,0 +1,17 @@
+# `no-unused-variables`
+
+✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
+
+- Category: `Operations`
+- Rule name: `@graphql-eslint/no-unused-variables`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+A GraphQL operation is only valid if all variables defined by an operation are used, either directly or within a spread fragment.
+
+> This rule is a wrapper around a `graphql-js` validation function.
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/NoUnusedVariablesRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/NoUnusedVariablesRule-test.ts)

package/docs/rules/one-field-subscriptions.md

@@ -0,0 +1,17 @@
+# `one-field-subscriptions`
+
+✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
+
+- Category: `Operations`
+- Rule name: `@graphql-eslint/one-field-subscriptions`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+A GraphQL subscription is valid only if it contains a single root field.
+
+> This rule is a wrapper around a `graphql-js` validation function.
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/SingleFieldSubscriptionsRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/SingleFieldSubscriptionsRule-test.ts)

package/docs/rules/overlapping-fields-can-be-merged.md

@@ -0,0 +1,17 @@
+# `overlapping-fields-can-be-merged`
+
+✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
+
+- Category: `Operations`
+- Rule name: `@graphql-eslint/overlapping-fields-can-be-merged`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+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.
+
+> This rule is a wrapper around a `graphql-js` validation function.
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/OverlappingFieldsCanBeMergedRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/OverlappingFieldsCanBeMergedRule-test.ts)

package/docs/rules/possible-fragment-spread.md

@@ -0,0 +1,17 @@
+# `possible-fragment-spread`
+
+✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
+
+- Category: `Operations`
+- Rule name: `@graphql-eslint/possible-fragment-spread`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+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.
+
+> This rule is a wrapper around a `graphql-js` validation function.
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/PossibleFragmentSpreadsRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/PossibleFragmentSpreadsRule-test.ts)

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

@@ -0,0 +1,15 @@
+# `possible-type-extension`
+
+- Category: `Schema`
+- Rule name: `@graphql-eslint/possible-type-extension`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+A type extension is only valid if the type is defined and has the same kind.
+
+> This rule is a wrapper around a `graphql-js` validation function.
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/PossibleTypeExtensionsRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/PossibleTypeExtensionsRule-test.ts)

package/docs/rules/provided-required-arguments.md

@@ -0,0 +1,17 @@
+# `provided-required-arguments`
+
+✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` and `"plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
+
+- Category: `Schema & Operations`
+- Rule name: `@graphql-eslint/provided-required-arguments`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.
+
+> This rule is a wrapper around a `graphql-js` validation function.
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/ProvidedRequiredArgumentsRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/ProvidedRequiredArgumentsRule-test.ts)

package/docs/rules/relay-arguments.md

@@ -0,0 +1,57 @@
+# `relay-arguments`
+
+- Category: `Schema`
+- Rule name: `@graphql-eslint/relay-arguments`
+- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Set of rules to follow Relay specification for Arguments.
+
+- A field that returns a Connection type must include forward pagination arguments (`first` and `after`), backward pagination arguments (`last` and `before`), or both
+
+Forward pagination arguments
+
+- `first` takes a non-negative integer
+- `after` takes the Cursor type
+
+Backward pagination arguments
+
+- `last` takes a non-negative integer
+- `before` takes the Cursor type
+
+## Usage Examples
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/relay-arguments: 'error'
+
+type User {
+  posts: PostConnection
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/relay-arguments: 'error'
+
+type User {
+  posts(after: String, first: Int, before: String, last: Int): PostConnection
+}
+```
+
+## Config Schema
+
+The schema defines the following properties:
+
+### `includeBoth` (boolean)
+
+Enforce including both forward and backward pagination arguments
+
+Default: `true`
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/relay-arguments.ts)
+- [Test source](../../packages/plugin/tests/relay-arguments.spec.ts)

package/docs/rules/relay-connection-types.md

@@ -0,0 +1,42 @@
+# `relay-connection-types`
+
+- Category: `Schema`
+- Rule name: `@graphql-eslint/relay-connection-types`
+- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Set of rules to follow Relay specification for Connection types.
+
+- Any type whose name ends in "Connection" is considered by spec to be a `Connection type`
+- Connection type must be an Object type
+- Connection type must contain a field `edges` that return a list type that wraps an edge type
+- Connection type must contain a field `pageInfo` that return a non-null `PageInfo` Object type
+
+## Usage Examples
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/relay-connection-types: 'error'
+
+type UserPayload { # should be an Object type with `Connection` suffix
+  edges: UserEdge! # should return a list type
+  pageInfo: PageInfo # should return a non-null `PageInfo` Object type
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/relay-connection-types: 'error'
+
+type UserConnection {
+  edges: [UserEdge]
+  pageInfo: PageInfo!
+}
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/relay-connection-types.ts)
+- [Test source](../../packages/plugin/tests/relay-connection-types.spec.ts)

package/docs/rules/relay-edge-types.md

@@ -0,0 +1,56 @@
+# `relay-edge-types`
+
+- Category: `Schema`
+- Rule name: `@graphql-eslint/relay-edge-types`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Set of rules to follow Relay specification for Edge types.
+
+- A type that is returned in list form by a connection type's `edges` field is considered by this spec to be an Edge type
+- Edge type must be an Object type
+- Edge type must contain a field `node` that return either Scalar, Enum, Object, Interface, Union, or a non-null wrapper around one of those types. Notably, this field cannot return a list
+- Edge type must contain a field `cursor` that return either String, Scalar, or a non-null wrapper around one of those types
+- Edge type name must end in "Edge" _(optional)_
+- Edge type's field `node` must implement `Node` interface _(optional)_
+- A list type should only wrap an edge type _(optional)_
+
+## Usage Examples
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/relay-edge-types: 'error'
+
+type UserConnection {
+  edges: [UserEdge]
+  pageInfo: PageInfo!
+}
+```
+
+## Config Schema
+
+The schema defines the following properties:
+
+### `withEdgeSuffix` (boolean)
+
+Edge type name must end in "Edge".
+
+Default: `true`
+
+### `shouldImplementNode` (boolean)
+
+Edge type's field `node` must implement `Node` interface.
+
+Default: `true`
+
+### `listTypeCanWrapOnlyEdgeType` (boolean)
+
+A list type should only wrap an edge type.
+
+Default: `true`
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/relay-edge-types.ts)
+- [Test source](../../packages/plugin/tests/relay-edge-types.spec.ts)

package/docs/rules/relay-page-info.md

@@ -0,0 +1,32 @@
+# `relay-page-info`
+
+- Category: `Schema`
+- Rule name: `@graphql-eslint/relay-page-info`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Set of rules to follow Relay specification for `PageInfo` object.
+
+- `PageInfo` must be an Object type
+- `PageInfo` must contain fields `hasPreviousPage` and `hasNextPage`, that return non-null Boolean
+- `PageInfo` must contain fields `startCursor` and `endCursor`, that return either String or Scalar, which can be null if there are no results
+
+## Usage Examples
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/relay-page-info: 'error'
+
+type PageInfo {
+  hasPreviousPage: Boolean!
+  hasNextPage: Boolean!
+  startCursor: String
+  endCursor: String
+}
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/relay-page-info.ts)
+- [Test source](../../packages/plugin/tests/relay-page-info.spec.ts)