@graphql-eslint/eslint-plugin 3.14.4-alpha-20230111223410-a558ee8 → 3.14.4-alpha-20230111225020-02d9c28

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)

package/docs/rules/selection-set-depth.md

@@ -1,86 +0,0 @@
-# `selection-set-depth`
-
-✅ 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/selection-set-depth`
-- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
-- Requires GraphQL Operations: `true`
-  [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
-
-Limit the complexity of the GraphQL operations solely by their depth. Based on
-[graphql-depth-limit](https://npmjs.com/package/graphql-depth-limit).
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/selection-set-depth: ['error', { maxDepth: 1 }]
-
-query deep2 {
-  viewer {
-    # Level 0
-    albums {
-      # Level 1
-      title # Level 2
-    }
-  }
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/selection-set-depth: ['error', { maxDepth: 4 }]
-
-query deep2 {
-  viewer {
-    # Level 0
-    albums {
-      # Level 1
-      title # Level 2
-    }
-  }
-}
-```
-
-### Correct (ignored field)
-
-```graphql
-# eslint @graphql-eslint/selection-set-depth: ['error', { maxDepth: 1, ignore: ['albums'] }]
-
-query deep2 {
-  viewer {
-    # Level 0
-    albums {
-      # Level 1
-      title # Level 2
-    }
-  }
-}
-```
-
-## Config Schema
-
-The schema defines the following properties:
-
-### `maxDepth` (number, required)
-
-### `ignore` (array)
-
-The object is an array with all elements of the type `string`.
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/selection-set-depth.ts)
-- [Test source](../../packages/plugin/tests/selection-set-depth.spec.ts)

package/docs/rules/strict-id-in-types.md

@@ -1,129 +0,0 @@
-# `strict-id-in-types`
-
-✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file
-enables this rule.
-
-- Category: `Schema`
-- Rule name: `@graphql-eslint/strict-id-in-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 output types to have one unique identifier unless they do not have a logical one.
-Exceptions can be used to ignore output types that do not have unique identifiers.
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/strict-id-in-types: ['error', { acceptedIdNames: ['id', '_id'], acceptedIdTypes: ['ID'], exceptions: { suffixes: ['Payload'] } }]
-
-# Incorrect field name
-type InvalidFieldName {
-  key: ID!
-}
-
-# Incorrect field type
-type InvalidFieldType {
-  id: String!
-}
-
-# Incorrect exception suffix
-type InvalidSuffixResult {
-  data: String!
-}
-
-# Too many unique identifiers. Must only contain one.
-type InvalidFieldName {
-  id: ID!
-  _id: ID!
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/strict-id-in-types: ['error', { acceptedIdNames: ['id', '_id'], acceptedIdTypes: ['ID'], exceptions: { types: ['Error'], suffixes: ['Payload'] } }]
-
-type User {
-  id: ID!
-}
-
-type Post {
-  _id: ID!
-}
-
-type CreateUserPayload {
-  data: String!
-}
-
-type Error {
-  message: String!
-}
-```
-
-## Config Schema
-
-The schema defines the following properties:
-
-### `acceptedIdNames` (array)
-
-The object is an array with all elements of the type `string`.
-
-Default:
-
-```json
-["id"]
-```
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-### `acceptedIdTypes` (array)
-
-The object is an array with all elements of the type `string`.
-
-Default:
-
-```json
-["ID"]
-```
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-### `exceptions` (object)
-
-Properties of the `exceptions` object:
-
-#### `types` (array)
-
-This is used to exclude types with names that match one of the specified values.
-
-The object is an array with all elements of the type `string`.
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-#### `suffixes` (array)
-
-This is used to exclude types with names with suffixes that match one of the specified values.
-
-The object is an array with all elements of the type `string`.
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/strict-id-in-types.ts)
-- [Test source](../../packages/plugin/tests/strict-id-in-types.spec.ts)

package/docs/rules/unique-argument-names.md

@@ -1,19 +0,0 @@
-# `unique-argument-names`
-
-✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file
-enables this rule.
-
-- Category: `Operations`
-- Rule name: `@graphql-eslint/unique-argument-names`
-- 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 field or directive is only valid if all supplied arguments are uniquely named.
-
-> 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/UniqueArgumentNamesRule.ts)
-- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/UniqueArgumentNamesRule-test.ts)

package/docs/rules/unique-directive-names-per-location.md

@@ -1,21 +0,0 @@
-# `unique-directive-names-per-location`
-
-✅ 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/unique-directive-names-per-location`
-- 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 only valid if all non-repeatable directives at a given location are uniquely
-named.
-
-> 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/UniqueDirectivesPerLocationRule.ts)
-- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/UniqueDirectivesPerLocationRule-test.ts)