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

package/docs/rules/alphabetize.md

@@ -1,194 +0,0 @@
-# `alphabetize`
-
-🔧 The `--fix` option on the
-[command line](https://eslint.org/docs/user-guide/command-line-interface#--fix) can automatically
-fix some of the problems reported by this rule.
-
-- Category: `Schema & Operations`
-- Rule name: `@graphql-eslint/alphabetize`
-- 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 arrange in alphabetical order for type fields, enum values, input object fields, operation
-selections and more.
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/alphabetize: ['error', { fields: ['ObjectTypeDefinition'] }]
-
-type User {
-  password: String
-  firstName: String! # should be before "password"
-  age: Int # should be before "firstName"
-  lastName: String!
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/alphabetize: ['error', { fields: ['ObjectTypeDefinition'] }]
-
-type User {
-  age: Int
-  firstName: String!
-  lastName: String!
-  password: String
-}
-```
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/alphabetize: ['error', { values: ['EnumTypeDefinition'] }]
-
-enum Role {
-  SUPER_ADMIN
-  ADMIN # should be before "SUPER_ADMIN"
-  USER
-  GOD # should be before "USER"
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/alphabetize: ['error', { values: ['EnumTypeDefinition'] }]
-
-enum Role {
-  ADMIN
-  GOD
-  SUPER_ADMIN
-  USER
-}
-```
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/alphabetize: ['error', { selections: ['OperationDefinition'] }]
-
-query {
-  me {
-    firstName
-    lastName
-    email # should be before "lastName"
-  }
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/alphabetize: ['error', { selections: ['OperationDefinition'] }]
-
-query {
-  me {
-    email
-    firstName
-    lastName
-  }
-}
-```
-
-## Config Schema
-
-The schema defines the following properties:
-
-### `fields` (array)
-
-Fields of `type`, `interface`, and `input`.
-
-The elements of the array can contain the following enum values:
-
-- `ObjectTypeDefinition`
-- `InterfaceTypeDefinition`
-- `InputObjectTypeDefinition`
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-### `values` (array)
-
-Values of `enum`.
-
-The elements of the array can contain the following enum values:
-
-- `EnumTypeDefinition`
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-### `selections` (array)
-
-Selections of `fragment` and operations `query`, `mutation` and `subscription`.
-
-The elements of the array can contain the following enum values:
-
-- `OperationDefinition`
-- `FragmentDefinition`
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-### `variables` (array)
-
-Variables of operations `query`, `mutation` and `subscription`.
-
-The elements of the array can contain the following enum values:
-
-- `OperationDefinition`
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-### `arguments` (array)
-
-Arguments of fields and directives.
-
-The elements of the array can contain the following enum values:
-
-- `FieldDefinition`
-- `Field`
-- `DirectiveDefinition`
-- `Directive`
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-### `definitions` (boolean)
-
-Definitions – `type`, `interface`, `enum`, `scalar`, `input`, `union` and `directive`.
-
-Default: `false`
-
-### `groups` (array)
-
-Custom order group. Example: `['id', '*', 'createdAt', 'updatedAt']` where `*` says for everything
-else.
-
-The object is an array with all elements of the type `string`.
-
-Additional restrictions:
-
-- Minimum items: `2`
-- Unique items: `true`
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/alphabetize.ts)
-- [Test source](../../packages/plugin/tests/alphabetize.spec.ts)

package/docs/rules/description-style.md

@@ -1,57 +0,0 @@
-# `description-style`
-
-✅ 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/description-style`
-- 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 comments to follow the same style (either block or inline).
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/description-style: ['error', { style: 'inline' }]
-
-""" Description """
-type someTypeName {
-  # ...
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/description-style: ['error', { style: 'inline' }]
-
-" Description "
-type someTypeName {
-  # ...
-}
-```
-
-## Config Schema
-
-The schema defines the following properties:
-
-### `style` (enum)
-
-This element must be one of the following enum values:
-
-- `block`
-- `inline`
-
-Default: `"block"`
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/description-style.ts)
-- [Test source](../../packages/plugin/tests/description-style.spec.ts)

package/docs/rules/executable-definitions.md

@@ -1,20 +0,0 @@
-# `executable-definitions`
-
-✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file
-enables this rule.
-
-- Category: `Operations`
-- Rule name: `@graphql-eslint/executable-definitions`
-- 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 for execution if all definitions are either operation or fragment
-definitions.
-
-> 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/ExecutableDefinitionsRule.ts)
-- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/ExecutableDefinitionsRule-test.ts)

package/docs/rules/fields-on-correct-type.md

@@ -1,23 +0,0 @@
-# `fields-on-correct-type`
-
-✅ 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/fields-on-correct-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)
-
-A GraphQL document is only valid if all fields selected are defined by the parent type, or are an
-allowed meta field such as `__typename`.
-
-> 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/FieldsOnCorrectTypeRule.ts)
-- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/FieldsOnCorrectTypeRule-test.ts)

package/docs/rules/fragments-on-composite-type.md

@@ -1,20 +0,0 @@
-# `fragments-on-composite-type`
-
-✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file
-enables this rule.
-
-- Category: `Operations`
-- Rule name: `@graphql-eslint/fragments-on-composite-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)
-
-Fragments use a type condition to determine if they apply, since fragments can only be spread into a
-composite type (object, interface, or union), the type condition must also be a composite type.
-
-> 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/FragmentsOnCompositeTypesRule.ts)
-- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/FragmentsOnCompositeTypesRule-test.ts)

package/docs/rules/input-name.md

@@ -1,80 +0,0 @@
-# `input-name`
-
-💡 This rule provides
-[suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
-
-- Category: `Schema`
-- Rule name: `@graphql-eslint/input-name`
-- 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 mutation argument to be always called "input" and input type to be called Mutation name +
-"Input". Using the same name for all input parameters will make your schemas easier to consume and
-more predictable. Using the same name as mutation for InputType will make it easier to find
-mutations that InputType belongs to.
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/input-name: ['error', { checkInputType: true }]
-
-type Mutation {
-  SetMessage(message: InputMessage): String
-}
-```
-
-### Correct (with checkInputType)
-
-```graphql
-# eslint @graphql-eslint/input-name: ['error', { checkInputType: true }]
-
-type Mutation {
-  SetMessage(input: SetMessageInput): String
-}
-```
-
-### Correct (without checkInputType)
-
-```graphql
-# eslint @graphql-eslint/input-name: ['error', { checkInputType: false }]
-
-type Mutation {
-  SetMessage(input: AnyInputTypeName): String
-}
-```
-
-## Config Schema
-
-The schema defines the following properties:
-
-### `checkInputType` (boolean)
-
-Check that the input type name follows the convention <mutationName>Input
-
-Default: `false`
-
-### `caseSensitiveInputType` (boolean)
-
-Allow for case discrepancies in the input type name
-
-Default: `true`
-
-### `checkQueries` (boolean)
-
-Apply the rule to Queries
-
-Default: `false`
-
-### `checkMutations` (boolean)
-
-Apply the rule to Mutations
-
-Default: `true`
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/input-name.ts)
-- [Test source](../../packages/plugin/tests/input-name.spec.ts)

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

@@ -1,23 +0,0 @@
-# `known-argument-names`
-
-✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` and
-`"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: `Schema & Operations`
-- Rule name: `@graphql-eslint/known-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 is only valid if all supplied arguments are defined by that 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/KnownArgumentNamesRule.ts)
-- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/KnownArgumentNamesRule-test.ts)

package/docs/rules/known-directives.md

@@ -1,48 +0,0 @@
-# `known-directives`
-
-✅ 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/known-directives`
-- 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 `@directive`s are known by the schema and legally
-positioned.
-
-> This rule is a wrapper around a `graphql-js` validation function.
-
-## Usage Examples
-
-### Valid
-
-```graphql
-# eslint @graphql-eslint/known-directives: ['error', { ignoreClientDirectives: ['client'] }]
-
-{
-  product {
-    someClientField @client
-  }
-}
-```
-
-## Config Schema
-
-The schema defines the following properties:
-
-### `ignoreClientDirectives` (array, required)
-
-The object is an array with all elements of the type `string`.
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-## Resources
-
-- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownDirectivesRule.ts)
-- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/KnownDirectivesRule-test.ts)

package/docs/rules/known-fragment-names.md

@@ -1,72 +0,0 @@
-# `known-fragment-names`
-
-✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file
-enables this rule.
-
-- Category: `Operations`
-- Rule name: `@graphql-eslint/known-fragment-names`
-- 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` fragment spreads refer to fragments defined in
-the same document.
-
-> This rule is a wrapper around a `graphql-js` validation function.
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/known-fragment-names: 'error'
-
-query {
-  user {
-    id
-    ...UserFields # fragment not defined in the document
-  }
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/known-fragment-names: 'error'
-
-fragment UserFields on User {
-  firstName
-  lastName
-}
-
-query {
-  user {
-    id
-    ...UserFields
-  }
-}
-```
-
-### Correct (`UserFields` fragment located in a separate file)
-
-```graphql
-# eslint @graphql-eslint/known-fragment-names: 'error'
-
-# user.gql
-query {
-  user {
-    id
-    ...UserFields
-  }
-}
-
-# user-fields.gql
-fragment UserFields on User {
-  id
-}
-```
-
-## Resources
-
-- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownFragmentNamesRule.ts)
-- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/KnownFragmentNamesRule-test.ts)

package/docs/rules/known-type-names.md

@@ -1,24 +0,0 @@
-# `known-type-names`
-
-✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` and
-`"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: `Schema & Operations`
-- Rule name: `@graphql-eslint/known-type-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 document is only valid if referenced types (specifically variable definitions and fragment
-conditions) are defined by the type schema.
-
-> 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/KnownTypeNamesRule.ts)
-- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/KnownTypeNamesRule-test.ts)

package/docs/rules/lone-anonymous-operation.md

@@ -1,20 +0,0 @@
-# `lone-anonymous-operation`
-
-✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file
-enables this rule.
-
-- Category: `Operations`
-- Rule name: `@graphql-eslint/lone-anonymous-operation`
-- 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 that contains an anonymous operation (the `query` short-hand) is only valid if it
-contains only that one operation definition.
-
-> 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/LoneAnonymousOperationRule.ts)
-- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/LoneAnonymousOperationRule-test.ts)

package/docs/rules/lone-executable-definition.md

@@ -1,59 +0,0 @@
-# `lone-executable-definition`
-
-- Category: `Operations`
-- Rule name: `@graphql-eslint/lone-executable-definition`
-- 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 queries, mutations, subscriptions or fragments to be located in separate files.
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/lone-executable-definition: 'error'
-
-query Foo {
-  id
-}
-fragment Bar on Baz {
-  id
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/lone-executable-definition: 'error'
-
-query Foo {
-  id
-}
-```
-
-## Config Schema
-
-The schema defines the following properties:
-
-### `ignore` (array)
-
-Allow certain definitions to be placed alongside others.
-
-The elements of the array can contain the following enum values:
-
-- `fragment`
-- `query`
-- `mutation`
-- `subscription`
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/lone-executable-definition.ts)
-- [Test source](../../packages/plugin/tests/lone-executable-definition.spec.ts)

package/docs/rules/lone-schema-definition.md

@@ -1,19 +0,0 @@
-# `lone-schema-definition`
-
-✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file
-enables this rule.
-
-- Category: `Schema`
-- Rule name: `@graphql-eslint/lone-schema-definition`
-- Requires GraphQL Schema: `false` [ℹ️](../../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 it contains only one schema definition.
-
-> 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/LoneSchemaDefinitionRule.ts)
-- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/LoneSchemaDefinitionRule-test.ts)