@graphql-eslint/eslint-plugin 3.14.0-alpha-20221221133443-5be7fc6 → 3.14.0-alpha-20221222012949-5caade4

package/docs/rules/description-style.md

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,59 @@
+# `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 all queries, mutations, subscriptions and 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

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

package/docs/rules/match-document-filename.md

@@ -0,0 +1,181 @@
+# `match-document-filename`
+
+- Category: `Operations`
+- Rule name: `@graphql-eslint/match-document-filename`
+- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false`
+  [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+This rule allows you to enforce that the file name should match the operation name.
+
+## Usage Examples
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { fileExtension: '.gql' }]
+
+# user.gql
+type User {
+  id: ID!
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { query: 'snake_case' }]
+
+# user_by_id.gql
+query UserById {
+  userById(id: 5) {
+    id
+    name
+    fullName
+  }
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { fragment: { style: 'kebab-case', suffix: '.fragment' } }]
+
+# user-fields.fragment.gql
+fragment user_fields on User {
+  id
+  email
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { mutation: { style: 'PascalCase', suffix: 'Mutation' } }]
+
+# DeleteUserMutation.gql
+mutation DELETE_USER {
+  deleteUser(id: 5)
+}
+```
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { fileExtension: '.graphql' }]
+
+# post.gql
+type Post {
+  id: ID!
+}
+```
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { query: 'PascalCase' }]
+
+# user-by-id.gql
+query UserById {
+  userById(id: 5) {
+    id
+    name
+    fullName
+  }
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { fragment: { style: 'kebab-case', prefix: 'mutation.' } }]
+
+# mutation.add-alert.graphql
+mutation addAlert {
+  foo
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { fragment: { prefix: 'query.' } }]
+
+# query.me.graphql
+query me {
+  foo
+}
+```
+
+## Config Schema
+
+The schema defines the following properties:
+
+### `fileExtension` (enum)
+
+This element must be one of the following enum values:
+
+- `.gql`
+- `.graphql`
+
+### `query`
+
+The object must be one of the following types:
+
+- `asString`
+- `asObject`
+
+### `mutation`
+
+The object must be one of the following types:
+
+- `asString`
+- `asObject`
+
+### `subscription`
+
+The object must be one of the following types:
+
+- `asString`
+- `asObject`
+
+### `fragment`
+
+The object must be one of the following types:
+
+- `asString`
+- `asObject`
+
+---
+
+# Sub Schemas
+
+The schema defines the following additional types:
+
+## `asString` (enum)
+
+One of: `camelCase`, `PascalCase`, `snake_case`, `UPPER_CASE`, `kebab-case`, `matchDocumentStyle`
+
+## `asObject` (object)
+
+Properties of the `asObject` object:
+
+### `style` (enum)
+
+This element must be one of the following enum values:
+
+- `camelCase`
+- `PascalCase`
+- `snake_case`
+- `UPPER_CASE`
+- `kebab-case`
+- `matchDocumentStyle`
+
+### `suffix` (string)
+
+### `prefix` (string)
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/match-document-filename.ts)
+- [Test source](../../packages/plugin/tests/match-document-filename.spec.ts)