@graphql-eslint/eslint-plugin 3.14.4-alpha-20230111221804-f30b422 → 3.14.4-alpha-20230111225020-02d9c28

package/docs/rules/relay-arguments.md

@@ -1,59 +0,0 @@
-# `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

@@ -1,43 +0,0 @@
-# `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

@@ -1,60 +0,0 @@
-# `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

@@ -1,34 +0,0 @@
-# `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)

package/docs/rules/require-deprecation-date.md

@@ -1,59 +0,0 @@
-# `require-deprecation-date`
-
-💡 This rule provides
-[suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
-
-- Category: `Schema`
-- Rule name: `@graphql-eslint/require-deprecation-date`
-- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
-- Requires GraphQL Operations: `false`
-  [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
-
-Require deletion date on `@deprecated` directive. Suggest removing deprecated things after
-deprecated date.
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/require-deprecation-date: 'error'
-
-type User {
-  firstname: String @deprecated
-  firstName: String
-}
-```
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/require-deprecation-date: 'error'
-
-type User {
-  firstname: String @deprecated(reason: "Use 'firstName' instead")
-  firstName: String
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/require-deprecation-date: 'error'
-
-type User {
-  firstname: String @deprecated(reason: "Use 'firstName' instead", deletionDate: "25/12/2022")
-  firstName: String
-}
-```
-
-## Config Schema
-
-The schema defines the following properties:
-
-### `argumentName` (string)
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/require-deprecation-date.ts)
-- [Test source](../../packages/plugin/tests/require-deprecation-date.spec.ts)

package/docs/rules/require-deprecation-reason.md

@@ -1,49 +0,0 @@
-# `require-deprecation-reason`
-
-✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file
-enables this rule.
-
-- Category: `Schema`
-- Rule name: `@graphql-eslint/require-deprecation-reason`
-- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
-- Requires GraphQL Operations: `false`
-  [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
-
-Require all deprecation directives to specify a reason.
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/require-deprecation-reason: 'error'
-
-type MyType {
-  name: String @deprecated
-}
-```
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/require-deprecation-reason: 'error'
-
-type MyType {
-  name: String @deprecated(reason: "")
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/require-deprecation-reason: 'error'
-
-type MyType {
-  name: String @deprecated(reason: "no longer relevant, please use fullName field")
-}
-```
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/require-deprecation-reason.ts)
-- [Test source](../../packages/plugin/tests/require-deprecation-reason.spec.ts)

package/docs/rules/require-description.md

@@ -1,147 +0,0 @@
-# `require-description`
-
-✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file
-enables this rule.
-
-- Category: `Schema`
-- Rule name: `@graphql-eslint/require-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)
-
-Enforce descriptions in type definitions and operations.
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/require-description: ['error', { types: true, FieldDefinition: true }]
-
-type someTypeName {
-  name: String
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/require-description: ['error', { types: true, FieldDefinition: true }]
-
-"""
-Some type description
-"""
-type someTypeName {
-  """
-  Name description
-  """
-  name: String
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/require-description: ['error', { OperationDefinition: true }]
-
-# Create a new user
-mutation createUser {
-  # ...
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/require-description: ['error', { rootField: true }]
-
-type Mutation {
-  "Create a new user"
-  createUser: User
-}
-
-type User {
-  name: String
-}
-```
-
-## Config Schema
-
-The schema defines the following properties:
-
-### `types` (boolean)
-
-Includes:
-
-- `ObjectTypeDefinition`
-- `InterfaceTypeDefinition`
-- `EnumTypeDefinition`
-- `ScalarTypeDefinition`
-- `InputObjectTypeDefinition`
-- `UnionTypeDefinition`
-
-### `rootField` (boolean)
-
-Definitions within `Query`, `Mutation`, and `Subscription` root types.
-
-### `DirectiveDefinition` (boolean)
-
-Read more about this kind on
-[spec.graphql.org](https://spec.graphql.org/October2021/#DirectiveDefinition).
-
-### `EnumTypeDefinition` (boolean)
-
-Read more about this kind on
-[spec.graphql.org](https://spec.graphql.org/October2021/#EnumTypeDefinition).
-
-### `EnumValueDefinition` (boolean)
-
-Read more about this kind on
-[spec.graphql.org](https://spec.graphql.org/October2021/#EnumValueDefinition).
-
-### `FieldDefinition` (boolean)
-
-Read more about this kind on
-[spec.graphql.org](https://spec.graphql.org/October2021/#FieldDefinition).
-
-### `InputObjectTypeDefinition` (boolean)
-
-Read more about this kind on
-[spec.graphql.org](https://spec.graphql.org/October2021/#InputObjectTypeDefinition).
-
-### `InputValueDefinition` (boolean)
-
-Read more about this kind on
-[spec.graphql.org](https://spec.graphql.org/October2021/#InputValueDefinition).
-
-### `InterfaceTypeDefinition` (boolean)
-
-Read more about this kind on
-[spec.graphql.org](https://spec.graphql.org/October2021/#InterfaceTypeDefinition).
-
-### `ObjectTypeDefinition` (boolean)
-
-Read more about this kind on
-[spec.graphql.org](https://spec.graphql.org/October2021/#ObjectTypeDefinition).
-
-### `OperationDefinition` (boolean)
-
-Read more about this kind on
-[spec.graphql.org](https://spec.graphql.org/October2021/#OperationDefinition).
-
-> You must use only comment syntax `#` and not description syntax `"""` or `"`.
-
-### `ScalarTypeDefinition` (boolean)
-
-Read more about this kind on
-[spec.graphql.org](https://spec.graphql.org/October2021/#ScalarTypeDefinition).
-
-### `UnionTypeDefinition` (boolean)
-
-Read more about this kind on
-[spec.graphql.org](https://spec.graphql.org/October2021/#UnionTypeDefinition).
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/require-description.ts)
-- [Test source](../../packages/plugin/tests/require-description.spec.ts)

package/docs/rules/require-field-of-type-query-in-mutation-result.md

@@ -1,50 +0,0 @@
-# `require-field-of-type-query-in-mutation-result`
-
-- Category: `Schema`
-- Rule name: `@graphql-eslint/require-field-of-type-query-in-mutation-result`
-- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
-- Requires GraphQL Operations: `false`
-  [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
-
-Allow the client in one round-trip not only to call mutation but also to get a wagon of data to
-update their application.
-
-> Currently, no errors are reported for result type `union`, `interface` and `scalar`.
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/require-field-of-type-query-in-mutation-result: 'error'
-
-type User { ... }
-
-type Mutation {
-  createUser: User!
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/require-field-of-type-query-in-mutation-result: 'error'
-
-type User { ... }
-
-type Query { ... }
-
-type CreateUserPayload {
-  user: User!
-  query: Query!
-}
-
-type Mutation {
-  createUser: CreateUserPayload!
-}
-```
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/require-field-of-type-query-in-mutation-result.ts)
-- [Test source](../../packages/plugin/tests/require-field-of-type-query-in-mutation-result.spec.ts)

package/docs/rules/require-id-when-available.md

@@ -1,91 +0,0 @@
-# `require-id-when-available`
-
-✅ The `"extends": "plugin:@graphql-eslint/operations-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: `Operations`
-- Rule name: `@graphql-eslint/require-id-when-available`
-- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
-- Requires GraphQL Operations: `true`
-  [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
-
-Enforce selecting specific fields when they are available on the GraphQL type.
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/require-id-when-available: 'error'
-
-# In your schema
-type User {
-  id: ID!
-  name: String!
-}
-
-# Query
-query {
-  user {
-    name
-  }
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/require-id-when-available: 'error'
-
-# In your schema
-type User {
-  id: ID!
-  name: String!
-}
-
-# Query
-query {
-  user {
-    id
-    name
-  }
-}
-
-# Selecting `id` with an alias is also valid
-query {
-  user {
-    id: name
-  }
-}
-```
-
-## Config Schema
-
-The schema defines the following properties:
-
-### `fieldName`
-
-The object must be one of the following types:
-
-- `asString`
-- `asArray`
-
-Default: `"id"`
-
----
-
-# Sub Schemas
-
-The schema defines the following additional types:
-
-## `asString` (string)
-
-## `asArray` (array)
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/require-id-when-available.ts)
-- [Test source](../../packages/plugin/tests/require-id-when-available.spec.ts)

package/docs/rules/require-nullable-fields-with-oneof.md

@@ -1,38 +0,0 @@
-# `require-nullable-fields-with-oneof`
-
-- Category: `Schema`
-- Rule name: `@graphql-eslint/require-nullable-fields-with-oneof`
-- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
-- Requires GraphQL Operations: `false`
-  [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
-
-Require `input` or `type` fields to be non-nullable with `@oneOf` directive.
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/require-nullable-fields-with-oneof: 'error'
-
-input Input @oneOf {
-  foo: String!
-  b: Int
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/require-nullable-fields-with-oneof: 'error'
-
-input Input @oneOf {
-  foo: String
-  bar: Int
-}
-```
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/require-nullable-fields-with-oneof.ts)
-- [Test source](../../packages/plugin/tests/require-nullable-fields-with-oneof.spec.ts)

package/docs/rules/require-type-pattern-with-oneof.md

@@ -1,39 +0,0 @@
-# `require-type-pattern-with-oneof`
-
-- Category: `Schema`
-- Rule name: `@graphql-eslint/require-type-pattern-with-oneof`
-- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
-- Requires GraphQL Operations: `false`
-  [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
-
-Enforce types with `@oneOf` directive have `error` and `ok` fields.
-
-## Usage Examples
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/require-type-pattern-with-oneof: 'error'
-
-type Mutation {
-  doSomething: DoSomethingMutationResult!
-}
-
-interface Error {
-  message: String!
-}
-
-type DoSomethingMutationResult @oneOf {
-  ok: DoSomethingSuccess
-  error: Error
-}
-
-type DoSomethingSuccess {
-  # ...
-}
-```
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/require-type-pattern-with-oneof.ts)
-- [Test source](../../packages/plugin/tests/require-type-pattern-with-oneof.spec.ts)

package/docs/rules/scalar-leafs.md

@@ -1,23 +0,0 @@
-# `scalar-leafs`
-
-✅ The `"extends": "plugin:@graphql-eslint/operations-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: `Operations`
-- Rule name: `@graphql-eslint/scalar-leafs`
-- 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 document is valid only if all leaf fields (fields without sub selections) are of scalar or
-enum types.
-
-> 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/ScalarLeafsRule.ts)
-- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/ScalarLeafsRule-test.ts)